AppMesh / Client / describe_virtual_router

describe_virtual_router#

AppMesh.Client.describe_virtual_router(**kwargs)#

Describes an existing virtual router.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_router(
    meshName='string',
    meshOwner='string',
    virtualRouterName='string'
)
Parameters:

  • meshName (string) –

    [REQUIRED]

    The name of the service mesh that the virtual router 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.

  • virtualRouterName (string) –

    [REQUIRED]

    The name of the virtual router to describe.

Return type:

dict

Returns:

Response Syntax

{
    'virtualRouter': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'listeners': [
                {
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'|'http2'|'grpc'
                    }
                },
            ]
        },
        'status': {
            'status': 'ACTIVE'|'INACTIVE'|'DELETED'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

  • (dict) –

    • virtualRouter (dict) –

      The full description of your virtual router.

      • meshName (string) –

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

      • metadata (dict) –

        The associated metadata for the virtual router.

        • 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 router.

        • listeners (list) –

          The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

          • (dict) –

            An object that represents a virtual router listener.

            • portMapping (dict) –

              An object that represents a port mapping.

              • port (integer) –

                The port used for the port mapping.

              • protocol (string) –

                The protocol used for the port mapping. Specify one protocol.

      • status (dict) –

        The current status of the virtual router.

        • status (string) –

          The current status of the virtual router.

      • virtualRouterName (string) –

        The name of the virtual router.

Exceptions