AppMesh

Table of Contents

Client

class AppMesh.Client

A low-level client representing AWS App Mesh:

import boto3

client = boto3.client('appmesh')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_mesh(**kwargs)

Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

See also: AWS API Documentation

Request Syntax

response = client.create_mesh(
    clientToken='string',
    meshName='string',
    spec={
        'egressFilter': {
            'type': 'ALLOW_ALL'|'DROP_ALL'
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name to use for the service mesh.

  • spec (dict) --

    The service mesh specification to apply.

    • egressFilter (dict) --

      The egress filter rules for the service mesh.

      • type (string) -- [REQUIRED]

        The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

  • tags (list) --

    Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type

dict

Returns

Response Syntax

{
    'mesh': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'egressFilter': {
                'type': 'ALLOW_ALL'|'DROP_ALL'
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        }
    }
}

Response Structure

  • (dict) --

    • mesh (dict) --

      The full description of your service mesh following the create call.

      • meshName (string) --

        The name of the service mesh.

      • metadata (dict) --

        The associated metadata for the service mesh.

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

        • 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 associated specification for the service mesh.

        • egressFilter (dict) --

          The egress filter rules for the service mesh.

          • type (string) --

            The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

      • status (dict) --

        The status of the service mesh.

        • status (string) --

          The current mesh status.

create_route(**kwargs)

Creates a route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

See also: AWS API Documentation

Request Syntax

response = client.create_route(
    clientToken='string',
    meshName='string',
    routeName='string',
    spec={
        'httpRoute': {
            'action': {
                'weightedTargets': [
                    {
                        'virtualNode': 'string',
                        'weight': 123
                    },
                ]
            },
            'match': {
                'prefix': 'string'
            }
        },
        'tcpRoute': {
            'action': {
                'weightedTargets': [
                    {
                        'virtualNode': 'string',
                        'weight': 123
                    },
                ]
            }
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    virtualRouterName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to create the route in.

  • routeName (string) --

    [REQUIRED]

    The name to use for the route.

  • spec (dict) --

    [REQUIRED]

    The route specification to apply.

    • httpRoute (dict) --

      The HTTP routing information for the route.

      • action (dict) -- [REQUIRED]

        The action to take if a match is determined.

        • weightedTargets (list) -- [REQUIRED]

          The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

          • (dict) --

            An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

            • virtualNode (string) -- [REQUIRED]

              The virtual node to associate with the weighted target.

            • weight (integer) -- [REQUIRED]

              The relative weight of the weighted target.

      • match (dict) -- [REQUIRED]

        The criteria for determining an HTTP request match.

        • prefix (string) -- [REQUIRED]

          Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

    • tcpRoute (dict) --

      The TCP routing information for the route.

      • action (dict) -- [REQUIRED]

        The action to take if a match is determined.

        • weightedTargets (list) -- [REQUIRED]

          The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

          • (dict) --

            An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

            • virtualNode (string) -- [REQUIRED]

              The virtual node to associate with the weighted target.

            • weight (integer) -- [REQUIRED]

              The relative weight of the weighted target.

  • tags (list) --

    Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router in which to create the route.

Return type

dict

Returns

Response Syntax

{
    'route': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'routeName': 'string',
        'spec': {
            'httpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                },
                'match': {
                    'prefix': 'string'
                }
            },
            'tcpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

  • (dict) --

    • route (dict) --

      The full description of your mesh following the create call.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the route.

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

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

      • routeName (string) --

        The name of the route.

      • spec (dict) --

        The specifications of the route.

        • httpRoute (dict) --

          The HTTP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

          • match (dict) --

            The criteria for determining an HTTP request match.

            • prefix (string) --

              Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

        • tcpRoute (dict) --

          The TCP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

      • status (dict) --

        The status of the route.

        • status (string) --

          The current status for the route.

      • virtualRouterName (string) --

        The virtual router that the route is associated with.

create_virtual_node(**kwargs)

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group.

Any inbound traffic that your virtual node expects should be specified as a listener . Any outbound traffic that your virtual node expects to reach should be specified as a backend .

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp ) as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

Note

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

See also: AWS API Documentation

Request Syntax

response = client.create_virtual_node(
    clientToken='string',
    meshName='string',
    spec={
        'backends': [
            {
                'virtualService': {
                    'virtualServiceName': 'string'
                }
            },
        ],
        'listeners': [
            {
                'healthCheck': {
                    'healthyThreshold': 123,
                    'intervalMillis': 123,
                    'path': 'string',
                    'port': 123,
                    'protocol': 'http'|'tcp',
                    'timeoutMillis': 123,
                    'unhealthyThreshold': 123
                },
                'portMapping': {
                    'port': 123,
                    'protocol': 'http'|'tcp'
                }
            },
        ],
        'logging': {
            'accessLog': {
                'file': {
                    'path': 'string'
                }
            }
        },
        'serviceDiscovery': {
            'awsCloudMap': {
                'attributes': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'namespaceName': 'string',
                'serviceName': 'string'
            },
            'dns': {
                'hostname': 'string'
            }
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    virtualNodeName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to create the virtual node in.

  • spec (dict) --

    [REQUIRED]

    The virtual node specification to apply.

    • backends (list) --

      The backends that the virtual node is expected to send outbound traffic to.

      • (dict) --

        An object representing the backends that a virtual node is expected to send outbound traffic to.

        • virtualService (dict) --

          Specifies a virtual service to use as a backend for a virtual node.

          • virtualServiceName (string) -- [REQUIRED]

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

    • listeners (list) --

      The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

      • (dict) --

        An object representing a listener for a virtual node.

        • healthCheck (dict) --

          The health check information for the listener.

          • healthyThreshold (integer) -- [REQUIRED]

            The number of consecutive successful health checks that must occur before declaring listener healthy.

          • intervalMillis (integer) -- [REQUIRED]

            The time period in milliseconds between each health check execution.

          • path (string) --

            The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

          • port (integer) --

            The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

          • protocol (string) -- [REQUIRED]

            The protocol for the health check request.

          • timeoutMillis (integer) -- [REQUIRED]

            The amount of time to wait when receiving a response from the health check, in milliseconds.

          • unhealthyThreshold (integer) -- [REQUIRED]

            The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

        • portMapping (dict) -- [REQUIRED]

          The port mapping information for the listener.

          • port (integer) -- [REQUIRED]

            The port used for the port mapping.

          • protocol (string) -- [REQUIRED]

            The protocol used for the port mapping.

    • logging (dict) --

      The inbound and outbound access logging information for the virtual node.

      • accessLog (dict) --

        The access log configuration for a virtual node.

        • file (dict) --

          The file object to send virtual node access logs to.

          • path (string) -- [REQUIRED]

            The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

            Note

            The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

    • serviceDiscovery (dict) --

      The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

      • awsCloudMap (dict) --

        Specifies any AWS Cloud Map information for the virtual node.

        • attributes (list) --

          A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

          • (dict) --

            An object representing the AWS Cloud Map attribute information for your virtual node.

            • key (string) -- [REQUIRED]

              The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • value (string) -- [REQUIRED]

              The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

        • namespaceName (string) -- [REQUIRED]

          The name of the AWS Cloud Map namespace to use.

        • serviceName (string) -- [REQUIRED]

          The name of the AWS Cloud Map service to use.

      • dns (dict) --

        Specifies the DNS information for the virtual node.

        • hostname (string) -- [REQUIRED]

          Specifies the DNS service discovery hostname for the virtual node.

  • tags (list) --

    Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • virtualNodeName (string) --

    [REQUIRED]

    The name to use for the virtual node.

Return type

dict

Returns

Response Syntax

{
    'virtualNode': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'backends': [
                {
                    'virtualService': {
                        'virtualServiceName': 'string'
                    }
                },
            ],
            'listeners': [
                {
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'intervalMillis': 123,
                        'path': 'string',
                        'port': 123,
                        'protocol': 'http'|'tcp',
                        'timeoutMillis': 123,
                        'unhealthyThreshold': 123
                    },
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'
                    }
                },
            ],
            'logging': {
                'accessLog': {
                    'file': {
                        'path': 'string'
                    }
                }
            },
            'serviceDiscovery': {
                'awsCloudMap': {
                    'attributes': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'namespaceName': 'string',
                    'serviceName': 'string'
                },
                'dns': {
                    'hostname': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualNodeName': 'string'
    }
}

Response Structure

  • (dict) --

    • virtualNode (dict) --

      The full description of your virtual node following the create call.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the virtual node.

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

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

        • backends (list) --

          The backends that the virtual node is expected to send outbound traffic to.

          • (dict) --

            An object representing the backends that a virtual node is expected to send outbound traffic to.

            • virtualService (dict) --

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceName (string) --

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

        • listeners (list) --

          The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

          • (dict) --

            An object representing a listener for a virtual node.

            • healthCheck (dict) --

              The health check information for the listener.

              • healthyThreshold (integer) --

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillis (integer) --

                The time period in milliseconds between each health check execution.

              • path (string) --

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

              • port (integer) --

                The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

              • protocol (string) --

                The protocol for the health check request.

              • timeoutMillis (integer) --

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThreshold (integer) --

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMapping (dict) --

              The port mapping information for the listener.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

        • logging (dict) --

          The inbound and outbound access logging information for the virtual node.

          • accessLog (dict) --

            The access log configuration for a virtual node.

            • file (dict) --

              The file object to send virtual node access logs to.

              • path (string) --

                The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

                Note

                The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

        • serviceDiscovery (dict) --

          The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

          • awsCloudMap (dict) --

            Specifies any AWS Cloud Map information for the virtual node.

            • attributes (list) --

              A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

              • (dict) --

                An object representing the AWS Cloud Map attribute information for your virtual node.

                • key (string) --

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • value (string) --

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • namespaceName (string) --

              The name of the AWS Cloud Map namespace to use.

            • serviceName (string) --

              The name of the AWS Cloud Map service to use.

          • dns (dict) --

            Specifies the DNS information for the virtual node.

            • hostname (string) --

              Specifies the DNS service discovery hostname for the virtual node.

      • status (dict) --

        The current status for the virtual node.

        • status (string) --

          The current status of the virtual node.

      • virtualNodeName (string) --

        The name of the virtual node.

create_virtual_router(**kwargs)

Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener .

Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

See also: AWS API Documentation

Request Syntax

response = client.create_virtual_router(
    clientToken='string',
    meshName='string',
    spec={
        'listeners': [
            {
                'portMapping': {
                    'port': 123,
                    'protocol': 'http'|'tcp'
                }
            },
        ]
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    virtualRouterName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to create the virtual router in.

  • spec (dict) --

    [REQUIRED]

    The virtual router specification to apply.

    • listeners (list) --

      The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.

      • (dict) --

        An object representing a virtual router listener.

        • portMapping (dict) -- [REQUIRED]

          An object representing a virtual node or virtual router listener port mapping.

          • port (integer) -- [REQUIRED]

            The port used for the port mapping.

          • protocol (string) -- [REQUIRED]

            The protocol used for the port mapping.

  • tags (list) --

    Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • virtualRouterName (string) --

    [REQUIRED]

    The name to use for the virtual router.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualRouter (dict) --

      The full description of your virtual router following the create call.

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

        • 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. Currently only one listener is supported per virtual router.

          • (dict) --

            An object representing a virtual router listener.

            • portMapping (dict) --

              An object representing a virtual node or virtual router listener port mapping.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

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

create_virtual_service(**kwargs)

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName , and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

See also: AWS API Documentation

Request Syntax

response = client.create_virtual_service(
    clientToken='string',
    meshName='string',
    spec={
        'provider': {
            'virtualNode': {
                'virtualNodeName': 'string'
            },
            'virtualRouter': {
                'virtualRouterName': 'string'
            }
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    virtualServiceName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to create the virtual service in.

  • spec (dict) --

    [REQUIRED]

    The virtual service specification to apply.

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

      • virtualNode (dict) --

        The virtual node associated with a virtual service.

        • virtualNodeName (string) -- [REQUIRED]

          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) -- [REQUIRED]

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

  • tags (list) --

    Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

  • virtualServiceName (string) --

    [REQUIRED]

    The name to use for the virtual service.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualService (dict) --

      The full description of your virtual service following the create call.

      • meshName (string) --

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

      • metadata (dict) --

        An object representing 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.

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

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

delete_mesh(**kwargs)

Deletes an existing service mesh.

You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.

See also: AWS API Documentation

Request Syntax

response = client.delete_mesh(
    meshName='string'
)
Parameters
meshName (string) --

[REQUIRED]

The name of the service mesh to delete.

Return type
dict
Returns
Response Syntax
{
    'mesh': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'egressFilter': {
                'type': 'ALLOW_ALL'|'DROP_ALL'
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        }
    }
}

Response Structure

  • (dict) --
    • mesh (dict) --

      The service mesh that was deleted.

      • meshName (string) --

        The name of the service mesh.

      • metadata (dict) --

        The associated metadata for the service mesh.

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

        • 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 associated specification for the service mesh.

        • egressFilter (dict) --

          The egress filter rules for the service mesh.

          • type (string) --

            The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

      • status (dict) --

        The status of the service mesh.

        • status (string) --

          The current mesh status.

delete_route(**kwargs)

Deletes an existing route.

See also: AWS API Documentation

Request Syntax

response = client.delete_route(
    meshName='string',
    routeName='string',
    virtualRouterName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to delete the route in.

  • routeName (string) --

    [REQUIRED]

    The name of the route to delete.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router to delete the route in.

Return type

dict

Returns

Response Syntax

{
    'route': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'routeName': 'string',
        'spec': {
            'httpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                },
                'match': {
                    'prefix': 'string'
                }
            },
            'tcpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

  • (dict) --

    • route (dict) --

      The route that was deleted.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the route.

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

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

      • routeName (string) --

        The name of the route.

      • spec (dict) --

        The specifications of the route.

        • httpRoute (dict) --

          The HTTP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

          • match (dict) --

            The criteria for determining an HTTP request match.

            • prefix (string) --

              Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

        • tcpRoute (dict) --

          The TCP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

      • status (dict) --

        The status of the route.

        • status (string) --

          The current status for the route.

      • virtualRouterName (string) --

        The virtual router that the route is associated with.

delete_virtual_node(**kwargs)

Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.

See also: AWS API Documentation

Request Syntax

response = client.delete_virtual_node(
    meshName='string',
    virtualNodeName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to delete the virtual node in.

  • virtualNodeName (string) --

    [REQUIRED]

    The name of the virtual node to delete.

Return type

dict

Returns

Response Syntax

{
    'virtualNode': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'backends': [
                {
                    'virtualService': {
                        'virtualServiceName': 'string'
                    }
                },
            ],
            'listeners': [
                {
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'intervalMillis': 123,
                        'path': 'string',
                        'port': 123,
                        'protocol': 'http'|'tcp',
                        'timeoutMillis': 123,
                        'unhealthyThreshold': 123
                    },
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'
                    }
                },
            ],
            'logging': {
                'accessLog': {
                    'file': {
                        'path': 'string'
                    }
                }
            },
            'serviceDiscovery': {
                'awsCloudMap': {
                    'attributes': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'namespaceName': 'string',
                    'serviceName': 'string'
                },
                'dns': {
                    'hostname': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualNodeName': 'string'
    }
}

Response Structure

  • (dict) --

    • virtualNode (dict) --

      The virtual node that was deleted.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the virtual node.

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

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

        • backends (list) --

          The backends that the virtual node is expected to send outbound traffic to.

          • (dict) --

            An object representing the backends that a virtual node is expected to send outbound traffic to.

            • virtualService (dict) --

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceName (string) --

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

        • listeners (list) --

          The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

          • (dict) --

            An object representing a listener for a virtual node.

            • healthCheck (dict) --

              The health check information for the listener.

              • healthyThreshold (integer) --

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillis (integer) --

                The time period in milliseconds between each health check execution.

              • path (string) --

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

              • port (integer) --

                The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

              • protocol (string) --

                The protocol for the health check request.

              • timeoutMillis (integer) --

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThreshold (integer) --

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMapping (dict) --

              The port mapping information for the listener.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

        • logging (dict) --

          The inbound and outbound access logging information for the virtual node.

          • accessLog (dict) --

            The access log configuration for a virtual node.

            • file (dict) --

              The file object to send virtual node access logs to.

              • path (string) --

                The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

                Note

                The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

        • serviceDiscovery (dict) --

          The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

          • awsCloudMap (dict) --

            Specifies any AWS Cloud Map information for the virtual node.

            • attributes (list) --

              A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

              • (dict) --

                An object representing the AWS Cloud Map attribute information for your virtual node.

                • key (string) --

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • value (string) --

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • namespaceName (string) --

              The name of the AWS Cloud Map namespace to use.

            • serviceName (string) --

              The name of the AWS Cloud Map service to use.

          • dns (dict) --

            Specifies the DNS information for the virtual node.

            • hostname (string) --

              Specifies the DNS service discovery hostname for the virtual node.

      • status (dict) --

        The current status for the virtual node.

        • status (string) --

          The current status of the virtual node.

      • virtualNodeName (string) --

        The name of the virtual node.

delete_virtual_router(**kwargs)

Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

See also: AWS API Documentation

Request Syntax

response = client.delete_virtual_router(
    meshName='string',
    virtualRouterName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to delete the virtual router in.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router to delete.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualRouter (dict) --

      The virtual router that was deleted.

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

        • 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. Currently only one listener is supported per virtual router.

          • (dict) --

            An object representing a virtual router listener.

            • portMapping (dict) --

              An object representing a virtual node or virtual router listener port mapping.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

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

delete_virtual_service(**kwargs)

Deletes an existing virtual service.

See also: AWS API Documentation

Request Syntax

response = client.delete_virtual_service(
    meshName='string',
    virtualServiceName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to delete the virtual service in.

  • virtualServiceName (string) --

    [REQUIRED]

    The name of the virtual service to delete.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualService (dict) --

      The virtual service that was deleted.

      • meshName (string) --

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

      • metadata (dict) --

        An object representing 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.

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

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

describe_mesh(**kwargs)

Describes an existing service mesh.

See also: AWS API Documentation

Request Syntax

response = client.describe_mesh(
    meshName='string'
)
Parameters
meshName (string) --

[REQUIRED]

The name of the service mesh to describe.

Return type
dict
Returns
Response Syntax
{
    'mesh': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'egressFilter': {
                'type': 'ALLOW_ALL'|'DROP_ALL'
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        }
    }
}

Response Structure

  • (dict) --
    • mesh (dict) --

      The full description of your service mesh.

      • meshName (string) --

        The name of the service mesh.

      • metadata (dict) --

        The associated metadata for the service mesh.

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

        • 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 associated specification for the service mesh.

        • egressFilter (dict) --

          The egress filter rules for the service mesh.

          • type (string) --

            The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

      • status (dict) --

        The status of the service mesh.

        • status (string) --

          The current mesh status.

describe_route(**kwargs)

Describes an existing route.

See also: AWS API Documentation

Request Syntax

response = client.describe_route(
    meshName='string',
    routeName='string',
    virtualRouterName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

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

  • routeName (string) --

    [REQUIRED]

    The name of the route to describe.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router that the route is associated with.

Return type

dict

Returns

Response Syntax

{
    'route': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'routeName': 'string',
        'spec': {
            'httpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                },
                'match': {
                    'prefix': 'string'
                }
            },
            'tcpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

  • (dict) --

    • route (dict) --

      The full description of your route.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the route.

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

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

      • routeName (string) --

        The name of the route.

      • spec (dict) --

        The specifications of the route.

        • httpRoute (dict) --

          The HTTP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

          • match (dict) --

            The criteria for determining an HTTP request match.

            • prefix (string) --

              Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

        • tcpRoute (dict) --

          The TCP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

      • status (dict) --

        The status of the route.

        • status (string) --

          The current status for the route.

      • virtualRouterName (string) --

        The virtual router that the route is associated with.

describe_virtual_node(**kwargs)

Describes an existing virtual node.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_node(
    meshName='string',
    virtualNodeName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

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

  • virtualNodeName (string) --

    [REQUIRED]

    The name of the virtual node to describe.

Return type

dict

Returns

Response Syntax

{
    'virtualNode': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'backends': [
                {
                    'virtualService': {
                        'virtualServiceName': 'string'
                    }
                },
            ],
            'listeners': [
                {
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'intervalMillis': 123,
                        'path': 'string',
                        'port': 123,
                        'protocol': 'http'|'tcp',
                        'timeoutMillis': 123,
                        'unhealthyThreshold': 123
                    },
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'
                    }
                },
            ],
            'logging': {
                'accessLog': {
                    'file': {
                        'path': 'string'
                    }
                }
            },
            'serviceDiscovery': {
                'awsCloudMap': {
                    'attributes': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'namespaceName': 'string',
                    'serviceName': 'string'
                },
                'dns': {
                    'hostname': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualNodeName': 'string'
    }
}

Response Structure

  • (dict) --

    • virtualNode (dict) --

      The full description of your virtual node.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the virtual node.

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

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

        • backends (list) --

          The backends that the virtual node is expected to send outbound traffic to.

          • (dict) --

            An object representing the backends that a virtual node is expected to send outbound traffic to.

            • virtualService (dict) --

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceName (string) --

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

        • listeners (list) --

          The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

          • (dict) --

            An object representing a listener for a virtual node.

            • healthCheck (dict) --

              The health check information for the listener.

              • healthyThreshold (integer) --

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillis (integer) --

                The time period in milliseconds between each health check execution.

              • path (string) --

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

              • port (integer) --

                The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

              • protocol (string) --

                The protocol for the health check request.

              • timeoutMillis (integer) --

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThreshold (integer) --

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMapping (dict) --

              The port mapping information for the listener.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

        • logging (dict) --

          The inbound and outbound access logging information for the virtual node.

          • accessLog (dict) --

            The access log configuration for a virtual node.

            • file (dict) --

              The file object to send virtual node access logs to.

              • path (string) --

                The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

                Note

                The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

        • serviceDiscovery (dict) --

          The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

          • awsCloudMap (dict) --

            Specifies any AWS Cloud Map information for the virtual node.

            • attributes (list) --

              A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

              • (dict) --

                An object representing the AWS Cloud Map attribute information for your virtual node.

                • key (string) --

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • value (string) --

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • namespaceName (string) --

              The name of the AWS Cloud Map namespace to use.

            • serviceName (string) --

              The name of the AWS Cloud Map service to use.

          • dns (dict) --

            Specifies the DNS information for the virtual node.

            • hostname (string) --

              Specifies the DNS service discovery hostname for the virtual node.

      • status (dict) --

        The current status for the virtual node.

        • status (string) --

          The current status of the virtual node.

      • virtualNodeName (string) --

        The name of the virtual node.

describe_virtual_router(**kwargs)

Describes an existing virtual router.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_router(
    meshName='string',
    virtualRouterName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

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

  • 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),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'listeners': [
                {
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'
                    }
                },
            ]
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        '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.

        • 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. Currently only one listener is supported per virtual router.

          • (dict) --

            An object representing a virtual router listener.

            • portMapping (dict) --

              An object representing a virtual node or virtual router listener port mapping.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

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

describe_virtual_service(**kwargs)

Describes an existing virtual service.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_service(
    meshName='string',
    virtualServiceName='string'
)
Parameters
  • meshName (string) --

    [REQUIRED]

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

  • 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),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'provider': {
                'virtualNode': {
                    'virtualNodeName': 'string'
                },
                'virtualRouter': {
                    'virtualRouterName': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        '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 representing 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.

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

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_meshes(**kwargs)

Returns a list of existing service meshes.

See also: AWS API Documentation

Request Syntax

response = client.list_meshes(
    limit=123,
    nextToken='string'
)
Parameters
  • limit (integer) -- The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.
  • nextToken (string) --

    The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    Note

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Return type

dict

Returns

Response Syntax

{
    'meshes': [
        {
            'arn': 'string',
            'meshName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • meshes (list) --

      The list of existing service meshes.

      • (dict) --

        An object representing a service mesh returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) of the service mesh.

        • meshName (string) --

          The name of the service mesh.

    • nextToken (string) --

      The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

list_routes(**kwargs)

Returns a list of existing routes in a service mesh.

See also: AWS API Documentation

Request Syntax

response = client.list_routes(
    limit=123,
    meshName='string',
    nextToken='string',
    virtualRouterName='string'
)
Parameters
  • limit (integer) -- The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list routes in.

  • nextToken (string) -- The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router to list routes in.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'routes': [
        {
            'arn': 'string',
            'meshName': 'string',
            'routeName': 'string',
            'virtualRouterName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    • routes (list) --

      The list of existing routes for the specified service mesh and virtual router.

      • (dict) --

        An object representing a route returned by a list operation.

        • arn (string) --

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

        • meshName (string) --

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

        • routeName (string) --

          The name of the route.

        • virtualRouterName (string) --

          The virtual router that the route is associated with.

list_tags_for_resource(**kwargs)

List the tags for an App Mesh resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    limit=123,
    nextToken='string',
    resourceArn='string'
)
Parameters
  • limit (integer) -- The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.
  • nextToken (string) -- The nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    • tags (list) --

      The tags for the resource.

      • (dict) --

        Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        • key (string) --

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value (string) --

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

list_virtual_nodes(**kwargs)

Returns a list of existing virtual nodes.

See also: AWS API Documentation

Request Syntax

response = client.list_virtual_nodes(
    limit=123,
    meshName='string',
    nextToken='string'
)
Parameters
  • limit (integer) -- The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual nodes in.

  • nextToken (string) -- The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'virtualNodes': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualNodeName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    • virtualNodes (list) --

      The list of existing virtual nodes for the specified service mesh.

      • (dict) --

        An object representing a virtual node returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual node.

        • meshName (string) --

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

        • virtualNodeName (string) --

          The name of the virtual node.

list_virtual_routers(**kwargs)

Returns a list of existing virtual routers in a service mesh.

See also: AWS API Documentation

Request Syntax

response = client.list_virtual_routers(
    limit=123,
    meshName='string',
    nextToken='string'
)
Parameters
  • limit (integer) -- The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual routers in.

  • nextToken (string) -- The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'virtualRouters': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualRouterName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    • virtualRouters (list) --

      The list of existing virtual routers for the specified service mesh.

      • (dict) --

        An object representing a virtual router returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual router.

        • meshName (string) --

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

        • virtualRouterName (string) --

          The name of the virtual router.

list_virtual_services(**kwargs)

Returns a list of existing virtual services in a service mesh.

See also: AWS API Documentation

Request Syntax

response = client.list_virtual_services(
    limit=123,
    meshName='string',
    nextToken='string'
)
Parameters
  • limit (integer) -- The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual services in.

  • nextToken (string) -- The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'virtualServices': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualServiceName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit , you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    • virtualServices (list) --

      The list of existing virtual services for the specified service mesh.

      • (dict) --

        An object representing a virtual service returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual service.

        • meshName (string) --

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

        • virtualServiceName (string) --

          The name of the virtual service.

tag_resource(**kwargs)

Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to add tags to.

  • tags (list) --

    [REQUIRED]

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) --

      Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • key (string) -- [REQUIRED]

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • value (string) --

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

Deletes specified tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to delete tags from.

  • tagKeys (list) --

    [REQUIRED]

    The keys of the tags to be removed.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_mesh(**kwargs)

Updates an existing service mesh.

See also: AWS API Documentation

Request Syntax

response = client.update_mesh(
    clientToken='string',
    meshName='string',
    spec={
        'egressFilter': {
            'type': 'ALLOW_ALL'|'DROP_ALL'
        }
    }
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to update.

  • spec (dict) --

    The service mesh specification to apply.

    • egressFilter (dict) --

      The egress filter rules for the service mesh.

      • type (string) -- [REQUIRED]

        The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

Return type

dict

Returns

Response Syntax

{
    'mesh': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'egressFilter': {
                'type': 'ALLOW_ALL'|'DROP_ALL'
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        }
    }
}

Response Structure

  • (dict) --

    • mesh (dict) --

      An object representing a service mesh returned by a describe operation.

      • meshName (string) --

        The name of the service mesh.

      • metadata (dict) --

        The associated metadata for the service mesh.

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

        • 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 associated specification for the service mesh.

        • egressFilter (dict) --

          The egress filter rules for the service mesh.

          • type (string) --

            The egress filter type. By default, the type is DROP_ALL , which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

      • status (dict) --

        The status of the service mesh.

        • status (string) --

          The current mesh status.

update_route(**kwargs)

Updates an existing route for a specified service mesh and virtual router.

See also: AWS API Documentation

Request Syntax

response = client.update_route(
    clientToken='string',
    meshName='string',
    routeName='string',
    spec={
        'httpRoute': {
            'action': {
                'weightedTargets': [
                    {
                        'virtualNode': 'string',
                        'weight': 123
                    },
                ]
            },
            'match': {
                'prefix': 'string'
            }
        },
        'tcpRoute': {
            'action': {
                'weightedTargets': [
                    {
                        'virtualNode': 'string',
                        'weight': 123
                    },
                ]
            }
        }
    },
    virtualRouterName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

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

  • routeName (string) --

    [REQUIRED]

    The name of the route to update.

  • spec (dict) --

    [REQUIRED]

    The new route specification to apply. This overwrites the existing data.

    • httpRoute (dict) --

      The HTTP routing information for the route.

      • action (dict) -- [REQUIRED]

        The action to take if a match is determined.

        • weightedTargets (list) -- [REQUIRED]

          The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

          • (dict) --

            An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

            • virtualNode (string) -- [REQUIRED]

              The virtual node to associate with the weighted target.

            • weight (integer) -- [REQUIRED]

              The relative weight of the weighted target.

      • match (dict) -- [REQUIRED]

        The criteria for determining an HTTP request match.

        • prefix (string) -- [REQUIRED]

          Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

    • tcpRoute (dict) --

      The TCP routing information for the route.

      • action (dict) -- [REQUIRED]

        The action to take if a match is determined.

        • weightedTargets (list) -- [REQUIRED]

          The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

          • (dict) --

            An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

            • virtualNode (string) -- [REQUIRED]

              The virtual node to associate with the weighted target.

            • weight (integer) -- [REQUIRED]

              The relative weight of the weighted target.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router that the route is associated with.

Return type

dict

Returns

Response Syntax

{
    'route': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'routeName': 'string',
        'spec': {
            'httpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                },
                'match': {
                    'prefix': 'string'
                }
            },
            'tcpRoute': {
                'action': {
                    'weightedTargets': [
                        {
                            'virtualNode': 'string',
                            'weight': 123
                        },
                    ]
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualRouterName': 'string'
    }
}

Response Structure

  • (dict) --

    • route (dict) --

      A full description of the route that was updated.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the route.

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

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

      • routeName (string) --

        The name of the route.

      • spec (dict) --

        The specifications of the route.

        • httpRoute (dict) --

          The HTTP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

          • match (dict) --

            The criteria for determining an HTTP request match.

            • prefix (string) --

              Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

        • tcpRoute (dict) --

          The TCP routing information for the route.

          • action (dict) --

            The action to take if a match is determined.

            • weightedTargets (list) --

              The targets that traffic is routed to when a request matches the route. You can specify one or more targets and their relative weights to distribute traffic with.

              • (dict) --

                An object representing a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10.

                • virtualNode (string) --

                  The virtual node to associate with the weighted target.

                • weight (integer) --

                  The relative weight of the weighted target.

      • status (dict) --

        The status of the route.

        • status (string) --

          The current status for the route.

      • virtualRouterName (string) --

        The virtual router that the route is associated with.

update_virtual_node(**kwargs)

Updates an existing virtual node in a specified service mesh.

See also: AWS API Documentation

Request Syntax

response = client.update_virtual_node(
    clientToken='string',
    meshName='string',
    spec={
        'backends': [
            {
                'virtualService': {
                    'virtualServiceName': 'string'
                }
            },
        ],
        'listeners': [
            {
                'healthCheck': {
                    'healthyThreshold': 123,
                    'intervalMillis': 123,
                    'path': 'string',
                    'port': 123,
                    'protocol': 'http'|'tcp',
                    'timeoutMillis': 123,
                    'unhealthyThreshold': 123
                },
                'portMapping': {
                    'port': 123,
                    'protocol': 'http'|'tcp'
                }
            },
        ],
        'logging': {
            'accessLog': {
                'file': {
                    'path': 'string'
                }
            }
        },
        'serviceDiscovery': {
            'awsCloudMap': {
                'attributes': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ],
                'namespaceName': 'string',
                'serviceName': 'string'
            },
            'dns': {
                'hostname': 'string'
            }
        }
    },
    virtualNodeName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

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

  • spec (dict) --

    [REQUIRED]

    The new virtual node specification to apply. This overwrites the existing data.

    • backends (list) --

      The backends that the virtual node is expected to send outbound traffic to.

      • (dict) --

        An object representing the backends that a virtual node is expected to send outbound traffic to.

        • virtualService (dict) --

          Specifies a virtual service to use as a backend for a virtual node.

          • virtualServiceName (string) -- [REQUIRED]

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

    • listeners (list) --

      The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

      • (dict) --

        An object representing a listener for a virtual node.

        • healthCheck (dict) --

          The health check information for the listener.

          • healthyThreshold (integer) -- [REQUIRED]

            The number of consecutive successful health checks that must occur before declaring listener healthy.

          • intervalMillis (integer) -- [REQUIRED]

            The time period in milliseconds between each health check execution.

          • path (string) --

            The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

          • port (integer) --

            The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

          • protocol (string) -- [REQUIRED]

            The protocol for the health check request.

          • timeoutMillis (integer) -- [REQUIRED]

            The amount of time to wait when receiving a response from the health check, in milliseconds.

          • unhealthyThreshold (integer) -- [REQUIRED]

            The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

        • portMapping (dict) -- [REQUIRED]

          The port mapping information for the listener.

          • port (integer) -- [REQUIRED]

            The port used for the port mapping.

          • protocol (string) -- [REQUIRED]

            The protocol used for the port mapping.

    • logging (dict) --

      The inbound and outbound access logging information for the virtual node.

      • accessLog (dict) --

        The access log configuration for a virtual node.

        • file (dict) --

          The file object to send virtual node access logs to.

          • path (string) -- [REQUIRED]

            The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

            Note

            The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

    • serviceDiscovery (dict) --

      The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

      • awsCloudMap (dict) --

        Specifies any AWS Cloud Map information for the virtual node.

        • attributes (list) --

          A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

          • (dict) --

            An object representing the AWS Cloud Map attribute information for your virtual node.

            • key (string) -- [REQUIRED]

              The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • value (string) -- [REQUIRED]

              The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

        • namespaceName (string) -- [REQUIRED]

          The name of the AWS Cloud Map namespace to use.

        • serviceName (string) -- [REQUIRED]

          The name of the AWS Cloud Map service to use.

      • dns (dict) --

        Specifies the DNS information for the virtual node.

        • hostname (string) -- [REQUIRED]

          Specifies the DNS service discovery hostname for the virtual node.

  • virtualNodeName (string) --

    [REQUIRED]

    The name of the virtual node to update.

Return type

dict

Returns

Response Syntax

{
    'virtualNode': {
        'meshName': 'string',
        'metadata': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'uid': 'string',
            'version': 123
        },
        'spec': {
            'backends': [
                {
                    'virtualService': {
                        'virtualServiceName': 'string'
                    }
                },
            ],
            'listeners': [
                {
                    'healthCheck': {
                        'healthyThreshold': 123,
                        'intervalMillis': 123,
                        'path': 'string',
                        'port': 123,
                        'protocol': 'http'|'tcp',
                        'timeoutMillis': 123,
                        'unhealthyThreshold': 123
                    },
                    'portMapping': {
                        'port': 123,
                        'protocol': 'http'|'tcp'
                    }
                },
            ],
            'logging': {
                'accessLog': {
                    'file': {
                        'path': 'string'
                    }
                }
            },
            'serviceDiscovery': {
                'awsCloudMap': {
                    'attributes': [
                        {
                            'key': 'string',
                            'value': 'string'
                        },
                    ],
                    'namespaceName': 'string',
                    'serviceName': 'string'
                },
                'dns': {
                    'hostname': 'string'
                }
            }
        },
        'status': {
            'status': 'ACTIVE'|'DELETED'|'INACTIVE'
        },
        'virtualNodeName': 'string'
    }
}

Response Structure

  • (dict) --

    • virtualNode (dict) --

      A full description of the virtual node that was updated.

      • meshName (string) --

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

      • metadata (dict) --

        The associated metadata for the virtual node.

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

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

        • backends (list) --

          The backends that the virtual node is expected to send outbound traffic to.

          • (dict) --

            An object representing the backends that a virtual node is expected to send outbound traffic to.

            • virtualService (dict) --

              Specifies a virtual service to use as a backend for a virtual node.

              • virtualServiceName (string) --

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

        • listeners (list) --

          The listeners that the virtual node is expected to receive inbound traffic from. Currently only one listener is supported per virtual node.

          • (dict) --

            An object representing a listener for a virtual node.

            • healthCheck (dict) --

              The health check information for the listener.

              • healthyThreshold (integer) --

                The number of consecutive successful health checks that must occur before declaring listener healthy.

              • intervalMillis (integer) --

                The time period in milliseconds between each health check execution.

              • path (string) --

                The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

              • port (integer) --

                The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

              • protocol (string) --

                The protocol for the health check request.

              • timeoutMillis (integer) --

                The amount of time to wait when receiving a response from the health check, in milliseconds.

              • unhealthyThreshold (integer) --

                The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

            • portMapping (dict) --

              The port mapping information for the listener.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

        • logging (dict) --

          The inbound and outbound access logging information for the virtual node.

          • accessLog (dict) --

            The access log configuration for a virtual node.

            • file (dict) --

              The file object to send virtual node access logs to.

              • path (string) --

                The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs , to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

                Note

                The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

        • serviceDiscovery (dict) --

          The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.

          • awsCloudMap (dict) --

            Specifies any AWS Cloud Map information for the virtual node.

            • attributes (list) --

              A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

              • (dict) --

                An object representing the AWS Cloud Map attribute information for your virtual node.

                • key (string) --

                  The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

                • value (string) --

                  The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.

            • namespaceName (string) --

              The name of the AWS Cloud Map namespace to use.

            • serviceName (string) --

              The name of the AWS Cloud Map service to use.

          • dns (dict) --

            Specifies the DNS information for the virtual node.

            • hostname (string) --

              Specifies the DNS service discovery hostname for the virtual node.

      • status (dict) --

        The current status for the virtual node.

        • status (string) --

          The current status of the virtual node.

      • virtualNodeName (string) --

        The name of the virtual node.

update_virtual_router(**kwargs)

Updates an existing virtual router in a specified service mesh.

See also: AWS API Documentation

Request Syntax

response = client.update_virtual_router(
    clientToken='string',
    meshName='string',
    spec={
        'listeners': [
            {
                'portMapping': {
                    'port': 123,
                    'protocol': 'http'|'tcp'
                }
            },
        ]
    },
    virtualRouterName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

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

  • spec (dict) --

    [REQUIRED]

    The new virtual router specification to apply. This overwrites the existing data.

    • listeners (list) --

      The listeners that the virtual router is expected to receive inbound traffic from. Currently only one listener is supported per virtual router.

      • (dict) --

        An object representing a virtual router listener.

        • portMapping (dict) -- [REQUIRED]

          An object representing a virtual node or virtual router listener port mapping.

          • port (integer) -- [REQUIRED]

            The port used for the port mapping.

          • protocol (string) -- [REQUIRED]

            The protocol used for the port mapping.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router to update.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualRouter (dict) --

      A full description of the virtual router that was updated.

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

        • 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. Currently only one listener is supported per virtual router.

          • (dict) --

            An object representing a virtual router listener.

            • portMapping (dict) --

              An object representing a virtual node or virtual router listener port mapping.

              • port (integer) --

                The port used for the port mapping.

              • protocol (string) --

                The protocol used for the port mapping.

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

update_virtual_service(**kwargs)

Updates an existing virtual service in a specified service mesh.

See also: AWS API Documentation

Request Syntax

response = client.update_virtual_service(
    clientToken='string',
    meshName='string',
    spec={
        'provider': {
            'virtualNode': {
                'virtualNodeName': 'string'
            },
            'virtualRouter': {
                'virtualRouterName': 'string'
            }
        }
    },
    virtualServiceName='string'
)
Parameters
  • clientToken (string) --

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

    This field is autopopulated if not provided.

  • meshName (string) --

    [REQUIRED]

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

  • spec (dict) --

    [REQUIRED]

    The new virtual service specification to apply. This overwrites the existing data.

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

      • virtualNode (dict) --

        The virtual node associated with a virtual service.

        • virtualNodeName (string) -- [REQUIRED]

          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) -- [REQUIRED]

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

  • virtualServiceName (string) --

    [REQUIRED]

    The name of the virtual service to update.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • virtualService (dict) --

      A full description of the virtual service that was updated.

      • meshName (string) --

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

      • metadata (dict) --

        An object representing 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.

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

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

Paginators

The available paginators are:

class AppMesh.Paginator.ListMeshes
paginator = client.get_paginator('list_meshes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_meshes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'meshes': [
        {
            'arn': 'string',
            'meshName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • meshes (list) --

      The list of existing service meshes.

      • (dict) --

        An object representing a service mesh returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) of the service mesh.

        • meshName (string) --

          The name of the service mesh.

    • NextToken (string) --

      A token to resume pagination.

class AppMesh.Paginator.ListRoutes
paginator = client.get_paginator('list_routes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_routes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    meshName='string',
    virtualRouterName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list routes in.

  • virtualRouterName (string) --

    [REQUIRED]

    The name of the virtual router to list routes in.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'routes': [
        {
            'arn': 'string',
            'meshName': 'string',
            'routeName': 'string',
            'virtualRouterName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • routes (list) --

      The list of existing routes for the specified service mesh and virtual router.

      • (dict) --

        An object representing a route returned by a list operation.

        • arn (string) --

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

        • meshName (string) --

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

        • routeName (string) --

          The name of the route.

        • virtualRouterName (string) --

          The virtual router that the route is associated with.

    • NextToken (string) --

      A token to resume pagination.

class AppMesh.Paginator.ListTagsForResource
paginator = client.get_paginator('list_tags_for_resource')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • tags (list) --

      The tags for the resource.

      • (dict) --

        Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

        • key (string) --

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

        • value (string) --

          The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • NextToken (string) --

      A token to resume pagination.

class AppMesh.Paginator.ListVirtualNodes
paginator = client.get_paginator('list_virtual_nodes')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_nodes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    meshName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual nodes in.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'virtualNodes': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualNodeName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • virtualNodes (list) --

      The list of existing virtual nodes for the specified service mesh.

      • (dict) --

        An object representing a virtual node returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual node.

        • meshName (string) --

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

        • virtualNodeName (string) --

          The name of the virtual node.

    • NextToken (string) --

      A token to resume pagination.

class AppMesh.Paginator.ListVirtualRouters
paginator = client.get_paginator('list_virtual_routers')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_routers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    meshName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual routers in.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'virtualRouters': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualRouterName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • virtualRouters (list) --

      The list of existing virtual routers for the specified service mesh.

      • (dict) --

        An object representing a virtual router returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual router.

        • meshName (string) --

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

        • virtualRouterName (string) --

          The name of the virtual router.

    • NextToken (string) --

      A token to resume pagination.

class AppMesh.Paginator.ListVirtualServices
paginator = client.get_paginator('list_virtual_services')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AppMesh.Client.list_virtual_services().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    meshName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • meshName (string) --

    [REQUIRED]

    The name of the service mesh to list virtual services in.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'virtualServices': [
        {
            'arn': 'string',
            'meshName': 'string',
            'virtualServiceName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • virtualServices (list) --

      The list of existing virtual services for the specified service mesh.

      • (dict) --

        An object representing a virtual service returned by a list operation.

        • arn (string) --

          The full Amazon Resource Name (ARN) for the virtual service.

        • meshName (string) --

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

        • virtualServiceName (string) --

          The name of the virtual service.

    • NextToken (string) --

      A token to resume pagination.