2019/03/07 - AWS App Mesh - 24 new api methods
Changes Update appmesh client to latest version
Returns a list of existing virtual routers in a service mesh.
See also: AWS API Documentation
Request Syntax
client.list_virtual_routers(
limit=123,
meshName='string',
nextToken='string'
)
integer
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.
string
[REQUIRED]
The name of the service mesh to list virtual routers in.
string
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.
dict
Response Syntax
{
'nextToken': 'string',
'virtualRouters': [
{
'arn': 'string',
'meshName': 'string',
'virtualRouterName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
Deletes an existing virtual service.
See also: AWS API Documentation
Request Syntax
client.delete_virtual_service(
meshName='string',
virtualServiceName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual service in.
string
[REQUIRED]
The name of the virtual service to delete.
dict
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.
Deletes an existing route.
See also: AWS API Documentation
Request Syntax
client.delete_route(
meshName='string',
routeName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the route in.
string
[REQUIRED]
The name of the route to delete.
string
[REQUIRED]
The name of the virtual router to delete the route in.
dict
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'
}
}
},
'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 router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
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.
Creates a virtual service within a service mesh.
A virtual service is an abstraction of a real service that is either 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
client.create_virtual_service(
clientToken='string',
meshName='string',
spec={
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
virtualServiceName='string'
)
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.
string
[REQUIRED]
The name of the service mesh in which to create the virtual service.
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.
string
[REQUIRED]
The name to use for the virtual service.
dict
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.
Deletes an existing service mesh.
You must delete all resources (virtual services, routes, virtual routers, virtual nodes) in the service mesh before you can delete the mesh itself.
See also: AWS API Documentation
Request Syntax
client.delete_mesh(
meshName='string'
)
string
[REQUIRED]
The name of the service mesh to delete.
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'uid': 'string',
'version': 123
},
'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.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Updates an existing virtual service in a specified service mesh.
See also: AWS API Documentation
Request Syntax
client.update_virtual_service(
clientToken='string',
meshName='string',
spec={
'provider': {
'virtualNode': {
'virtualNodeName': 'string'
},
'virtualRouter': {
'virtualRouterName': 'string'
}
}
},
virtualServiceName='string'
)
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.
string
[REQUIRED]
The name of the service mesh that the virtual service resides in.
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.
string
[REQUIRED]
The name of the virtual service to update.
dict
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.
Returns a list of existing virtual nodes.
See also: AWS API Documentation
Request Syntax
client.list_virtual_nodes(
limit=123,
meshName='string',
nextToken='string'
)
integer
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,
nextToken value if applicable.
string
[REQUIRED]
The name of the service mesh to list virtual nodes in.
string
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.
dict
Response Syntax
{
'nextToken': 'string',
'virtualNodes': [
{
'arn': 'string',
'meshName': 'string',
'virtualNodeName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
Creates a new route that is associated with a virtual router.
my-service.local, and you want the route to match requests to my-service.local/metrics, then 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
client.create_route(
clientToken='string',
meshName='string',
routeName='string',
spec={
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'prefix': 'string'
}
}
},
virtualRouterName='string'
)
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.
string
[REQUIRED]
The name of the service mesh in which to create the route.
string
[REQUIRED]
The name to use for the route.
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]
/, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
string
[REQUIRED]
The name of the virtual router in which to create the route.
dict
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'
}
}
},
'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 router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
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.
Returns a list of existing routes in a service mesh.
See also: AWS API Documentation
Request Syntax
client.list_routes(
limit=123,
meshName='string',
nextToken='string',
virtualRouterName='string'
)
integer
ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter,
nextToken value if applicable.
string
[REQUIRED]
The name of the service mesh in which to list routes.
string
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.
string
[REQUIRED]
The name of the virtual router to list routes in.
dict
Response Syntax
{
'nextToken': 'string',
'routes': [
{
'arn': 'string',
'meshName': 'string',
'routeName': 'string',
'virtualRouterName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
Creates a new 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
client.create_mesh(
clientToken='string',
meshName='string'
)
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.
string
[REQUIRED]
The name to use for the service mesh.
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'uid': 'string',
'version': 123
},
'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.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Updates an existing virtual node in a specified service mesh.
See also: AWS API Documentation
Request Syntax
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'
}
},
],
'serviceDiscovery': {
'dns': {
'hostname': 'string'
}
}
},
virtualNodeName='string'
)
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.
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
string
[REQUIRED]
The name of the virtual node to update.
dict
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'
}
},
],
'serviceDiscovery': {
'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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
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.
Describes an existing virtual service.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_service(
meshName='string',
virtualServiceName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual service resides in.
string
[REQUIRED]
The name of the virtual service to describe.
dict
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.
Creates a new virtual node within a service mesh.
A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you must specify the DNS service discovery hostname for your task group.
listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.
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.
See also: AWS API Documentation
Request Syntax
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'
}
},
],
'serviceDiscovery': {
'dns': {
'hostname': 'string'
}
}
},
virtualNodeName='string'
)
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.
string
[REQUIRED]
The name of the service mesh in which to create the virtual node.
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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
dns (dict) --
Specifies the DNS information for the virtual node.
hostname (string) -- [REQUIRED]
Specifies the DNS service discovery hostname for the virtual node.
string
[REQUIRED]
The name to use for the virtual node.
dict
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'
}
},
],
'serviceDiscovery': {
'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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
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.
Describes an existing virtual node.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_node(
meshName='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual node resides in.
string
[REQUIRED]
The name of the virtual node to describe.
dict
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'
}
},
],
'serviceDiscovery': {
'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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
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.
Describes an existing route.
See also: AWS API Documentation
Request Syntax
client.describe_route(
meshName='string',
routeName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh that the route resides in.
string
[REQUIRED]
The name of the route to describe.
string
[REQUIRED]
The name of the virtual router that the route is associated with.
dict
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'
}
}
},
'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 router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
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.
Describes an existing virtual router.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_router(
meshName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh that the virtual router resides in.
string
[REQUIRED]
The name of the virtual router to describe.
dict
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.
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
client.delete_virtual_router(
meshName='string',
virtualRouterName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual router in.
string
[REQUIRED]
The name of the virtual router to delete.
dict
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.
Describes an existing service mesh.
See also: AWS API Documentation
Request Syntax
client.describe_mesh(
meshName='string'
)
string
[REQUIRED]
The name of the service mesh to describe.
dict
Response Syntax
{
'mesh': {
'meshName': 'string',
'metadata': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'uid': 'string',
'version': 123
},
'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.
status (dict) --
The status of the service mesh.
status (string) --
The current mesh status.
Returns a list of existing service meshes.
See also: AWS API Documentation
Request Syntax
client.list_meshes(
limit=123,
nextToken='string'
)
integer
ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter,
nextToken value if applicable.
string
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.
dict
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) --
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.
Returns a list of existing virtual services in a service mesh.
See also: AWS API Documentation
Request Syntax
client.list_virtual_services(
limit=123,
meshName='string',
nextToken='string'
)
integer
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.
string
[REQUIRED]
The name of the service mesh to list virtual services in.
string
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.
dict
Response Syntax
{
'nextToken': 'string',
'virtualServices': [
{
'arn': 'string',
'meshName': 'string',
'virtualServiceName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
Updates an existing virtual router in a specified service mesh.
See also: AWS API Documentation
Request Syntax
client.update_virtual_router(
clientToken='string',
meshName='string',
spec={
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
]
},
virtualRouterName='string'
)
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.
string
[REQUIRED]
The name of the service mesh that the virtual router resides in.
dict
[REQUIRED]
The new virtual router specification to apply. This overwrites the existing data.
listeners (list) -- [REQUIRED]
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.
string
[REQUIRED]
The name of the virtual router to update.
dict
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.
Updates an existing route for a specified service mesh and virtual router.
See also: AWS API Documentation
Request Syntax
client.update_route(
clientToken='string',
meshName='string',
routeName='string',
spec={
'httpRoute': {
'action': {
'weightedTargets': [
{
'virtualNode': 'string',
'weight': 123
},
]
},
'match': {
'prefix': 'string'
}
}
},
virtualRouterName='string'
)
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.
string
[REQUIRED]
The name of the service mesh that the route resides in.
string
[REQUIRED]
The name of the route to update.
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]
/, which by itself matches all requests to the virtual router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
string
[REQUIRED]
The name of the virtual router that the route is associated with.
dict
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'
}
}
},
'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 router service name. You can also match for path-based routing of requests. For example, if your virtual router service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
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.
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
client.delete_virtual_node(
meshName='string',
virtualNodeName='string'
)
string
[REQUIRED]
The name of the service mesh to delete the virtual node in.
string
[REQUIRED]
The name of the virtual node to delete.
dict
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'
}
},
],
'serviceDiscovery': {
'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.
serviceDiscovery (dict) --
The service discovery information for the virtual node.
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.
Creates a new virtual router within a service mesh.
listener.
Virtual routers handle traffic for one or more service names 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
client.create_virtual_router(
clientToken='string',
meshName='string',
spec={
'listeners': [
{
'portMapping': {
'port': 123,
'protocol': 'http'|'tcp'
}
},
]
},
virtualRouterName='string'
)
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.
string
[REQUIRED]
The name of the service mesh to create the virtual router in.
dict
[REQUIRED]
The virtual router specification to apply.
listeners (list) -- [REQUIRED]
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.
string
[REQUIRED]
The name to use for the virtual router.
dict
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.