"documentation":"<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.</p>\n <p>App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on AWS, and Amazon EC2.</p>\n <note>\n <p>App Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes <code>kube-dns</code> and\n <code>coredns</code> are supported. For more information, see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS\n for Services and Pods</a> in the Kubernetes documentation.</p>\n </note>",
"operations":{
"CreateMesh":{
"name":"CreateMesh",
"http":{
"method":"PUT",
"requestUri":"/v20190125/meshes",
"responseCode":200
},
"input":{
"shape":"CreateMeshInput"
},
"output":{
"shape":"CreateMeshOutput"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ConflictException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"LimitExceededException"
},
{
"shape":"NotFoundException"
},
{
"shape":"ServiceUnavailableException"
},
{
"shape":"TooManyRequestsException"
}
],
"documentation":"<p>Creates a service mesh. A service mesh is a logical boundary for network traffic between\n the services that reside within it.</p>\n <p>After you create your service mesh, you can create virtual services, virtual nodes,\n virtual routers, and routes to distribute traffic between the applications in your\n mesh.</p>",
"documentation":"<p>Creates a route that is associated with a virtual router.</p>\n <p>You can use the <code>prefix</code> parameter in your route specification for path-based\n routing of requests. For example, if your virtual service name is\n <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>\n <p>If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.</p>",
"documentation":"<p>Creates a virtual node within a service mesh.</p>\n <p>A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group.</p>\n <p>Any inbound traffic that your virtual node expects should be specified as a\n <code>listener</code>. Any outbound traffic that your virtual node expects to reach\n should be specified as a <code>backend</code>.</p>\n <p>The response metadata for your new virtual node contains the <code>arn</code> that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the\n <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p>\n <note>\n <p>If you require your Envoy stats or tracing to use a different name, you can override\n the <code>node.cluster</code> value that is set by\n <code>APPMESH_VIRTUAL_NODE_NAME</code> with the\n <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable.</p>\n </note>",
"documentation":"<p>Creates a virtual router within a service mesh.</p>\n <p>Any inbound traffic that your virtual router expects should be specified as a\n <code>listener</code>. </p>\n <p>Virtual routers handle traffic for one or more virtual services within your mesh. After\n you create your virtual router, create and associate routes for your virtual router that\n direct incoming requests to different virtual nodes.</p>",
"documentation":"<p>Creates a virtual service within a service mesh.</p>\n <p>A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its <code>virtualServiceName</code>, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.</p>",
"idempotent":true
},
"DeleteMesh":{
"name":"DeleteMesh",
"http":{
"method":"DELETE",
"requestUri":"/v20190125/meshes/{meshName}",
"responseCode":200
},
"input":{
"shape":"DeleteMeshInput"
},
"output":{
"shape":"DeleteMeshOutput"
},
"errors":[
{
"shape":"BadRequestException"
},
{
"shape":"ForbiddenException"
},
{
"shape":"InternalServerErrorException"
},
{
"shape":"NotFoundException"
},
{
"shape":"ResourceInUseException"
},
{
"shape":"ServiceUnavailableException"
},
{
"shape":"TooManyRequestsException"
}
],
"documentation":"<p>Deletes an existing service mesh.</p>\n <p>You must delete all resources (virtual services, routes, virtual routers, and virtual\n nodes) in the service mesh before you can delete the mesh itself.</p>",
"documentation":"<p>Deletes an existing virtual node.</p>\n <p>You must delete any virtual services that list a virtual node as a service provider\n before you can delete the virtual node itself.</p>",
"documentation":"<p>Deletes an existing virtual router.</p>\n <p>You must delete any routes associated with the virtual router before you can delete the\n router itself.</p>",
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.</p>",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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"
},
"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":""
},
"DeleteMeshInput":{
"type":"structure",
"required":[
"meshName"
],
"members":{
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh to delete.</p>",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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"
},
"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\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name to use for the virtual service.</p>"
}
},
"documentation":""
},
"VirtualRouterStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"DELETED",
"INACTIVE"
]
},
"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\nrequest. 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"
},
"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>",
"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>\n <ul>\n <li>\n <p>\n <b>server-error</b> – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511</p>\n </li>\n <li>\n <p>\n <b>gateway-error</b> – HTTP status codes 502,\n 503, and 504</p>\n </li>\n <li>\n <p>\n <b>client-error</b> – HTTP status code 409</p>\n </li>\n <li>\n <p>\n <b>stream-error</b> – Retry on refused\n stream</p>\n </li>\n </ul>"
},
"maxRetries":{
"shape":"MaxRetries",
"documentation":"<p>The maximum number of retry attempts.</p>"
},
"perRetryTimeout":{
"shape":"Duration",
"documentation":"<p>An object that represents a duration of time.</p>"
},
"tcpRetryEvents":{
"shape":"TcpRetryPolicyEvents",
"documentation":"<p>Specify a valid value.</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>"
"documentation":"<p>The maximum number of tag results returned by <code>ListTagsForResource</code> in\n paginated output. When this parameter is used, <code>ListTagsForResource</code> returns\n only <code>limit</code> results in a single page along with a <code>nextToken</code>\n response element. You can see the remaining results of the initial request by sending\n another <code>ListTagsForResource</code> request with the returned <code>nextToken</code>\n value. This value can be between 1 and 100. If you don't use\n this parameter, <code>ListTagsForResource</code> returns up to 100\n 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\n <code>ListTagsForResource</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n 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":""
},
"CreateVirtualNodeOutput":{
"type":"structure",
"required":[
"virtualNode"
],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>The full description of your virtual node following the create call.</p>"
}
},
"documentation":"",
"payload":"virtualNode"
},
"Logging":{
"type":"structure",
"members":{
"accessLog":{
"shape":"AccessLog",
"documentation":"<p>The access log configuration for a virtual node.</p>"
"documentation":"<p>The request has failed due to a temporary failure of the service.</p>",
"exception":true,
"error":{
"code":"ServiceUnavailableException",
"httpStatusCode":503,
"fault":true
}
},
"Long":{
"type":"long",
"box":true
},
"UpdateVirtualRouterOutput":{
"type":"structure",
"required":[
"virtualRouter"
],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>A full description of the virtual router that was updated.</p>"
}
},
"documentation":"",
"payload":"virtualRouter"
},
"DescribeMeshOutput":{
"type":"structure",
"required":[
"mesh"
],
"members":{
"mesh":{
"shape":"MeshData",
"documentation":"<p>The full description of your service mesh.</p>"
}
},
"documentation":"",
"payload":"mesh"
},
"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"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to delete.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":""
},
"ListVirtualRoutersOutput":{
"type":"structure",
"required":[
"virtualRouters"
],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualRouters</code>\n request. When the results of a <code>ListVirtualRouters</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n 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":""
},
"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"
},
"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":""
},
"DeleteRouteOutput":{
"type":"structure",
"required":[
"route"
],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The route that was deleted.</p>"
}
},
"documentation":"",
"payload":"route"
},
"ResourceMetadata":{
"type":"structure",
"required":[
"arn",
"createdAt",
"lastUpdatedAt",
"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>"
},
"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\n incremented each time that they're updated.</p>"
"documentation":"<p>A full description of the virtual node that was updated.</p>"
}
},
"documentation":"",
"payload":"virtualNode"
},
"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.\n When the results of a <code>ListRoutes</code> request exceed <code>limit</code>, you can\n use this value to retrieve the next page of results. This value is <code>null</code> when\n 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":""
},
"VirtualServiceBackend":{
"type":"structure",
"required":[
"virtualServiceName"
],
"members":{
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service that is acting as a virtual node backend.</p>"
"documentation":"<p>The request syntax was malformed. Check your request syntax and try again.</p>",
"exception":true,
"error":{
"code":"BadRequestException",
"httpStatusCode":400,
"senderFault":true
}
},
"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\nrequest. 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"
},
"spec":{
"shape":"VirtualServiceSpec",
"documentation":"<p>The new virtual service specification to apply. This overwrites the existing\n data.</p>"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service to update.</p>",
"location":"uri",
"locationName":"virtualServiceName"
}
},
"documentation":""
},
"HealthCheckThreshold":{
"type":"integer",
"min":2,
"max":10
},
"UpdateRouteOutput":{
"type":"structure",
"required":[
"route"
],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>A full description of the route that was updated.</p>"
"documentation":"<p>The maximum number of results returned by <code>ListRoutes</code> in paginated output.\n When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListRoutes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListRoutes</code> returns up to 100 results and a\n <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"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListRoutes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n 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":""
},
"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\n 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 is required only if the\n specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.</p>"
},
"port":{
"shape":"PortNumber",
"documentation":"<p>The destination port for the health check request. This port must match the port defined\n in the <a>PortMapping</a> for the listener.</p>"
},
"protocol":{
"shape":"PortProtocol",
"documentation":"<p>The protocol for the health check request.</p>"
},
"timeoutMillis":{
"shape":"HealthCheckTimeoutMillis",
"documentation":"<p>The amount of time to wait when receiving a response from the health check, in\n milliseconds.</p>"
},
"unhealthyThreshold":{
"shape":"HealthCheckThreshold",
"documentation":"<p>The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy. </p>"
"documentation":"<p>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows\n egress only from virtual nodes to other defined resources in the service mesh (and any\n traffic to <code>*.amazonaws.com</code> for AWS API calls). You can set the egress filter\n type to <code>ALLOW_ALL</code> to allow egress to any endpoint inside or outside of the\n service mesh.</p>"
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
"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_limits.html\">Service\n Limits</a> in the <i>AWS App Mesh User Guide</i>.</p>",
"exception":true,
"error":{
"code":"LimitExceededException",
"httpStatusCode":400,
"senderFault":true
}
},
"UpdateMeshOutput":{
"type":"structure",
"required":[
"mesh"
],
"members":{
"mesh":{
"shape":"MeshData"
}
},
"documentation":"",
"payload":"mesh"
},
"CreateRouteOutput":{
"type":"structure",
"required":[
"route"
],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The full description of your mesh following the create call.</p>"
"documentation":"<p>The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
"documentation":"<p>The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
"documentation":"<p>The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.</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>"
"documentation":"<p>The maximum number of results returned by <code>ListMeshes</code> in paginated output.\n When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListMeshes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListMeshes</code> returns up to 100 results and a\n <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\n <code>ListMeshes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p> \n <note>\n <p>This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.</p>\n </note>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":""
},
"Arn":{
"type":"string"
},
"TcpRoute":{
"type":"structure",
"required":[
"action"
],
"members":{
"action":{
"shape":"TcpRouteAction",
"documentation":"<p>The action to take if a match is determined.</p>"
"documentation":"<p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated\n output. When you use this parameter, <code>ListVirtualRouters</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualRouters</code> returns up to 100 results and\n 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"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualRouters</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":""
},
"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>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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":"<p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated\n output. When you use this parameter, <code>ListVirtualServices</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualServices</code> returns up to 100 results and\n 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"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualServices</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":""
},
"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\nrequest. 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"
},
"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\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the virtual router.</p>"
}
},
"documentation":""
},
"AccessLog":{
"type":"structure",
"members":{
"file":{
"shape":"FileAccessLog",
"documentation":"<p>The file object to send virtual node access logs to.</p>"
"documentation":"<p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated\n output. When you use this parameter, <code>ListVirtualNodes</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualNodes</code> returns up to 100 results and a\n <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"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":""
},
"DescribeVirtualRouterOutput":{
"type":"structure",
"required":[
"virtualRouter"
],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The full description of your virtual router.</p>"
}
},
"documentation":"",
"payload":"virtualRouter"
},
"CreateMeshOutput":{
"type":"structure",
"required":[
"mesh"
],
"members":{
"mesh":{
"shape":"MeshData",
"documentation":"<p>The full description of your service mesh following the create call.</p>"
}
},
"documentation":"",
"payload":"mesh"
},
"CreateVirtualRouterOutput":{
"type":"structure",
"required":[
"virtualRouter"
],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The full description of your virtual router following the create call.</p>"
}
},
"documentation":"",
"payload":"virtualRouter"
},
"VirtualServiceStatus":{
"type":"structure",
"required":[
"status"
],
"members":{
"status":{
"shape":"VirtualServiceStatusCode",
"documentation":"<p>The current status of the virtual service.</p>"
"documentation":"<p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.</p>",
"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\n expect ingress traffic, you can omit this parameter.</p>"
"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.\n When the results of a <code>ListMeshes</code> request exceed <code>limit</code>, you can\n use this value to retrieve the next page of results. This value is <code>null</code> when\n there are no more results to return.</p>"
"documentation":"<p>The request contains a client token that was used for a previous update resource call\n with different specifications. Try the request again with a new client token.</p>",
"exception":true,
"error":{
"code":"ConflictException",
"httpStatusCode":409,
"senderFault":true
}
},
"DescribeRouteOutput":{
"type":"structure",
"required":[
"route"
],
"members":{
"route":{
"shape":"RouteData",
"documentation":"<p>The full description of your route.</p>"
"documentation":"<p>Specifies the path to match requests with. This parameter must always start with\n <code>/</code>, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>"
"documentation":"<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label\n 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\n descriptor within a tag category (key).</p>"
}
},
"documentation":"<p>Optional metadata that you apply to a resource to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
},
"MeshRef":{
"type":"structure",
"required":[
"arn",
"meshName"
],
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The full Amazon Resource Name (ARN) of the service mesh.</p>"
},
"meshName":{
"shape":"ResourceName",
"documentation":"<p>The name of the service mesh.</p>"
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListVirtualServices</code>\n request. When the results of a <code>ListVirtualServices</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n 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":"<p>An object that represents a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10. The total weight for all targets combined must be less than or equal to 100.</p>"
"documentation":"<p>Specify at least one of the following values.</p>\n <ul>\n <li>\n <p>\n <b>server-error</b> – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511</p>\n </li>\n <li>\n <p>\n <b>gateway-error</b> – HTTP status codes 502,\n 503, and 504</p>\n </li>\n <li>\n <p>\n <b>client-error</b> – HTTP status code 409</p>\n </li>\n <li>\n <p>\n <b>stream-error</b> – Retry on refused\n stream</p>\n </li>\n </ul>"
"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>"
"documentation":"<p>The name of the service mesh that the virtual router resides in.</p>",
"location":"uri",
"locationName":"meshName"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router to describe.</p>",
"location":"uri",
"locationName":"virtualRouterName"
}
},
"documentation":""
},
"TagResourceOutput":{
"type":"structure",
"members":{},
"documentation":""
},
"RouteList":{
"type":"list",
"member":{
"shape":"RouteRef"
}
},
"ForbiddenException":{
"type":"structure",
"members":{
"message":{
"shape":"String"
}
},
"documentation":"<p>You don't have permissions to perform this action.</p>",
"exception":true,
"error":{
"code":"ForbiddenException",
"httpStatusCode":403,
"senderFault":true
}
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{
"shape":"String"
}
},
"documentation":"<p>The request exceeds the maximum allowed number of tags allowed per resource. The current\n limit is 50 user tags per resource. You must reduce the number of tags in the request. None\n of the tags in this request were applied.</p>",
"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.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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"
},
"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\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
},
"virtualRouterName":{
"shape":"ResourceName",
"documentation":"<p>The name of the virtual router in which to create the route.</p>",
"documentation":"<p>A string map that contains attributes with values that you can use to filter instances\n by any custom attribute that you specified when you registered the instance. Only instances\n 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>A full description of the virtual service that was updated.</p>"
}
},
"documentation":"",
"payload":"virtualService"
},
"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\nrequest. 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"
},
"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>",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. 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"
},
"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\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
},
"virtualNodeName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for the virtual node.</p>"
}
},
"documentation":""
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{
"shape":"String"
}
},
"documentation":"<p>The specified resource doesn't exist. Check your request syntax and try again.</p>",
"documentation":"<p>The full description of your virtual service following the create call.</p>"
}
},
"documentation":"",
"payload":"virtualService"
},
"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\n access logs to standard out and configure your Envoy container to use a log driver, such as\n <code>awslogs</code>, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.</p>\n <note>\n <p>The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.</p>\n </note>"
"documentation":"<p>The name of the service mesh to delete the virtual service in.</p>",
"location":"uri",
"locationName":"meshName"
},
"virtualServiceName":{
"shape":"ServiceName",
"documentation":"<p>The name of the virtual service to delete.</p>",
"location":"uri",
"locationName":"virtualServiceName"
}
},
"documentation":""
},
"ListTagsForResourceOutput":{
"type":"structure",
"required":[
"tags"
],
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListTagsForResource</code>\n request. When the results of a <code>ListTagsForResource</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n 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":""
},
"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>The <code>nextToken</code> value to include in a future <code>ListVirtualNodes</code>\n request. When the results of a <code>ListVirtualNodes</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n 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":""
},
"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":""
},
"DeleteVirtualRouterOutput":{
"type":"structure",
"required":[
"virtualRouter"
],
"members":{
"virtualRouter":{
"shape":"VirtualRouterData",
"documentation":"<p>The virtual router that was deleted.</p>"
}
},
"documentation":"",
"payload":"virtualRouter"
},
"TagsLimit":{
"type":"integer",
"box":true,
"min":1,
"max":50
},
"TagKey":{
"type":"string",
"min":1,
"max":128
},
"VirtualServiceStatusCode":{
"type":"string",
"enum":[
"ACTIVE",
"DELETED",
"INACTIVE"
]
},
"DeleteVirtualNodeOutput":{
"type":"structure",
"required":[
"virtualNode"
],
"members":{
"virtualNode":{
"shape":"VirtualNodeData",
"documentation":"<p>The virtual node that was deleted.</p>"