AppMesh / Client / describe_virtual_service

describe_virtual_service#

AppMesh.Client.describe_virtual_service(**kwargs)#

Describes an existing virtual service.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_service(
    meshName='string',
    meshOwner='string',
    virtualServiceName='string'
)
Parameters:

  • meshName (string) –

    [REQUIRED]

    The name of the service mesh that the virtual service resides in.

  • meshOwner (string) – The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

  • virtualServiceName (string) –

    [REQUIRED]

    The name of the virtual service to describe.

Return type:

dict

Returns:

Response Syntax

{
    'virtualService': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'provider': {
                'virtualNode': {
                    'virtualNodeName': 'string'
                },
                'virtualRouter': {
                    'virtualRouterName': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'INACTIVE'|'DELETED'
        },
        'virtualServiceName': 'string'
    }
}

Response Structure

  • (dict) –

    • virtualService (dict) –

      The full description of your virtual service.

      • meshName (string) –

        The name of the service mesh that the virtual service resides in.

      • metadata (dict) –

        An object that represents metadata for a resource.

        • arn (string) –

          The full Amazon Resource Name (ARN) for the resource.

        • createdAt (datetime) –

          The Unix epoch timestamp in seconds for when the resource was created.

        • lastUpdatedAt (datetime) –

          The Unix epoch timestamp in seconds for when the resource was last updated.

        • meshOwner (string) –

          The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

        • resourceOwner (string) –

          The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

        • uid (string) –

          The unique identifier for the resource.

        • version (integer) –

          The version of the resource. Resources are created at version 1, and this version is incremented each time that they’re updated.

      • spec (dict) –

        The specifications of the virtual service.

        • provider (dict) –

          The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: virtualNode, virtualRouter. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • virtualNode (dict) –

            The virtual node associated with a virtual service.

            • virtualNodeName (string) –

              The name of the virtual node that is acting as a service provider.

          • virtualRouter (dict) –

            The virtual router associated with a virtual service.

            • virtualRouterName (string) –

              The name of the virtual router that is acting as a service provider.

      • status (dict) –

        The current status of the virtual service.

        • status (string) –

          The current status of the virtual service.

      • virtualServiceName (string) –

        The name of the virtual service.

Exceptions