dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/appmesh/2019-01-25/service-2.json
Noah Meyerhans 3ec6076be6 New upstream version 1.20.0+repack
2021-02-02 14:32:12 -08:00

5406 lines
218 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2019-01-25",
"endpointPrefix":"appmesh",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS App Mesh",
"serviceId":"App Mesh",
"signatureVersion":"v4",
"signingName":"appmesh",
"uid":"appmesh-2019-01-25"
},
"operations":{
"CreateGatewayRoute":{
"name":"CreateGatewayRoute",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes",
"responseCode":200
},
"input":{"shape":"CreateGatewayRouteInput"},
"output":{"shape":"CreateGatewayRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a gateway route.</p> <p>A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.</p> <p>For more information about gateway routes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html\">Gateway routes</a>.</p>",
"idempotent":true
},
"CreateMesh":{
"name":"CreateMesh",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes",
"responseCode":200
},
"input":{"shape":"CreateMeshInput"},
"output":{"shape":"CreateMeshOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a service mesh.</p> <p> A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. 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.</p> <p>For more information about service meshes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html\">Service meshes</a>.</p>",
"idempotent":true
},
"CreateRoute":{
"name":"CreateRoute",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes",
"responseCode":200
},
"input":{"shape":"CreateRouteInput"},
"output":{"shape":"CreateRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a route that is associated with a virtual router.</p> <p> You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.</p> <p>For more information about routes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html\">Routes</a>.</p>",
"idempotent":true
},
"CreateVirtualGateway":{
"name":"CreateVirtualGateway",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateways",
"responseCode":200
},
"input":{"shape":"CreateVirtualGatewayInput"},
"output":{"shape":"CreateVirtualGatewayOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a virtual gateway.</p> <p>A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.</p> <p>For more information about virtual gateways, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html\">Virtual gateways</a>. </p>",
"idempotent":true
},
"CreateVirtualNode":{
"name":"CreateVirtualNode",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualNodes",
"responseCode":200
},
"input":{"shape":"CreateVirtualNodeInput"},
"output":{"shape":"CreateVirtualNodeOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a virtual node within a service mesh.</p> <p> 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, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).</p> <p>You define a <code>listener</code> for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a <code>backend</code>.</p> <p>The response metadata for your new virtual node contains the <code>arn</code> that is associated with the virtual node. Set this value to the full ARN; for example, <code>arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp</code>) as the <code>APPMESH_RESOURCE_ARN</code> environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p> <note> <p>By default, App Mesh uses the name of the resource you specified in <code>APPMESH_RESOURCE_ARN</code> when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the <code>APPMESH_RESOURCE_CLUSTER</code> environment variable with your own name.</p> <p>AWS Cloud Map is not available in the eu-south-1 Region.</p> </note> <p>For more information about virtual nodes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html\">Virtual nodes</a>. You must be using <code>1.15.0</code> or later of the Envoy image when setting these variables. For more information about App Mesh Envoy variables, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/envoy.html\">Envoy image</a> in the AWS App Mesh User Guide.</p>",
"idempotent":true
},
"CreateVirtualRouter":{
"name":"CreateVirtualRouter",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouters",
"responseCode":200
},
"input":{"shape":"CreateVirtualRouterInput"},
"output":{"shape":"CreateVirtualRouterOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a virtual router within a service mesh.</p> <p>Specify a <code>listener</code> for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. 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.</p> <p>For more information about virtual routers, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html\">Virtual routers</a>.</p>",
"idempotent":true
},
"CreateVirtualService":{
"name":"CreateVirtualService",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualServices",
"responseCode":200
},
"input":{"shape":"CreateVirtualServiceInput"},
"output":{"shape":"CreateVirtualServiceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a virtual service within a service mesh.</p> <p>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 <code>virtualServiceName</code>, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.</p> <p>For more information about virtual services, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html\">Virtual services</a>.</p>",
"idempotent":true
},
"DeleteGatewayRoute":{
"name":"DeleteGatewayRoute",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
"responseCode":200
},
"input":{"shape":"DeleteGatewayRouteInput"},
"output":{"shape":"DeleteGatewayRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing gateway route.</p>",
"idempotent":true
},
"DeleteMesh":{
"name":"DeleteMesh",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}",
"responseCode":200
},
"input":{"shape":"DeleteMeshInput"},
"output":{"shape":"DeleteMeshOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing service mesh.</p> <p>You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.</p>",
"idempotent":true
},
"DeleteRoute":{
"name":"DeleteRoute",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}",
"responseCode":200
},
"input":{"shape":"DeleteRouteInput"},
"output":{"shape":"DeleteRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing route.</p>",
"idempotent":true
},
"DeleteVirtualGateway":{
"name":"DeleteVirtualGateway",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
"responseCode":200
},
"input":{"shape":"DeleteVirtualGatewayInput"},
"output":{"shape":"DeleteVirtualGatewayOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.</p>",
"idempotent":true
},
"DeleteVirtualNode":{
"name":"DeleteVirtualNode",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}",
"responseCode":200
},
"input":{"shape":"DeleteVirtualNodeInput"},
"output":{"shape":"DeleteVirtualNodeOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing virtual node.</p> <p>You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.</p>",
"idempotent":true
},
"DeleteVirtualRouter":{
"name":"DeleteVirtualRouter",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}",
"responseCode":200
},
"input":{"shape":"DeleteVirtualRouterInput"},
"output":{"shape":"DeleteVirtualRouterOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing virtual router.</p> <p>You must delete any routes associated with the virtual router before you can delete the router itself.</p>",
"idempotent":true
},
"DeleteVirtualService":{
"name":"DeleteVirtualService",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}",
"responseCode":200
},
"input":{"shape":"DeleteVirtualServiceInput"},
"output":{"shape":"DeleteVirtualServiceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceInUseException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an existing virtual service.</p>",
"idempotent":true
},
"DescribeGatewayRoute":{
"name":"DescribeGatewayRoute",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
"responseCode":200
},
"input":{"shape":"DescribeGatewayRouteInput"},
"output":{"shape":"DescribeGatewayRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing gateway route.</p>"
},
"DescribeMesh":{
"name":"DescribeMesh",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}",
"responseCode":200
},
"input":{"shape":"DescribeMeshInput"},
"output":{"shape":"DescribeMeshOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing service mesh.</p>"
},
"DescribeRoute":{
"name":"DescribeRoute",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}",
"responseCode":200
},
"input":{"shape":"DescribeRouteInput"},
"output":{"shape":"DescribeRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing route.</p>"
},
"DescribeVirtualGateway":{
"name":"DescribeVirtualGateway",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
"responseCode":200
},
"input":{"shape":"DescribeVirtualGatewayInput"},
"output":{"shape":"DescribeVirtualGatewayOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing virtual gateway.</p>"
},
"DescribeVirtualNode":{
"name":"DescribeVirtualNode",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}",
"responseCode":200
},
"input":{"shape":"DescribeVirtualNodeInput"},
"output":{"shape":"DescribeVirtualNodeOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing virtual node.</p>"
},
"DescribeVirtualRouter":{
"name":"DescribeVirtualRouter",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}",
"responseCode":200
},
"input":{"shape":"DescribeVirtualRouterInput"},
"output":{"shape":"DescribeVirtualRouterOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing virtual router.</p>"
},
"DescribeVirtualService":{
"name":"DescribeVirtualService",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}",
"responseCode":200
},
"input":{"shape":"DescribeVirtualServiceInput"},
"output":{"shape":"DescribeVirtualServiceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Describes an existing virtual service.</p>"
},
"ListGatewayRoutes":{
"name":"ListGatewayRoutes",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes",
"responseCode":200
},
"input":{"shape":"ListGatewayRoutesInput"},
"output":{"shape":"ListGatewayRoutesOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing gateway routes that are associated to a virtual gateway.</p>"
},
"ListMeshes":{
"name":"ListMeshes",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes",
"responseCode":200
},
"input":{"shape":"ListMeshesInput"},
"output":{"shape":"ListMeshesOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing service meshes.</p>"
},
"ListRoutes":{
"name":"ListRoutes",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes",
"responseCode":200
},
"input":{"shape":"ListRoutesInput"},
"output":{"shape":"ListRoutesOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing routes in a service mesh.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/v20190125/tags",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceInput"},
"output":{"shape":"ListTagsForResourceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>List the tags for an App Mesh resource.</p>"
},
"ListVirtualGateways":{
"name":"ListVirtualGateways",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateways",
"responseCode":200
},
"input":{"shape":"ListVirtualGatewaysInput"},
"output":{"shape":"ListVirtualGatewaysOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing virtual gateways in a service mesh.</p>"
},
"ListVirtualNodes":{
"name":"ListVirtualNodes",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualNodes",
"responseCode":200
},
"input":{"shape":"ListVirtualNodesInput"},
"output":{"shape":"ListVirtualNodesOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing virtual nodes.</p>"
},
"ListVirtualRouters":{
"name":"ListVirtualRouters",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouters",
"responseCode":200
},
"input":{"shape":"ListVirtualRoutersInput"},
"output":{"shape":"ListVirtualRoutersOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing virtual routers in a service mesh.</p>"
},
"ListVirtualServices":{
"name":"ListVirtualServices",
"http":{
"method":"GET",
"requestUri":"/v20190125/meshes/{meshName}/virtualServices",
"responseCode":200
},
"input":{"shape":"ListVirtualServicesInput"},
"output":{"shape":"ListVirtualServicesOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of existing virtual services in a service mesh.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"PUT",
"requestUri":"/v20190125/tag",
"responseCode":200
},
"input":{"shape":"TagResourceInput"},
"output":{"shape":"TagResourceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyTagsException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. 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.</p>",
"idempotent":true
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"PUT",
"requestUri":"/v20190125/untag",
"responseCode":200
},
"input":{"shape":"UntagResourceInput"},
"output":{"shape":"UntagResourceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes specified tags from a resource.</p>",
"idempotent":true
},
"UpdateGatewayRoute":{
"name":"UpdateGatewayRoute",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
"responseCode":200
},
"input":{"shape":"UpdateGatewayRouteInput"},
"output":{"shape":"UpdateGatewayRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.</p>",
"idempotent":true
},
"UpdateMesh":{
"name":"UpdateMesh",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}",
"responseCode":200
},
"input":{"shape":"UpdateMeshInput"},
"output":{"shape":"UpdateMeshOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Updates an existing service mesh.</p>",
"idempotent":true
},
"UpdateRoute":{
"name":"UpdateRoute",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}",
"responseCode":200
},
"input":{"shape":"UpdateRouteInput"},
"output":{"shape":"UpdateRouteOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing route for a specified service mesh and virtual router.</p>",
"idempotent":true
},
"UpdateVirtualGateway":{
"name":"UpdateVirtualGateway",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
"responseCode":200
},
"input":{"shape":"UpdateVirtualGatewayInput"},
"output":{"shape":"UpdateVirtualGatewayOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing virtual gateway in a specified service mesh.</p>",
"idempotent":true
},
"UpdateVirtualNode":{
"name":"UpdateVirtualNode",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}",
"responseCode":200
},
"input":{"shape":"UpdateVirtualNodeInput"},
"output":{"shape":"UpdateVirtualNodeOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing virtual node in a specified service mesh.</p>",
"idempotent":true
},
"UpdateVirtualRouter":{
"name":"UpdateVirtualRouter",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}",
"responseCode":200
},
"input":{"shape":"UpdateVirtualRouterInput"},
"output":{"shape":"UpdateVirtualRouterOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing virtual router in a specified service mesh.</p>",
"idempotent":true
},
"UpdateVirtualService":{
"name":"UpdateVirtualService",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}",
"responseCode":200
},
"input":{"shape":"UpdateVirtualServiceInput"},
"output":{"shape":"UpdateVirtualServiceOutput"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalServerErrorException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates an existing virtual service in a specified service mesh.</p>",
"idempotent":true
}
},
"shapes":{
"AccessLog":{
"type":"structure",
"members":{
"file":{
"shape":"FileAccessLog",
"documentation":"<p>The file object to send virtual node access logs to.</p>"
}
},
"documentation":"<p>An object that represents the access logging information for a virtual node.</p>",
"union":true
},
"AccountId":{
"type":"string",
"max":12,
"min":12
},
"Arn":{"type":"string"},
"AwsCloudMapInstanceAttribute":{
"type":"structure",
"required":[
"key",
"value"
],
"members":{
"key":{
"shape":"AwsCloudMapInstanceAttributeKey",
"documentation":"<p>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.</p>"
},
"value":{
"shape":"AwsCloudMapInstanceAttributeValue",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>An object that represents the AWS Cloud Map attribute information for your virtual node.</p> <note> <p>AWS Cloud Map is not available in the eu-south-1 Region.</p> </note>"
},
"AwsCloudMapInstanceAttributeKey":{
"type":"string",
"max":255,
"min":1,
"pattern":"^[a-zA-Z0-9!-~]+$"
},
"AwsCloudMapInstanceAttributeValue":{
"type":"string",
"max":1024,
"min":1,
"pattern":"^([a-zA-Z0-9!-~][ a-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}$"
},
"AwsCloudMapInstanceAttributes":{
"type":"list",
"member":{"shape":"AwsCloudMapInstanceAttribute"}
},
"AwsCloudMapName":{
"type":"string",
"max":1024,
"min":1
},
"AwsCloudMapServiceDiscovery":{
"type":"structure",
"required":[
"namespaceName",
"serviceName"
],
"members":{
"attributes":{
"shape":"AwsCloudMapInstanceAttributes",
"documentation":"<p>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.</p>"
},
"namespaceName":{
"shape":"AwsCloudMapName",
"documentation":"<p>The name of the AWS Cloud Map namespace to use.</p>"
},
"serviceName":{
"shape":"AwsCloudMapName",
"documentation":"<p>The name of the AWS Cloud Map service to use.</p>"
}
},
"documentation":"<p>An object that represents the AWS Cloud Map service discovery information for your virtual node.</p> <note> <p>AWS Cloud Map is not available in the eu-south-1 Region.</p> </note>"
},
"Backend":{
"type":"structure",
"members":{
"virtualService":{
"shape":"VirtualServiceBackend",
"documentation":"<p>Specifies a virtual service to use as a backend. </p>"
}
},
"documentation":"<p>An object that represents the backends that a virtual node is expected to send outbound traffic to.</p>",
"union":true
},
"BackendDefaults":{
"type":"structure",
"members":{
"clientPolicy":{
"shape":"ClientPolicy",
"documentation":"<p>A reference to an object that represents a client policy.</p>"
}
},
"documentation":"<p>An object that represents the default properties for a backend.</p>"
},
"Backends":{
"type":"list",
"member":{"shape":"Backend"}
},
"BadRequestException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The request syntax was malformed. Check your request syntax and try again.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"Boolean":{
"type":"boolean",
"box":true
},
"CertificateAuthorityArns":{
"type":"list",
"member":{"shape":"Arn"},
"max":3,
"min":1
},
"ClientPolicy":{
"type":"structure",
"members":{
"tls":{
"shape":"ClientPolicyTls",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>"
}
},
"documentation":"<p>An object that represents a client policy.</p>"
},
"ClientPolicyTls":{
"type":"structure",
"required":["validation"],
"members":{
"certificate":{
"shape":"ClientTlsCertificate",
"documentation":"<p>A reference to an object that represents a client's TLS certificate.</p>"
},
"enforce":{
"shape":"Boolean",
"documentation":"<p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't specified.</p>",
"box":true
},
"ports":{
"shape":"PortSet",
"documentation":"<p>One or more ports that the policy is enforced for.</p>"
},
"validation":{
"shape":"TlsValidationContext",
"documentation":"<p>A reference to an object that represents a TLS validation context.</p>"
}
},
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>"
},
"ClientTlsCertificate":{
"type":"structure",
"members":{
"file":{"shape":"ListenerTlsFileCertificate"},
"sds":{
"shape":"ListenerTlsSdsCertificate",
"documentation":"<p>A reference to an object that represents a client's TLS Secret Discovery Service certificate.</p>"
}
},
"documentation":"<p>An object that represents the client's certificate.</p>",
"union":true
},
"ConflictException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.</p>",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"CreateGatewayRouteInput":{
"type":"structure",
"required":[
"gatewayRouteName",
"meshName",
"spec",
"virtualGatewayName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the gateway route.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the gateway route in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"GatewayRouteSpec",
"documentation":"<p>The gateway route specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Optional metadata that you can apply to the gateway 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.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"CreateGatewayRouteOutput":{
"type":"structure",
"required":["gatewayRoute"],
"members":{
"gatewayRoute":{
"shape":"GatewayRouteData",
"documentation":"<p>The full description of your gateway route following the create call.</p>"
}
},
"payload":"gatewayRoute"
},
"CreateMeshInput":{
"type":"structure",
"required":["meshName"],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the service mesh.</p>"
},
"spec":{
"shape":"MeshSpec",
"documentation":"<p>The service mesh specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"CreateMeshOutput":{
"type":"structure",
"required":["mesh"],
"members":{
"mesh":{
"shape":"MeshData",
"documentation":"<p>The full description of your service mesh following the create call.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"mesh"
},
"CreateRouteInput":{
"type":"structure",
"required":[
"meshName",
"routeName",
"spec",
"virtualRouterName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the route in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the route.</p>"
},
"spec":{
"shape":"RouteSpec",
"documentation":"<p>The route specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"CreateRouteOutput":{
"type":"structure",
"required":["route"],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The full description of your mesh following the create call.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"route"
},
"CreateVirtualGatewayInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualGatewayName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the virtual gateway in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualGatewaySpec",
"documentation":"<p>The virtual gateway specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>Optional metadata that you can apply to the virtual gateway 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.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the virtual gateway.</p>"
}
}
},
"CreateVirtualGatewayOutput":{
"type":"structure",
"required":["virtualGateway"],
"members":{
"virtualGateway":{
"shape":"VirtualGatewayData",
"documentation":"<p>The full description of your virtual gateway following the create call.</p>"
}
},
"payload":"virtualGateway"
},
"CreateVirtualNodeInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualNodeName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the virtual node in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualNodeSpec",
"documentation":"<p>The virtual node specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the virtual node.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"CreateVirtualNodeOutput":{
"type":"structure",
"required":["virtualNode"],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>The full description of your virtual node following the create call.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualNode"
},
"CreateVirtualRouterInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualRouterName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the virtual router in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualRouterSpec",
"documentation":"<p>The virtual router specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the virtual router.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"CreateVirtualRouterOutput":{
"type":"structure",
"required":["virtualRouter"],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The full description of your virtual router following the create call.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualRouter"
},
"CreateVirtualServiceInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualServiceName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to create the virtual service in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualServiceSpec",
"documentation":"<p>The virtual service specification to apply.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name to use for the virtual service.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"CreateVirtualServiceOutput":{
"type":"structure",
"required":["virtualService"],
"members":{
"virtualService":{
"shape":"VirtualServiceData",
"documentation":"<p>The full description of your virtual service following the create call.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualService"
},
"DeleteGatewayRouteInput":{
"type":"structure",
"required":[
"gatewayRouteName",
"meshName",
"virtualGatewayName"
],
"members":{
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name of the gateway route to delete.</p>",
"location":"uri",
"locationName":"gatewayRouteName"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the gateway route from.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to delete the route from.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"DeleteGatewayRouteOutput":{
"type":"structure",
"required":["gatewayRoute"],
"members":{
"gatewayRoute":{
"shape":"GatewayRouteData",
"documentation":"<p>The gateway route that was deleted.</p>"
}
},
"payload":"gatewayRoute"
},
"DeleteMeshInput":{
"type":"structure",
"required":["meshName"],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete.</p>",
"location":"uri",
"locationName":"meshName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DeleteMeshOutput":{
"type":"structure",
"required":["mesh"],
"members":{
"mesh":{
"shape":"MeshData",
"documentation":"<p>The service mesh that was deleted.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"mesh"
},
"DeleteRouteInput":{
"type":"structure",
"required":[
"meshName",
"routeName",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the route in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the route to delete.</p>",
"location":"uri",
"locationName":"routeName"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to delete the route in.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DeleteRouteOutput":{
"type":"structure",
"required":["route"],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The route that was deleted.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"route"
},
"DeleteVirtualGatewayInput":{
"type":"structure",
"required":[
"meshName",
"virtualGatewayName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the virtual gateway from.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to delete.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"DeleteVirtualGatewayOutput":{
"type":"structure",
"required":["virtualGateway"],
"members":{
"virtualGateway":{
"shape":"VirtualGatewayData",
"documentation":"<p>The virtual gateway that was deleted.</p>"
}
},
"payload":"virtualGateway"
},
"DeleteVirtualNodeInput":{
"type":"structure",
"required":[
"meshName",
"virtualNodeName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the virtual node in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node to delete.</p>",
"location":"uri",
"locationName":"virtualNodeName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DeleteVirtualNodeOutput":{
"type":"structure",
"required":["virtualNode"],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>The virtual node that was deleted.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualNode"
},
"DeleteVirtualRouterInput":{
"type":"structure",
"required":[
"meshName",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the virtual router in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to delete.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DeleteVirtualRouterOutput":{
"type":"structure",
"required":["virtualRouter"],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The virtual router that was deleted.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualRouter"
},
"DeleteVirtualServiceInput":{
"type":"structure",
"required":[
"meshName",
"virtualServiceName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete the virtual service in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service to delete.</p>",
"location":"uri",
"locationName":"virtualServiceName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DeleteVirtualServiceOutput":{
"type":"structure",
"required":["virtualService"],
"members":{
"virtualService":{
"shape":"VirtualServiceData",
"documentation":"<p>The virtual service that was deleted.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualService"
},
"DescribeGatewayRouteInput":{
"type":"structure",
"required":[
"gatewayRouteName",
"meshName",
"virtualGatewayName"
],
"members":{
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name of the gateway route to describe.</p>",
"location":"uri",
"locationName":"gatewayRouteName"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the gateway route resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway that the gateway route is associated with.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"DescribeGatewayRouteOutput":{
"type":"structure",
"required":["gatewayRoute"],
"members":{
"gatewayRoute":{
"shape":"GatewayRouteData",
"documentation":"<p>The full description of your gateway route.</p>"
}
},
"payload":"gatewayRoute"
},
"DescribeMeshInput":{
"type":"structure",
"required":["meshName"],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to describe.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DescribeMeshOutput":{
"type":"structure",
"required":["mesh"],
"members":{
"mesh":{
"shape":"MeshData",
"documentation":"<p>The full description of your service mesh.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"mesh"
},
"DescribeRouteInput":{
"type":"structure",
"required":[
"meshName",
"routeName",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the route resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the route to describe.</p>",
"location":"uri",
"locationName":"routeName"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router that the route is associated with.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DescribeRouteOutput":{
"type":"structure",
"required":["route"],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The full description of your route.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"route"
},
"DescribeVirtualGatewayInput":{
"type":"structure",
"required":[
"meshName",
"virtualGatewayName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the gateway route resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to describe.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"DescribeVirtualGatewayOutput":{
"type":"structure",
"required":["virtualGateway"],
"members":{
"virtualGateway":{
"shape":"VirtualGatewayData",
"documentation":"<p>The full description of your virtual gateway.</p>"
}
},
"payload":"virtualGateway"
},
"DescribeVirtualNodeInput":{
"type":"structure",
"required":[
"meshName",
"virtualNodeName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual node resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node to describe.</p>",
"location":"uri",
"locationName":"virtualNodeName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DescribeVirtualNodeOutput":{
"type":"structure",
"required":["virtualNode"],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>The full description of your virtual node.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualNode"
},
"DescribeVirtualRouterInput":{
"type":"structure",
"required":[
"meshName",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual router resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to describe.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DescribeVirtualRouterOutput":{
"type":"structure",
"required":["virtualRouter"],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The full description of your virtual router.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualRouter"
},
"DescribeVirtualServiceInput":{
"type":"structure",
"required":[
"meshName",
"virtualServiceName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual service resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service to describe.</p>",
"location":"uri",
"locationName":"virtualServiceName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"DescribeVirtualServiceOutput":{
"type":"structure",
"required":["virtualService"],
"members":{
"virtualService":{
"shape":"VirtualServiceData",
"documentation":"<p>The full description of your virtual service.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualService"
},
"DnsServiceDiscovery":{
"type":"structure",
"required":["hostname"],
"members":{
"hostname":{
"shape":"Hostname",
"documentation":"<p>Specifies the DNS service discovery hostname for the virtual node. </p>"
}
},
"documentation":"<p>An object that represents the DNS service discovery information for your virtual node.</p>"
},
"Duration":{
"type":"structure",
"members":{
"unit":{
"shape":"DurationUnit",
"documentation":"<p>A unit of time.</p>"
},
"value":{
"shape":"DurationValue",
"documentation":"<p>A number of time units.</p>"
}
},
"documentation":"<p>An object that represents a duration of time.</p>"
},
"DurationUnit":{
"type":"string",
"enum":[
"s",
"ms"
]
},
"DurationValue":{
"type":"long",
"box":true,
"min":0
},
"EgressFilter":{
"type":"structure",
"required":["type"],
"members":{
"type":{
"shape":"EgressFilterType",
"documentation":"<p>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to <code>*.amazonaws.com</code> for AWS API calls). You can set the egress filter type to <code>ALLOW_ALL</code> to allow egress to any endpoint inside or outside of the service mesh.</p>"
}
},
"documentation":"<p>An object that represents the egress filter rules for a service mesh.</p>"
},
"EgressFilterType":{
"type":"string",
"enum":[
"ALLOW_ALL",
"DROP_ALL"
]
},
"FileAccessLog":{
"type":"structure",
"required":["path"],
"members":{
"path":{
"shape":"FilePath",
"documentation":"<p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send access logs to standard out and configure your Envoy container to use a log driver, such as <code>awslogs</code>, 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.</p> <note> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>"
}
},
"documentation":"<p>An object that represents an access log file.</p>"
},
"FilePath":{
"type":"string",
"max":255,
"min":1
},
"ForbiddenException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You don't have permissions to perform this action.</p>",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"GatewayRouteData":{
"type":"structure",
"required":[
"gatewayRouteName",
"meshName",
"metadata",
"spec",
"status",
"virtualGatewayName"
],
"members":{
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name of the gateway route.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the resource resides in. </p>"
},
"metadata":{"shape":"ResourceMetadata"},
"spec":{
"shape":"GatewayRouteSpec",
"documentation":"<p>The specifications of the gateway route.</p>"
},
"status":{
"shape":"GatewayRouteStatus",
"documentation":"<p>The status of the gateway route.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The virtual gateway that the gateway route is associated with.</p>"
}
},
"documentation":"<p>An object that represents a gateway route returned by a describe operation.</p>"
},
"GatewayRouteList":{
"type":"list",
"member":{"shape":"GatewayRouteRef"}
},
"GatewayRouteRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"gatewayRouteName",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version",
"virtualGatewayName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the gateway route.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name of the gateway route.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the resource resides in. </p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The virtual gateway that the gateway route is associated with.</p>"
}
},
"documentation":"<p>An object that represents a gateway route returned by a list operation.</p>"
},
"GatewayRouteSpec":{
"type":"structure",
"members":{
"grpcRoute":{
"shape":"GrpcGatewayRoute",
"documentation":"<p>An object that represents the specification of a gRPC gateway route.</p>"
},
"http2Route":{
"shape":"HttpGatewayRoute",
"documentation":"<p>An object that represents the specification of an HTTP/2 gateway route.</p>"
},
"httpRoute":{
"shape":"HttpGatewayRoute",
"documentation":"<p>An object that represents the specification of an HTTP gateway route.</p>"
}
},
"documentation":"<p>An object that represents a gateway route specification. Specify one gateway route type.</p>"
},
"GatewayRouteStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"GatewayRouteStatusCode",
"documentation":"<p>The current status for the gateway route.</p>"
}
},
"documentation":"<p>An object that represents the current status of a gateway route.</p>"
},
"GatewayRouteStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"GatewayRouteTarget":{
"type":"structure",
"required":["virtualService"],
"members":{
"virtualService":{
"shape":"GatewayRouteVirtualService",
"documentation":"<p>An object that represents a virtual service gateway route target.</p>"
}
},
"documentation":"<p>An object that represents a gateway route target.</p>"
},
"GatewayRouteVirtualService":{
"type":"structure",
"required":["virtualServiceName"],
"members":{
"virtualServiceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual service that traffic is routed to.</p>"
}
},
"documentation":"<p>An object that represents the virtual service that traffic is routed to.</p>"
},
"GrpcGatewayRoute":{
"type":"structure",
"required":[
"action",
"match"
],
"members":{
"action":{
"shape":"GrpcGatewayRouteAction",
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"match":{
"shape":"GrpcGatewayRouteMatch",
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
}
},
"documentation":"<p>An object that represents a gRPC gateway route.</p>"
},
"GrpcGatewayRouteAction":{
"type":"structure",
"required":["target"],
"members":{
"target":{
"shape":"GatewayRouteTarget",
"documentation":"<p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>"
}
},
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"GrpcGatewayRouteMatch":{
"type":"structure",
"members":{
"serviceName":{
"shape":"ServiceName",
"documentation":"<p>The fully qualified domain name for the service to match from the request.</p>"
}
},
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
},
"GrpcRetryPolicy":{
"type":"structure",
"required":[
"maxRetries",
"perRetryTimeout"
],
"members":{
"grpcRetryEvents":{
"shape":"GrpcRetryPolicyEvents",
"documentation":"<p>Specify at least one of the valid values.</p>"
},
"httpRetryEvents":{
"shape":"HttpRetryPolicyEvents",
"documentation":"<p>Specify at least one of the following values.</p> <ul> <li> <p> <b>server-error</b> – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511</p> </li> <li> <p> <b>gateway-error</b> – HTTP status codes 502, 503, and 504</p> </li> <li> <p> <b>client-error</b> – HTTP status code 409</p> </li> <li> <p> <b>stream-error</b> – Retry on refused stream</p> </li> </ul>"
},
"maxRetries":{
"shape":"MaxRetries",
"documentation":"<p>The maximum number of retry attempts.</p>"
},
"perRetryTimeout":{
"shape":"Duration",
"documentation":"<p>The timeout for each retry attempt.</p>"
},
"tcpRetryEvents":{
"shape":"TcpRetryPolicyEvents",
"documentation":"<p>Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.</p>"
}
},
"documentation":"<p>An object that represents a retry policy. Specify at least one value for at least one of the types of <code>RetryEvents</code>, a value for <code>maxRetries</code>, and a value for <code>perRetryTimeout</code>.</p>"
},
"GrpcRetryPolicyEvent":{
"type":"string",
"enum":[
"cancelled",
"deadline-exceeded",
"internal",
"resource-exhausted",
"unavailable"
]
},
"GrpcRetryPolicyEvents":{
"type":"list",
"member":{"shape":"GrpcRetryPolicyEvent"},
"max":5,
"min":1
},
"GrpcRoute":{
"type":"structure",
"required":[
"action",
"match"
],
"members":{
"action":{
"shape":"GrpcRouteAction",
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"match":{
"shape":"GrpcRouteMatch",
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
},
"retryPolicy":{
"shape":"GrpcRetryPolicy",
"documentation":"<p>An object that represents a retry policy.</p>"
},
"timeout":{
"shape":"GrpcTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
}
},
"documentation":"<p>An object that represents a gRPC route type.</p>"
},
"GrpcRouteAction":{
"type":"structure",
"required":["weightedTargets"],
"members":{
"weightedTargets":{
"shape":"WeightedTargets",
"documentation":"<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
}
},
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"GrpcRouteMatch":{
"type":"structure",
"members":{
"metadata":{
"shape":"GrpcRouteMetadataList",
"documentation":"<p>An object that represents the data to match from the request.</p>"
},
"methodName":{
"shape":"MethodName",
"documentation":"<p>The method name to match from the request. If you specify a name, you must also specify a <code>serviceName</code>.</p>"
},
"serviceName":{
"shape":"ServiceName",
"documentation":"<p>The fully qualified domain name for the service to match from the request.</p>"
}
},
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
},
"GrpcRouteMetadata":{
"type":"structure",
"required":["name"],
"members":{
"invert":{
"shape":"Boolean",
"documentation":"<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
},
"match":{
"shape":"GrpcRouteMetadataMatchMethod",
"documentation":"<p>An object that represents the data to match from the request.</p>"
},
"name":{
"shape":"HeaderName",
"documentation":"<p>The name of the route.</p>"
}
},
"documentation":"<p>An object that represents the match metadata for the route.</p>"
},
"GrpcRouteMetadataList":{
"type":"list",
"member":{"shape":"GrpcRouteMetadata"},
"max":10,
"min":1
},
"GrpcRouteMetadataMatchMethod":{
"type":"structure",
"members":{
"exact":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must match the specified value exactly.</p>"
},
"prefix":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must begin with the specified characters.</p>"
},
"range":{
"shape":"MatchRange",
"documentation":"<p>An object that represents the range of values to match on.</p>"
},
"regex":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must include the specified characters.</p>"
},
"suffix":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must end with the specified characters.</p>"
}
},
"documentation":"<p>An object that represents the match method. Specify one of the match values.</p>",
"union":true
},
"GrpcTimeout":{
"type":"structure",
"members":{
"idle":{
"shape":"Duration",
"documentation":"<p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>"
},
"perRequest":{
"shape":"Duration",
"documentation":"<p>An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.</p>"
}
},
"documentation":"<p>An object that represents types of timeouts. </p>"
},
"HeaderMatch":{
"type":"string",
"max":255,
"min":1
},
"HeaderMatchMethod":{
"type":"structure",
"members":{
"exact":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must match the specified value exactly.</p>"
},
"prefix":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must begin with the specified characters.</p>"
},
"range":{
"shape":"MatchRange",
"documentation":"<p>An object that represents the range of values to match on.</p>"
},
"regex":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must include the specified characters.</p>"
},
"suffix":{
"shape":"HeaderMatch",
"documentation":"<p>The value sent by the client must end with the specified characters.</p>"
}
},
"documentation":"<p>An object that represents the method and value to match with the header value sent in a request. Specify one match method.</p>",
"union":true
},
"HeaderName":{
"type":"string",
"max":50,
"min":1
},
"HealthCheckIntervalMillis":{
"type":"long",
"box":true,
"max":300000,
"min":5000
},
"HealthCheckPolicy":{
"type":"structure",
"required":[
"healthyThreshold",
"intervalMillis",
"protocol",
"timeoutMillis",
"unhealthyThreshold"
],
"members":{
"healthyThreshold":{
"shape":"HealthCheckThreshold",
"documentation":"<p>The number of consecutive successful health checks that must occur before declaring listener healthy.</p>"
},
"intervalMillis":{
"shape":"HealthCheckIntervalMillis",
"documentation":"<p>The time period in milliseconds between each health check execution.</p>"
},
"path":{
"shape":"String",
"documentation":"<p>The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>"
},
"port":{
"shape":"PortNumber",
"documentation":"<p>The destination port for the health check request. This port must match the port defined in the <a>PortMapping</a> for the listener.</p>"
},
"protocol":{
"shape":"PortProtocol",
"documentation":"<p>The protocol for the health check request. If you specify <code>grpc</code>, then your service must conform to the <a href=\"https://github.com/grpc/grpc/blob/master/doc/health-checking.md\">GRPC Health Checking Protocol</a>.</p>"
},
"timeoutMillis":{
"shape":"HealthCheckTimeoutMillis",
"documentation":"<p>The amount of time to wait when receiving a response from the health check, in milliseconds.</p>"
},
"unhealthyThreshold":{
"shape":"HealthCheckThreshold",
"documentation":"<p>The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy. </p>"
}
},
"documentation":"<p>An object that represents the health check policy for a virtual node's listener.</p>"
},
"HealthCheckThreshold":{
"type":"integer",
"max":10,
"min":2
},
"HealthCheckTimeoutMillis":{
"type":"long",
"box":true,
"max":60000,
"min":2000
},
"Hostname":{"type":"string"},
"HttpGatewayRoute":{
"type":"structure",
"required":[
"action",
"match"
],
"members":{
"action":{
"shape":"HttpGatewayRouteAction",
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"match":{
"shape":"HttpGatewayRouteMatch",
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
}
},
"documentation":"<p>An object that represents an HTTP gateway route.</p>"
},
"HttpGatewayRouteAction":{
"type":"structure",
"required":["target"],
"members":{
"target":{
"shape":"GatewayRouteTarget",
"documentation":"<p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>"
}
},
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"HttpGatewayRouteMatch":{
"type":"structure",
"required":["prefix"],
"members":{
"prefix":{
"shape":"String",
"documentation":"<p>Specifies the path to match requests with. This parameter must always start with <code>/</code>, 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 <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>.</p>"
}
},
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
},
"HttpMethod":{
"type":"string",
"enum":[
"GET",
"HEAD",
"POST",
"PUT",
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
"PATCH"
]
},
"HttpRetryPolicy":{
"type":"structure",
"required":[
"maxRetries",
"perRetryTimeout"
],
"members":{
"httpRetryEvents":{
"shape":"HttpRetryPolicyEvents",
"documentation":"<p>Specify at least one of the following values.</p> <ul> <li> <p> <b>server-error</b> – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511</p> </li> <li> <p> <b>gateway-error</b> – HTTP status codes 502, 503, and 504</p> </li> <li> <p> <b>client-error</b> – HTTP status code 409</p> </li> <li> <p> <b>stream-error</b> – Retry on refused stream</p> </li> </ul>"
},
"maxRetries":{
"shape":"MaxRetries",
"documentation":"<p>The maximum number of retry attempts.</p>"
},
"perRetryTimeout":{
"shape":"Duration",
"documentation":"<p>The timeout for each retry attempt.</p>"
},
"tcpRetryEvents":{
"shape":"TcpRetryPolicyEvents",
"documentation":"<p>Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.</p>"
}
},
"documentation":"<p>An object that represents a retry policy. Specify at least one value for at least one of the types of <code>RetryEvents</code>, a value for <code>maxRetries</code>, and a value for <code>perRetryTimeout</code>.</p>"
},
"HttpRetryPolicyEvent":{
"type":"string",
"max":25,
"min":1
},
"HttpRetryPolicyEvents":{
"type":"list",
"member":{"shape":"HttpRetryPolicyEvent"},
"max":25,
"min":1
},
"HttpRoute":{
"type":"structure",
"required":[
"action",
"match"
],
"members":{
"action":{
"shape":"HttpRouteAction",
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"match":{
"shape":"HttpRouteMatch",
"documentation":"<p>An object that represents the criteria for determining a request match.</p>"
},
"retryPolicy":{
"shape":"HttpRetryPolicy",
"documentation":"<p>An object that represents a retry policy.</p>"
},
"timeout":{
"shape":"HttpTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
}
},
"documentation":"<p>An object that represents an HTTP or HTTP/2 route type.</p>"
},
"HttpRouteAction":{
"type":"structure",
"required":["weightedTargets"],
"members":{
"weightedTargets":{
"shape":"WeightedTargets",
"documentation":"<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
}
},
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"HttpRouteHeader":{
"type":"structure",
"required":["name"],
"members":{
"invert":{
"shape":"Boolean",
"documentation":"<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
},
"match":{
"shape":"HeaderMatchMethod",
"documentation":"<p>The <code>HeaderMatchMethod</code> object.</p>"
},
"name":{
"shape":"HeaderName",
"documentation":"<p>A name for the HTTP header in the client request that will be matched on.</p>"
}
},
"documentation":"<p>An object that represents the HTTP header in the request.</p>"
},
"HttpRouteHeaders":{
"type":"list",
"member":{"shape":"HttpRouteHeader"},
"max":10,
"min":1
},
"HttpRouteMatch":{
"type":"structure",
"required":["prefix"],
"members":{
"headers":{
"shape":"HttpRouteHeaders",
"documentation":"<p>An object that represents the client request headers to match on.</p>"
},
"method":{
"shape":"HttpMethod",
"documentation":"<p>The client request method to match on. Specify only one.</p>"
},
"prefix":{
"shape":"String",
"documentation":"<p>Specifies the path to match requests with. This parameter must always start with <code>/</code>, 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 <code>my-service.local</code> and you want the route to match requests to <code>my-service.local/metrics</code>, your prefix should be <code>/metrics</code>.</p>"
},
"scheme":{
"shape":"HttpScheme",
"documentation":"<p>The client request scheme to match on. Specify only one.</p>"
}
},
"documentation":"<p>An object that represents the requirements for a route to match HTTP requests for a virtual router.</p>"
},
"HttpScheme":{
"type":"string",
"enum":[
"http",
"https"
]
},
"HttpTimeout":{
"type":"structure",
"members":{
"idle":{
"shape":"Duration",
"documentation":"<p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>"
},
"perRequest":{
"shape":"Duration",
"documentation":"<p>An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.</p>"
}
},
"documentation":"<p>An object that represents types of timeouts. </p>"
},
"InternalServerErrorException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The request processing has failed because of an unknown error, exception, or failure.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true,
"retryable":{"throttling":false}
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/service-quotas.html\">Service Limits</a> in the <i>AWS App Mesh User Guide</i>.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ListGatewayRoutesInput":{
"type":"structure",
"required":[
"meshName",
"virtualGatewayName"
],
"members":{
"limit":{
"shape":"ListGatewayRoutesLimit",
"documentation":"<p>The maximum number of results returned by <code>ListGatewayRoutes</code> in paginated output. When you use this parameter, <code>ListGatewayRoutes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListGatewayRoutes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListGatewayRoutes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list gateway routes in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListGatewayRoutes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to list gateway routes in.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"ListGatewayRoutesLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListGatewayRoutesOutput":{
"type":"structure",
"required":["gatewayRoutes"],
"members":{
"gatewayRoutes":{
"shape":"GatewayRouteList",
"documentation":"<p>The list of existing gateway routes for the specified service mesh and virtual gateway.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListGatewayRoutes</code> request. When the results of a <code>ListGatewayRoutes</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListMeshesInput":{
"type":"structure",
"members":{
"limit":{
"shape":"ListMeshesLimit",
"documentation":"<p>The maximum number of results returned by <code>ListMeshes</code> in paginated output. When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListMeshes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListMeshes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListMeshes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p> <note> <p>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.</p> </note>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListMeshesLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListMeshesOutput":{
"type":"structure",
"required":["meshes"],
"members":{
"meshes":{
"shape":"MeshList",
"documentation":"<p>The list of existing service meshes.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListMeshes</code> request. When the results of a <code>ListMeshes</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListRoutesInput":{
"type":"structure",
"required":[
"meshName",
"virtualRouterName"
],
"members":{
"limit":{
"shape":"ListRoutesLimit",
"documentation":"<p>The maximum number of results returned by <code>ListRoutes</code> in paginated output. When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListRoutes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListRoutes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list routes in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRoutes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to list routes in.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListRoutesLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListRoutesOutput":{
"type":"structure",
"required":["routes"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListRoutes</code> request. When the results of a <code>ListRoutes</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"routes":{
"shape":"RouteList",
"documentation":"<p>The list of existing routes for the specified service mesh and virtual router.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListTagsForResourceInput":{
"type":"structure",
"required":["resourceArn"],
"members":{
"limit":{
"shape":"TagsLimit",
"documentation":"<p>The maximum number of tag results returned by <code>ListTagsForResource</code> in paginated output. When this parameter is used, <code>ListTagsForResource</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListTagsForResource</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListTagsForResource</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListTagsForResource</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</p>",
"location":"querystring",
"locationName":"resourceArn"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListTagsForResourceOutput":{
"type":"structure",
"required":["tags"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListTagsForResource</code> request. When the results of a <code>ListTagsForResource</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tags for the resource.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualGatewaysInput":{
"type":"structure",
"required":["meshName"],
"members":{
"limit":{
"shape":"ListVirtualGatewaysLimit",
"documentation":"<p>The maximum number of results returned by <code>ListVirtualGateways</code> in paginated output. When you use this parameter, <code>ListVirtualGateways</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualGateways</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualGateways</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list virtual gateways in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualGateways</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListVirtualGatewaysLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListVirtualGatewaysOutput":{
"type":"structure",
"required":["virtualGateways"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualGateways</code> request. When the results of a <code>ListVirtualGateways</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"virtualGateways":{
"shape":"VirtualGatewayList",
"documentation":"<p>The list of existing virtual gateways for the specified service mesh.</p>"
}
}
},
"ListVirtualNodesInput":{
"type":"structure",
"required":["meshName"],
"members":{
"limit":{
"shape":"ListVirtualNodesLimit",
"documentation":"<p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated output. When you use this parameter, <code>ListVirtualNodes</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualNodes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list virtual nodes in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualNodesLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListVirtualNodesOutput":{
"type":"structure",
"required":["virtualNodes"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualNodes</code> request. When the results of a <code>ListVirtualNodes</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"virtualNodes":{
"shape":"VirtualNodeList",
"documentation":"<p>The list of existing virtual nodes for the specified service mesh.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualRoutersInput":{
"type":"structure",
"required":["meshName"],
"members":{
"limit":{
"shape":"ListVirtualRoutersLimit",
"documentation":"<p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated output. When you use this parameter, <code>ListVirtualRouters</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualRouters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list virtual routers in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualRouters</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualRoutersLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListVirtualRoutersOutput":{
"type":"structure",
"required":["virtualRouters"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualRouters</code> request. When the results of a <code>ListVirtualRouters</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"virtualRouters":{
"shape":"VirtualRouterList",
"documentation":"<p>The list of existing virtual routers for the specified service mesh.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualServicesInput":{
"type":"structure",
"required":["meshName"],
"members":{
"limit":{
"shape":"ListVirtualServicesLimit",
"documentation":"<p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated output. When you use this parameter, <code>ListVirtualServices</code> returns only <code>limit</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListVirtualServices</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"location":"querystring",
"locationName":"limit"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to list virtual services in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListVirtualServices</code> request where <code>limit</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"ListVirtualServicesLimit":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListVirtualServicesOutput":{
"type":"structure",
"required":["virtualServices"],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualServices</code> request. When the results of a <code>ListVirtualServices</code> request exceed <code>limit</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
},
"virtualServices":{
"shape":"VirtualServiceList",
"documentation":"<p>The list of existing virtual services for the specified service mesh.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"Listener":{
"type":"structure",
"required":["portMapping"],
"members":{
"connectionPool":{
"shape":"VirtualNodeConnectionPool",
"documentation":"<p>The connection pool information for the listener.</p>"
},
"healthCheck":{
"shape":"HealthCheckPolicy",
"documentation":"<p>The health check information for the listener.</p>"
},
"outlierDetection":{
"shape":"OutlierDetection",
"documentation":"<p>The outlier detection information for the listener.</p>"
},
"portMapping":{
"shape":"PortMapping",
"documentation":"<p>The port mapping information for the listener.</p>"
},
"timeout":{
"shape":"ListenerTimeout",
"documentation":"<p>An object that represents timeouts for different protocols.</p>"
},
"tls":{
"shape":"ListenerTls",
"documentation":"<p>A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
}
},
"documentation":"<p>An object that represents a listener for a virtual node.</p>"
},
"ListenerTimeout":{
"type":"structure",
"members":{
"grpc":{"shape":"GrpcTimeout"},
"http":{
"shape":"HttpTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
},
"http2":{
"shape":"HttpTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
},
"tcp":{
"shape":"TcpTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
}
},
"documentation":"<p>An object that represents timeouts for different protocols.</p>",
"union":true
},
"ListenerTls":{
"type":"structure",
"required":[
"certificate",
"mode"
],
"members":{
"certificate":{
"shape":"ListenerTlsCertificate",
"documentation":"<p>A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.</p>"
},
"mode":{
"shape":"ListenerTlsMode",
"documentation":"<p>Specify one of the following modes.</p> <ul> <li> <p> <b/>STRICT – Listener only accepts connections with TLS enabled. </p> </li> <li> <p> <b/>PERMISSIVE – Listener accepts connections with or without TLS enabled.</p> </li> <li> <p> <b/>DISABLED – Listener only accepts connections without TLS. </p> </li> </ul>"
},
"validation":{
"shape":"ListenerTlsValidationContext",
"documentation":"<p>A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.</p>"
}
},
"documentation":"<p>An object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
},
"ListenerTlsAcmCertificate":{
"type":"structure",
"required":["certificateArn"],
"members":{
"certificateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
}
},
"documentation":"<p>An object that represents an AWS Certicate Manager (ACM) certificate.</p>"
},
"ListenerTlsCertificate":{
"type":"structure",
"members":{
"acm":{
"shape":"ListenerTlsAcmCertificate",
"documentation":"<p>A reference to an object that represents an AWS Certicate Manager (ACM) certificate.</p>"
},
"file":{
"shape":"ListenerTlsFileCertificate",
"documentation":"<p>A reference to an object that represents a local file certificate.</p>"
},
"sds":{
"shape":"ListenerTlsSdsCertificate",
"documentation":"<p>A reference to an object that represents a listener's Secret Discovery Service certificate.</p>"
}
},
"documentation":"<p>An object that represents a listener's Transport Layer Security (TLS) certificate.</p>",
"union":true
},
"ListenerTlsFileCertificate":{
"type":"structure",
"required":[
"certificateChain",
"privateKey"
],
"members":{
"certificateChain":{
"shape":"FilePath",
"documentation":"<p>The certificate chain for the certificate.</p>"
},
"privateKey":{
"shape":"FilePath",
"documentation":"<p>The private key for a certificate stored on the file system of the virtual node that the proxy is running on.</p>"
}
},
"documentation":"<p>An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
},
"ListenerTlsMode":{
"type":"string",
"enum":[
"STRICT",
"PERMISSIVE",
"DISABLED"
]
},
"ListenerTlsSdsCertificate":{
"type":"structure",
"required":["secretName"],
"members":{
"secretName":{
"shape":"SdsSecretName",
"documentation":"<p>A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.</p>"
}
},
"documentation":"<p>An object that represents the listener's Secret Discovery Service certificate. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html\">TLS documentation</a> for more info.</p>"
},
"ListenerTlsValidationContext":{
"type":"structure",
"required":["trust"],
"members":{
"subjectAlternativeNames":{
"shape":"SubjectAlternativeNames",
"documentation":"<p>A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.</p>"
},
"trust":{
"shape":"ListenerTlsValidationContextTrust",
"documentation":"<p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.</p>"
}
},
"documentation":"<p>An object that represents a listener's Transport Layer Security (TLS) validation context.</p>"
},
"ListenerTlsValidationContextTrust":{
"type":"structure",
"members":{
"file":{"shape":"TlsValidationContextFileTrust"},
"sds":{
"shape":"TlsValidationContextSdsTrust",
"documentation":"<p>A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a listener's Transport Layer Security (TLS) validation context trust.</p>",
"union":true
},
"Listeners":{
"type":"list",
"member":{"shape":"Listener"},
"max":1,
"min":0
},
"Logging":{
"type":"structure",
"members":{
"accessLog":{
"shape":"AccessLog",
"documentation":"<p>The access log configuration for a virtual node.</p>"
}
},
"documentation":"<p>An object that represents the logging information for a virtual node.</p>"
},
"Long":{
"type":"long",
"box":true
},
"MatchRange":{
"type":"structure",
"required":[
"end",
"start"
],
"members":{
"end":{
"shape":"Long",
"documentation":"<p>The end of the range.</p>"
},
"start":{
"shape":"Long",
"documentation":"<p>The start of the range.</p>"
}
},
"documentation":"<p>An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.</p>"
},
"MaxConnections":{
"type":"integer",
"min":1
},
"MaxPendingRequests":{
"type":"integer",
"min":1
},
"MaxRequests":{
"type":"integer",
"min":1
},
"MaxRetries":{
"type":"long",
"box":true,
"min":0
},
"MeshData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"spec",
"status"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh.</p>"
},
"metadata":{
"shape":"ResourceMetadata",
"documentation":"<p>The associated metadata for the service mesh.</p>"
},
"spec":{
"shape":"MeshSpec",
"documentation":"<p>The associated specification for the service mesh.</p>"
},
"status":{
"shape":"MeshStatus",
"documentation":"<p>The status of the service mesh.</p>"
}
},
"documentation":"<p>An object that represents a service mesh returned by a describe operation.</p>"
},
"MeshList":{
"type":"list",
"member":{"shape":"MeshRef"}
},
"MeshRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) of the service mesh.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
}
},
"documentation":"<p>An object that represents a service mesh returned by a list operation.</p>"
},
"MeshSpec":{
"type":"structure",
"members":{
"egressFilter":{
"shape":"EgressFilter",
"documentation":"<p>The egress filter rules for the service mesh.</p>"
}
},
"documentation":"<p>An object that represents the specification of a service mesh.</p>"
},
"MeshStatus":{
"type":"structure",
"members":{
"status":{
"shape":"MeshStatusCode",
"documentation":"<p>The current mesh status.</p>"
}
},
"documentation":"<p>An object that represents the status of a service mesh.</p>"
},
"MeshStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"MethodName":{
"type":"string",
"max":50,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The specified resource doesn't exist. Check your request syntax and try again.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"OutlierDetection":{
"type":"structure",
"required":[
"baseEjectionDuration",
"interval",
"maxEjectionPercent",
"maxServerErrors"
],
"members":{
"baseEjectionDuration":{
"shape":"Duration",
"documentation":"<p>The base amount of time for which a host is ejected.</p>"
},
"interval":{
"shape":"Duration",
"documentation":"<p>The time interval between ejection sweep analysis.</p>"
},
"maxEjectionPercent":{
"shape":"OutlierDetectionMaxEjectionPercent",
"documentation":"<p>Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.</p>"
},
"maxServerErrors":{
"shape":"OutlierDetectionMaxServerErrors",
"documentation":"<p>Number of consecutive <code>5xx</code> errors required for ejection. </p>"
}
},
"documentation":"<p>An object that represents the outlier detection for a virtual node's listener.</p>"
},
"OutlierDetectionMaxEjectionPercent":{
"type":"integer",
"box":true,
"max":100,
"min":0
},
"OutlierDetectionMaxServerErrors":{
"type":"long",
"box":true,
"min":1
},
"PercentInt":{
"type":"integer",
"max":100,
"min":0
},
"PortMapping":{
"type":"structure",
"required":[
"port",
"protocol"
],
"members":{
"port":{
"shape":"PortNumber",
"documentation":"<p>The port used for the port mapping.</p>"
},
"protocol":{
"shape":"PortProtocol",
"documentation":"<p>The protocol used for the port mapping. Specify one protocol.</p>"
}
},
"documentation":"<p>An object that represents a port mapping.</p>"
},
"PortNumber":{
"type":"integer",
"max":65535,
"min":1
},
"PortProtocol":{
"type":"string",
"enum":[
"http",
"tcp",
"http2",
"grpc"
]
},
"PortSet":{
"type":"list",
"member":{"shape":"PortNumber"}
},
"ResourceInUseException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You can't delete the specified resource because it's in use or required by another resource.</p>",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"ResourceMetadata":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshOwner",
"resourceOwner",
"uid",
"version"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the resource.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"uid":{
"shape":"String",
"documentation":"<p>The unique identifier for the resource.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
}
},
"documentation":"<p>An object that represents metadata for a resource.</p>"
},
"ResourceName":{
"type":"string",
"max":255,
"min":1
},
"RouteData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"routeName",
"spec",
"status",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the route resides in.</p>"
},
"metadata":{
"shape":"ResourceMetadata",
"documentation":"<p>The associated metadata for the route.</p>"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the route.</p>"
},
"spec":{
"shape":"RouteSpec",
"documentation":"<p>The specifications of the route.</p>"
},
"status":{
"shape":"RouteStatus",
"documentation":"<p>The status of the route.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The virtual router that the route is associated with.</p>"
}
},
"documentation":"<p>An object that represents a route returned by a describe operation.</p>"
},
"RouteList":{
"type":"list",
"member":{"shape":"RouteRef"}
},
"RoutePriority":{
"type":"integer",
"box":true,
"max":1000,
"min":0
},
"RouteRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"routeName",
"version",
"virtualRouterName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the route.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the route resides in.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the route.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The virtual router that the route is associated with.</p>"
}
},
"documentation":"<p>An object that represents a route returned by a list operation.</p>"
},
"RouteSpec":{
"type":"structure",
"members":{
"grpcRoute":{
"shape":"GrpcRoute",
"documentation":"<p>An object that represents the specification of a gRPC route.</p>"
},
"http2Route":{
"shape":"HttpRoute",
"documentation":"<p>An object that represents the specification of an HTTP/2 route.</p>"
},
"httpRoute":{
"shape":"HttpRoute",
"documentation":"<p>An object that represents the specification of an HTTP route.</p>"
},
"priority":{
"shape":"RoutePriority",
"documentation":"<p>The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.</p>"
},
"tcpRoute":{
"shape":"TcpRoute",
"documentation":"<p>An object that represents the specification of a TCP route.</p>"
}
},
"documentation":"<p>An object that represents a route specification. Specify one route type.</p>"
},
"RouteStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"RouteStatusCode",
"documentation":"<p>The current status for the route.</p>"
}
},
"documentation":"<p>An object that represents the current status of a route.</p>"
},
"RouteStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"SdsSecretName":{"type":"string"},
"ServiceDiscovery":{
"type":"structure",
"members":{
"awsCloudMap":{
"shape":"AwsCloudMapServiceDiscovery",
"documentation":"<p>Specifies any AWS Cloud Map information for the virtual node.</p>"
},
"dns":{
"shape":"DnsServiceDiscovery",
"documentation":"<p>Specifies the DNS information for the virtual node.</p>"
}
},
"documentation":"<p>An object that represents the service discovery information for a virtual node.</p>",
"union":true
},
"ServiceName":{"type":"string"},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The request has failed due to a temporary failure of the service.</p>",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true,
"retryable":{"throttling":false}
},
"String":{"type":"string"},
"SubjectAlternativeName":{
"type":"string",
"max":254,
"min":1
},
"SubjectAlternativeNameList":{
"type":"list",
"member":{"shape":"SubjectAlternativeName"}
},
"SubjectAlternativeNameMatchers":{
"type":"structure",
"required":["exact"],
"members":{
"exact":{
"shape":"SubjectAlternativeNameList",
"documentation":"<p>The values sent must match the specified values exactly.</p>"
}
},
"documentation":"<p>An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.</p>"
},
"SubjectAlternativeNames":{
"type":"structure",
"required":["match"],
"members":{
"match":{
"shape":"SubjectAlternativeNameMatchers",
"documentation":"<p>An object that represents the criteria for determining a SANs match.</p>"
}
},
"documentation":"<p>An object that represents the subject alternative names secured by the certificate.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"TagRef"},
"max":50,
"min":0
},
"TagRef":{
"type":"structure",
"required":[
"key",
"value"
],
"members":{
"key":{
"shape":"TagKey",
"documentation":"<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label that acts like a category for more specific tag values.</p>"
},
"value":{
"shape":"TagValue",
"documentation":"<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a descriptor within a tag category (key).</p>"
}
},
"documentation":"<p>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.</p>"
},
"TagResourceInput":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagList",
"documentation":"<p>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.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"TagResourceOutput":{
"type":"structure",
"members":{
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TagsLimit":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"TcpRetryPolicyEvent":{
"type":"string",
"enum":["connection-error"]
},
"TcpRetryPolicyEvents":{
"type":"list",
"member":{"shape":"TcpRetryPolicyEvent"},
"max":1,
"min":1
},
"TcpRoute":{
"type":"structure",
"required":["action"],
"members":{
"action":{
"shape":"TcpRouteAction",
"documentation":"<p>The action to take if a match is determined.</p>"
},
"timeout":{
"shape":"TcpTimeout",
"documentation":"<p>An object that represents types of timeouts. </p>"
}
},
"documentation":"<p>An object that represents a TCP route type.</p>"
},
"TcpRouteAction":{
"type":"structure",
"required":["weightedTargets"],
"members":{
"weightedTargets":{
"shape":"WeightedTargets",
"documentation":"<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
}
},
"documentation":"<p>An object that represents the action to take if a match is determined.</p>"
},
"TcpTimeout":{
"type":"structure",
"members":{
"idle":{
"shape":"Duration",
"documentation":"<p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>"
}
},
"documentation":"<p>An object that represents types of timeouts. </p>"
},
"Timestamp":{"type":"timestamp"},
"TlsValidationContext":{
"type":"structure",
"required":["trust"],
"members":{
"subjectAlternativeNames":{
"shape":"SubjectAlternativeNames",
"documentation":"<p>A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.</p>"
},
"trust":{
"shape":"TlsValidationContextTrust",
"documentation":"<p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.</p>"
}
},
"documentation":"<p>An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.</p>"
},
"TlsValidationContextAcmTrust":{
"type":"structure",
"required":["certificateAuthorityArns"],
"members":{
"certificateAuthorityArns":{
"shape":"CertificateAuthorityArns",
"documentation":"<p>One or more ACM Amazon Resource Name (ARN)s.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
},
"TlsValidationContextFileTrust":{
"type":"structure",
"required":["certificateChain"],
"members":{
"certificateChain":{
"shape":"FilePath",
"documentation":"<p>The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
},
"TlsValidationContextSdsTrust":{
"type":"structure",
"required":["secretName"],
"members":{
"secretName":{
"shape":"SdsSecretName",
"documentation":"<p>A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html\">TLS documentation</a> for more info.</p>"
},
"TlsValidationContextTrust":{
"type":"structure",
"members":{
"acm":{
"shape":"TlsValidationContextAcmTrust",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
},
"file":{
"shape":"TlsValidationContextFileTrust",
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
},
"sds":{
"shape":"TlsValidationContextSdsTrust",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust.</p>",
"union":true
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.</p>",
"error":{
"httpStatusCode":429,
"senderFault":true
},
"exception":true,
"retryable":{"throttling":true}
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The request exceeds the maximum allowed number of tags allowed per resource. The current limit is 50 user tags per resource. You must reduce the number of tags in the request. None of the tags in this request were applied.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"UntagResourceInput":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to delete tags from.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the tags to be removed.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UntagResourceOutput":{
"type":"structure",
"members":{
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateGatewayRouteInput":{
"type":"structure",
"required":[
"gatewayRouteName",
"meshName",
"spec",
"virtualGatewayName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"gatewayRouteName":{
"shape":"ResourceName",
"documentation":"<p>The name of the gateway route to update.</p>",
"location":"uri",
"locationName":"gatewayRouteName"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the gateway route resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"GatewayRouteSpec",
"documentation":"<p>The new gateway route specification to apply. This overwrites the existing data.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway that the gateway route is associated with.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"UpdateGatewayRouteOutput":{
"type":"structure",
"required":["gatewayRoute"],
"members":{
"gatewayRoute":{
"shape":"GatewayRouteData",
"documentation":"<p>A full description of the gateway route that was updated.</p>"
}
},
"payload":"gatewayRoute"
},
"UpdateMeshInput":{
"type":"structure",
"required":["meshName"],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to update.</p>",
"location":"uri",
"locationName":"meshName"
},
"spec":{
"shape":"MeshSpec",
"documentation":"<p>The service mesh specification to apply.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateMeshOutput":{
"type":"structure",
"required":["mesh"],
"members":{
"mesh":{"shape":"MeshData"}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"mesh"
},
"UpdateRouteInput":{
"type":"structure",
"required":[
"meshName",
"routeName",
"spec",
"virtualRouterName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the route resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"routeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the route to update.</p>",
"location":"uri",
"locationName":"routeName"
},
"spec":{
"shape":"RouteSpec",
"documentation":"<p>The new route specification to apply. This overwrites the existing data.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router that the route is associated with.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateRouteOutput":{
"type":"structure",
"required":["route"],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>A full description of the route that was updated.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"route"
},
"UpdateVirtualGatewayInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualGatewayName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual gateway resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualGatewaySpec",
"documentation":"<p>The new virtual gateway specification to apply. This overwrites the existing data.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway to update.</p>",
"location":"uri",
"locationName":"virtualGatewayName"
}
}
},
"UpdateVirtualGatewayOutput":{
"type":"structure",
"required":["virtualGateway"],
"members":{
"virtualGateway":{
"shape":"VirtualGatewayData",
"documentation":"<p>A full description of the virtual gateway that was updated.</p>"
}
},
"payload":"virtualGateway"
},
"UpdateVirtualNodeInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualNodeName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual node resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualNodeSpec",
"documentation":"<p>The new virtual node specification to apply. This overwrites the existing data.</p>"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node to update.</p>",
"location":"uri",
"locationName":"virtualNodeName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateVirtualNodeOutput":{
"type":"structure",
"required":["virtualNode"],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>A full description of the virtual node that was updated.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualNode"
},
"UpdateVirtualRouterInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualRouterName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual router resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualRouterSpec",
"documentation":"<p>The new virtual router specification to apply. This overwrites the existing data.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to update.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateVirtualRouterOutput":{
"type":"structure",
"required":["virtualRouter"],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>A full description of the virtual router that was updated.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualRouter"
},
"UpdateVirtualServiceInput":{
"type":"structure",
"required":[
"meshName",
"spec",
"virtualServiceName"
],
"members":{
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
"idempotencyToken":true
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual service resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
"location":"querystring",
"locationName":"meshOwner"
},
"spec":{
"shape":"VirtualServiceSpec",
"documentation":"<p>The new virtual service specification to apply. This overwrites the existing data.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service to update.</p>",
"location":"uri",
"locationName":"virtualServiceName"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>"
},
"UpdateVirtualServiceOutput":{
"type":"structure",
"required":["virtualService"],
"members":{
"virtualService":{
"shape":"VirtualServiceData",
"documentation":"<p>A full description of the virtual service that was updated.</p>"
}
},
"documentation":"<zonbook></zonbook><xhtml></xhtml>",
"payload":"virtualService"
},
"VirtualGatewayAccessLog":{
"type":"structure",
"members":{
"file":{
"shape":"VirtualGatewayFileAccessLog",
"documentation":"<p>The file object to send virtual gateway access logs to.</p>"
}
},
"documentation":"<p>The access log configuration for a virtual gateway.</p>",
"union":true
},
"VirtualGatewayBackendDefaults":{
"type":"structure",
"members":{
"clientPolicy":{
"shape":"VirtualGatewayClientPolicy",
"documentation":"<p>A reference to an object that represents a client policy.</p>"
}
},
"documentation":"<p>An object that represents the default properties for a backend.</p>"
},
"VirtualGatewayCertificateAuthorityArns":{
"type":"list",
"member":{"shape":"Arn"},
"max":3,
"min":1
},
"VirtualGatewayClientPolicy":{
"type":"structure",
"members":{
"tls":{
"shape":"VirtualGatewayClientPolicyTls",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>"
}
},
"documentation":"<p>An object that represents a client policy.</p>"
},
"VirtualGatewayClientPolicyTls":{
"type":"structure",
"required":["validation"],
"members":{
"certificate":{
"shape":"VirtualGatewayClientTlsCertificate",
"documentation":"<p>A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.</p>"
},
"enforce":{
"shape":"Boolean",
"documentation":"<p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't specified.</p>",
"box":true
},
"ports":{
"shape":"PortSet",
"documentation":"<p>One or more ports that the policy is enforced for.</p>"
},
"validation":{
"shape":"VirtualGatewayTlsValidationContext",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) validation context.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) client policy.</p>"
},
"VirtualGatewayClientTlsCertificate":{
"type":"structure",
"members":{
"file":{"shape":"VirtualGatewayListenerTlsFileCertificate"},
"sds":{
"shape":"VirtualGatewayListenerTlsSdsCertificate",
"documentation":"<p>A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.</p>"
}
},
"documentation":"<p>An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.</p>",
"union":true
},
"VirtualGatewayConnectionPool":{
"type":"structure",
"members":{
"grpc":{
"shape":"VirtualGatewayGrpcConnectionPool",
"documentation":"<p>An object that represents a type of connection pool. </p>"
},
"http":{
"shape":"VirtualGatewayHttpConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"http2":{
"shape":"VirtualGatewayHttp2ConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
}
},
"documentation":"<p>An object that represents the type of virtual gateway connection pool.</p> <p>Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.</p> <p>If not present the default value for <code>maxPendingRequests</code> is <code>2147483647</code>.</p>",
"union":true
},
"VirtualGatewayData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"spec",
"status",
"virtualGatewayName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual gateway resides in.</p>"
},
"metadata":{"shape":"ResourceMetadata"},
"spec":{
"shape":"VirtualGatewaySpec",
"documentation":"<p>The specifications of the virtual gateway.</p>"
},
"status":{
"shape":"VirtualGatewayStatus",
"documentation":"<p>The current status of the virtual gateway.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual gateway.</p>"
}
},
"documentation":"<p>An object that represents a virtual gateway returned by a describe operation.</p>"
},
"VirtualGatewayFileAccessLog":{
"type":"structure",
"required":["path"],
"members":{
"path":{
"shape":"FilePath",
"documentation":"<p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send access logs to standard out and configure your Envoy container to use a log driver, such as <code>awslogs</code>, 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.</p>"
}
},
"documentation":"<p>An object that represents an access log file.</p>"
},
"VirtualGatewayGrpcConnectionPool":{
"type":"structure",
"required":["maxRequests"],
"members":{
"maxRequests":{
"shape":"MaxRequests",
"documentation":"<p>Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.</p>"
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualGatewayHealthCheckIntervalMillis":{
"type":"long",
"box":true,
"max":300000,
"min":5000
},
"VirtualGatewayHealthCheckPolicy":{
"type":"structure",
"required":[
"healthyThreshold",
"intervalMillis",
"protocol",
"timeoutMillis",
"unhealthyThreshold"
],
"members":{
"healthyThreshold":{
"shape":"VirtualGatewayHealthCheckThreshold",
"documentation":"<p>The number of consecutive successful health checks that must occur before declaring the listener healthy.</p>"
},
"intervalMillis":{
"shape":"VirtualGatewayHealthCheckIntervalMillis",
"documentation":"<p>The time period in milliseconds between each health check execution.</p>"
},
"path":{
"shape":"String",
"documentation":"<p>The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>"
},
"port":{
"shape":"PortNumber",
"documentation":"<p>The destination port for the health check request. This port must match the port defined in the <a>PortMapping</a> for the listener.</p>"
},
"protocol":{
"shape":"VirtualGatewayPortProtocol",
"documentation":"<p>The protocol for the health check request. If you specify <code>grpc</code>, then your service must conform to the <a href=\"https://github.com/grpc/grpc/blob/master/doc/health-checking.md\">GRPC Health Checking Protocol</a>.</p>"
},
"timeoutMillis":{
"shape":"VirtualGatewayHealthCheckTimeoutMillis",
"documentation":"<p>The amount of time to wait when receiving a response from the health check, in milliseconds.</p>"
},
"unhealthyThreshold":{
"shape":"VirtualGatewayHealthCheckThreshold",
"documentation":"<p>The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.</p>"
}
},
"documentation":"<p>An object that represents the health check policy for a virtual gateway's listener.</p>"
},
"VirtualGatewayHealthCheckThreshold":{
"type":"integer",
"max":10,
"min":2
},
"VirtualGatewayHealthCheckTimeoutMillis":{
"type":"long",
"box":true,
"max":60000,
"min":2000
},
"VirtualGatewayHttp2ConnectionPool":{
"type":"structure",
"required":["maxRequests"],
"members":{
"maxRequests":{
"shape":"MaxRequests",
"documentation":"<p>Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.</p>"
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualGatewayHttpConnectionPool":{
"type":"structure",
"required":["maxConnections"],
"members":{
"maxConnections":{
"shape":"MaxConnections",
"documentation":"<p>Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.</p>"
},
"maxPendingRequests":{
"shape":"MaxPendingRequests",
"documentation":"<p>Number of overflowing requests after <code>max_connections</code> Envoy will queue to upstream cluster.</p>",
"box":true
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualGatewayList":{
"type":"list",
"member":{"shape":"VirtualGatewayRef"}
},
"VirtualGatewayListener":{
"type":"structure",
"required":["portMapping"],
"members":{
"connectionPool":{
"shape":"VirtualGatewayConnectionPool",
"documentation":"<p>The connection pool information for the virtual gateway listener.</p>"
},
"healthCheck":{
"shape":"VirtualGatewayHealthCheckPolicy",
"documentation":"<p>The health check information for the listener.</p>"
},
"portMapping":{
"shape":"VirtualGatewayPortMapping",
"documentation":"<p>The port mapping information for the listener.</p>"
},
"tls":{
"shape":"VirtualGatewayListenerTls",
"documentation":"<p>A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.</p>"
}
},
"documentation":"<p>An object that represents a listener for a virtual gateway.</p>"
},
"VirtualGatewayListenerTls":{
"type":"structure",
"required":[
"certificate",
"mode"
],
"members":{
"certificate":{
"shape":"VirtualGatewayListenerTlsCertificate",
"documentation":"<p>An object that represents a Transport Layer Security (TLS) certificate.</p>"
},
"mode":{
"shape":"VirtualGatewayListenerTlsMode",
"documentation":"<p>Specify one of the following modes.</p> <ul> <li> <p> <b/>STRICT – Listener only accepts connections with TLS enabled. </p> </li> <li> <p> <b/>PERMISSIVE – Listener accepts connections with or without TLS enabled.</p> </li> <li> <p> <b/>DISABLED – Listener only accepts connections without TLS. </p> </li> </ul>"
},
"validation":{
"shape":"VirtualGatewayListenerTlsValidationContext",
"documentation":"<p>A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.</p>"
}
},
"documentation":"<p>An object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
},
"VirtualGatewayListenerTlsAcmCertificate":{
"type":"structure",
"required":["certificateArn"],
"members":{
"certificateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
}
},
"documentation":"<p>An object that represents an AWS Certicate Manager (ACM) certificate.</p>"
},
"VirtualGatewayListenerTlsCertificate":{
"type":"structure",
"members":{
"acm":{
"shape":"VirtualGatewayListenerTlsAcmCertificate",
"documentation":"<p>A reference to an object that represents an AWS Certicate Manager (ACM) certificate.</p>"
},
"file":{
"shape":"VirtualGatewayListenerTlsFileCertificate",
"documentation":"<p>A reference to an object that represents a local file certificate.</p>"
},
"sds":{
"shape":"VirtualGatewayListenerTlsSdsCertificate",
"documentation":"<p>A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.</p>"
}
},
"documentation":"<p>An object that represents a listener's Transport Layer Security (TLS) certificate.</p>",
"union":true
},
"VirtualGatewayListenerTlsFileCertificate":{
"type":"structure",
"required":[
"certificateChain",
"privateKey"
],
"members":{
"certificateChain":{
"shape":"FilePath",
"documentation":"<p>The certificate chain for the certificate.</p>"
},
"privateKey":{
"shape":"FilePath",
"documentation":"<p>The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.</p>"
}
},
"documentation":"<p>An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
},
"VirtualGatewayListenerTlsMode":{
"type":"string",
"enum":[
"STRICT",
"PERMISSIVE",
"DISABLED"
]
},
"VirtualGatewayListenerTlsSdsCertificate":{
"type":"structure",
"required":["secretName"],
"members":{
"secretName":{
"shape":"VirtualGatewaySdsSecretName",
"documentation":"<p>A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.</p>"
}
},
"documentation":"<p>An object that represents the virtual gateway's listener's Secret Discovery Service certificate.The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html\">TLS documentation</a> for more info. </p>"
},
"VirtualGatewayListenerTlsValidationContext":{
"type":"structure",
"required":["trust"],
"members":{
"subjectAlternativeNames":{
"shape":"SubjectAlternativeNames",
"documentation":"<p>A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.</p>"
},
"trust":{
"shape":"VirtualGatewayListenerTlsValidationContextTrust",
"documentation":"<p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.</p>"
}
},
"documentation":"<p>An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.</p>"
},
"VirtualGatewayListenerTlsValidationContextTrust":{
"type":"structure",
"members":{
"file":{"shape":"VirtualGatewayTlsValidationContextFileTrust"},
"sds":{
"shape":"VirtualGatewayTlsValidationContextSdsTrust",
"documentation":"<p>A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.</p>",
"union":true
},
"VirtualGatewayListeners":{
"type":"list",
"member":{"shape":"VirtualGatewayListener"},
"max":1,
"min":0
},
"VirtualGatewayLogging":{
"type":"structure",
"members":{
"accessLog":{
"shape":"VirtualGatewayAccessLog",
"documentation":"<p>The access log configuration.</p>"
}
},
"documentation":"<p>An object that represents logging information.</p>"
},
"VirtualGatewayPortMapping":{
"type":"structure",
"required":[
"port",
"protocol"
],
"members":{
"port":{
"shape":"PortNumber",
"documentation":"<p>The port used for the port mapping. Specify one protocol.</p>"
},
"protocol":{
"shape":"VirtualGatewayPortProtocol",
"documentation":"<p>The protocol used for the port mapping.</p>"
}
},
"documentation":"<p>An object that represents a port mapping.</p>"
},
"VirtualGatewayPortProtocol":{
"type":"string",
"enum":[
"http",
"http2",
"grpc"
]
},
"VirtualGatewayRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version",
"virtualGatewayName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the resource.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the resource resides in.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualGatewayName":{
"shape":"ResourceName",
"documentation":"<p>The name of the resource.</p>"
}
},
"documentation":"<p>An object that represents a virtual gateway returned by a list operation.</p>"
},
"VirtualGatewaySdsSecretName":{"type":"string"},
"VirtualGatewaySpec":{
"type":"structure",
"required":["listeners"],
"members":{
"backendDefaults":{
"shape":"VirtualGatewayBackendDefaults",
"documentation":"<p>A reference to an object that represents the defaults for backends.</p>"
},
"listeners":{
"shape":"VirtualGatewayListeners",
"documentation":"<p>The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.</p>"
},
"logging":{"shape":"VirtualGatewayLogging"}
},
"documentation":"<p>An object that represents the specification of a service mesh resource.</p>"
},
"VirtualGatewayStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"VirtualGatewayStatusCode",
"documentation":"<p>The current status.</p>"
}
},
"documentation":"<p>An object that represents the status of the mesh resource.</p>"
},
"VirtualGatewayStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"VirtualGatewayTlsValidationContext":{
"type":"structure",
"required":["trust"],
"members":{
"subjectAlternativeNames":{
"shape":"SubjectAlternativeNames",
"documentation":"<p>A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.</p>"
},
"trust":{
"shape":"VirtualGatewayTlsValidationContextTrust",
"documentation":"<p>A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context.</p>"
},
"VirtualGatewayTlsValidationContextAcmTrust":{
"type":"structure",
"required":["certificateAuthorityArns"],
"members":{
"certificateAuthorityArns":{
"shape":"VirtualGatewayCertificateAuthorityArns",
"documentation":"<p>One or more ACM Amazon Resource Name (ARN)s.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
},
"VirtualGatewayTlsValidationContextFileTrust":{
"type":"structure",
"required":["certificateChain"],
"members":{
"certificateChain":{
"shape":"FilePath",
"documentation":"<p>The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
},
"VirtualGatewayTlsValidationContextSdsTrust":{
"type":"structure",
"required":["secretName"],
"members":{
"secretName":{
"shape":"VirtualGatewaySdsSecretName",
"documentation":"<p>A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html\">TLS documentation</a> for more info.</p>"
},
"VirtualGatewayTlsValidationContextTrust":{
"type":"structure",
"members":{
"acm":{
"shape":"VirtualGatewayTlsValidationContextAcmTrust",
"documentation":"<p>A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
},
"file":{
"shape":"VirtualGatewayTlsValidationContextFileTrust",
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
},
"sds":{
"shape":"VirtualGatewayTlsValidationContextSdsTrust",
"documentation":"<p>A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.</p>"
}
},
"documentation":"<p>An object that represents a Transport Layer Security (TLS) validation context trust.</p>",
"union":true
},
"VirtualNodeConnectionPool":{
"type":"structure",
"members":{
"grpc":{
"shape":"VirtualNodeGrpcConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"http":{
"shape":"VirtualNodeHttpConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"http2":{
"shape":"VirtualNodeHttp2ConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"tcp":{
"shape":"VirtualNodeTcpConnectionPool",
"documentation":"<p>An object that represents a type of connection pool.</p>"
}
},
"documentation":"<p>An object that represents the type of virtual node connection pool.</p> <p>Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.</p> <p>If not present the default value for <code>maxPendingRequests</code> is <code>2147483647</code>.</p> <p/>",
"union":true
},
"VirtualNodeData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"spec",
"status",
"virtualNodeName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual node resides in.</p>"
},
"metadata":{
"shape":"ResourceMetadata",
"documentation":"<p>The associated metadata for the virtual node.</p>"
},
"spec":{
"shape":"VirtualNodeSpec",
"documentation":"<p>The specifications of the virtual node.</p>"
},
"status":{
"shape":"VirtualNodeStatus",
"documentation":"<p>The current status for the virtual node.</p>"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node.</p>"
}
},
"documentation":"<p>An object that represents a virtual node returned by a describe operation.</p>"
},
"VirtualNodeGrpcConnectionPool":{
"type":"structure",
"required":["maxRequests"],
"members":{
"maxRequests":{
"shape":"MaxRequests",
"documentation":"<p>Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.</p>"
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualNodeHttp2ConnectionPool":{
"type":"structure",
"required":["maxRequests"],
"members":{
"maxRequests":{
"shape":"MaxRequests",
"documentation":"<p>Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.</p>"
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualNodeHttpConnectionPool":{
"type":"structure",
"required":["maxConnections"],
"members":{
"maxConnections":{
"shape":"MaxConnections",
"documentation":"<p>Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.</p>"
},
"maxPendingRequests":{
"shape":"MaxPendingRequests",
"documentation":"<p>Number of overflowing requests after <code>max_connections</code> Envoy will queue to upstream cluster.</p>",
"box":true
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualNodeList":{
"type":"list",
"member":{"shape":"VirtualNodeRef"}
},
"VirtualNodeRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version",
"virtualNodeName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the virtual node.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual node resides in.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node.</p>"
}
},
"documentation":"<p>An object that represents a virtual node returned by a list operation.</p>"
},
"VirtualNodeServiceProvider":{
"type":"structure",
"required":["virtualNodeName"],
"members":{
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual node that is acting as a service provider.</p>"
}
},
"documentation":"<p>An object that represents a virtual node service provider.</p>"
},
"VirtualNodeSpec":{
"type":"structure",
"members":{
"backendDefaults":{
"shape":"BackendDefaults",
"documentation":"<p>A reference to an object that represents the defaults for backends.</p>"
},
"backends":{
"shape":"Backends",
"documentation":"<p>The backends that the virtual node is expected to send outbound traffic to.</p>"
},
"listeners":{
"shape":"Listeners",
"documentation":"<p>The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.</p>"
},
"logging":{
"shape":"Logging",
"documentation":"<p>The inbound and outbound access logging information for the virtual node.</p>"
},
"serviceDiscovery":{
"shape":"ServiceDiscovery",
"documentation":"<p>The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a <code>listener</code>, then you must specify service discovery information.</p>"
}
},
"documentation":"<p>An object that represents the specification of a virtual node.</p>"
},
"VirtualNodeStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"VirtualNodeStatusCode",
"documentation":"<p>The current status of the virtual node.</p>"
}
},
"documentation":"<p>An object that represents the current status of the virtual node.</p>"
},
"VirtualNodeStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"VirtualNodeTcpConnectionPool":{
"type":"structure",
"required":["maxConnections"],
"members":{
"maxConnections":{
"shape":"MaxConnections",
"documentation":"<p>Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.</p>"
}
},
"documentation":"<p>An object that represents a type of connection pool.</p>"
},
"VirtualRouterData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"spec",
"status",
"virtualRouterName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual router resides in.</p>"
},
"metadata":{
"shape":"ResourceMetadata",
"documentation":"<p>The associated metadata for the virtual router.</p>"
},
"spec":{
"shape":"VirtualRouterSpec",
"documentation":"<p>The specifications of the virtual router.</p>"
},
"status":{
"shape":"VirtualRouterStatus",
"documentation":"<p>The current status of the virtual router.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router.</p>"
}
},
"documentation":"<p>An object that represents a virtual router returned by a describe operation.</p>"
},
"VirtualRouterList":{
"type":"list",
"member":{"shape":"VirtualRouterRef"}
},
"VirtualRouterListener":{
"type":"structure",
"required":["portMapping"],
"members":{
"portMapping":{"shape":"PortMapping"}
},
"documentation":"<p>An object that represents a virtual router listener.</p>"
},
"VirtualRouterListeners":{
"type":"list",
"member":{"shape":"VirtualRouterListener"},
"max":1,
"min":1
},
"VirtualRouterRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version",
"virtualRouterName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the virtual router.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual router resides in.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router.</p>"
}
},
"documentation":"<p>An object that represents a virtual router returned by a list operation.</p>"
},
"VirtualRouterServiceProvider":{
"type":"structure",
"required":["virtualRouterName"],
"members":{
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router that is acting as a service provider.</p>"
}
},
"documentation":"<p>An object that represents a virtual node service provider.</p>"
},
"VirtualRouterSpec":{
"type":"structure",
"members":{
"listeners":{
"shape":"VirtualRouterListeners",
"documentation":"<p>The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.</p>"
}
},
"documentation":"<p>An object that represents the specification of a virtual router.</p>"
},
"VirtualRouterStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"VirtualRouterStatusCode",
"documentation":"<p>The current status of the virtual router.</p>"
}
},
"documentation":"<p>An object that represents the status of a virtual router. </p>"
},
"VirtualRouterStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"VirtualServiceBackend":{
"type":"structure",
"required":["virtualServiceName"],
"members":{
"clientPolicy":{
"shape":"ClientPolicy",
"documentation":"<p>A reference to an object that represents the client policy for a backend.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service that is acting as a virtual node backend.</p>"
}
},
"documentation":"<p>An object that represents a virtual service backend for a virtual node.</p>"
},
"VirtualServiceData":{
"type":"structure",
"required":[
"meshName",
"metadata",
"spec",
"status",
"virtualServiceName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual service resides in.</p>"
},
"metadata":{"shape":"ResourceMetadata"},
"spec":{
"shape":"VirtualServiceSpec",
"documentation":"<p>The specifications of the virtual service.</p>"
},
"status":{
"shape":"VirtualServiceStatus",
"documentation":"<p>The current status of the virtual service.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service.</p>"
}
},
"documentation":"<p>An object that represents a virtual service returned by a describe operation.</p>"
},
"VirtualServiceList":{
"type":"list",
"member":{"shape":"VirtualServiceRef"}
},
"VirtualServiceProvider":{
"type":"structure",
"members":{
"virtualNode":{
"shape":"VirtualNodeServiceProvider",
"documentation":"<p>The virtual node associated with a virtual service.</p>"
},
"virtualRouter":{
"shape":"VirtualRouterServiceProvider",
"documentation":"<p>The virtual router associated with a virtual service.</p>"
}
},
"documentation":"<p>An object that represents the provider for a virtual service.</p>",
"union":true
},
"VirtualServiceRef":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"meshName",
"meshOwner",
"resourceOwner",
"version",
"virtualServiceName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) for the virtual service.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
},
"lastUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh that the virtual service resides in.</p>"
},
"meshOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"resourceOwner":{
"shape":"AccountId",
"documentation":"<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
},
"version":{
"shape":"Long",
"documentation":"<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service.</p>"
}
},
"documentation":"<p>An object that represents a virtual service returned by a list operation.</p>"
},
"VirtualServiceSpec":{
"type":"structure",
"members":{
"provider":{
"shape":"VirtualServiceProvider",
"documentation":"<p>The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.</p>"
}
},
"documentation":"<p>An object that represents the specification of a virtual service.</p>"
},
"VirtualServiceStatus":{
"type":"structure",
"required":["status"],
"members":{
"status":{
"shape":"VirtualServiceStatusCode",
"documentation":"<p>The current status of the virtual service.</p>"
}
},
"documentation":"<p>An object that represents the status of a virtual service.</p>"
},
"VirtualServiceStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"INACTIVE",
"DELETED"
]
},
"WeightedTarget":{
"type":"structure",
"required":[
"virtualNode",
"weight"
],
"members":{
"virtualNode":{
"shape":"ResourceName",
"documentation":"<p>The virtual node to associate with the weighted target.</p>"
},
"weight":{
"shape":"PercentInt",
"documentation":"<p>The relative weight of the weighted target.</p>"
}
},
"documentation":"<p>An object that represents 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. The total weight for all targets combined must be less than or equal to 100.</p>"
},
"WeightedTargets":{
"type":"list",
"member":{"shape":"WeightedTarget"},
"max":10,
"min":1
}
},
"documentation":"<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.</p> <p>App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, and Amazon EC2.</p> <note> <p>App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes <code>kube-dns</code> and <code>coredns</code> are supported. For more information, see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS for Services and Pods</a> in the Kubernetes documentation.</p> </note>"
}
Reference in a new issue View git blame Copy permalink