openapi: 3.0.0 info: version: 2019-01-25 x-release: v4 title: AWS App Mesh Meshes API description:

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.

App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.

App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: appmesh x-aws-signingName: appmesh x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/appmesh-2019-01-25.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://appmesh.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Mesh multi-region endpoint - url: https://appmesh.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS App Mesh multi-region endpoint - url: http://appmesh.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Mesh endpoint for China (Beijing) and China (Ningxia) - url: https://appmesh.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS App Mesh endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Meshes paths: /v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateGatewayRoute description:

Creates a gateway route.

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.

For more information about gateway routes, see Gateway routes.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateGatewayRouteOutput' examples: CreateGatewayRoute200Example: summary: Default CreateGatewayRoute 200 response x-microcks-default: true value: gatewayRoute: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateGatewayRoute480Example: summary: Default CreateGatewayRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateGatewayRoute481Example: summary: Default CreateGatewayRoute 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateGatewayRoute482Example: summary: Default CreateGatewayRoute 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateGatewayRoute483Example: summary: Default CreateGatewayRoute 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateGatewayRoute484Example: summary: Default CreateGatewayRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateGatewayRoute485Example: summary: Default CreateGatewayRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateGatewayRoute486Example: summary: Default CreateGatewayRoute 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateGatewayRoute487Example: summary: Default CreateGatewayRoute 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the gateway route in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: 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. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - gatewayRouteName - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string gatewayRouteName: description: The name to use for the gateway route. type: string minLength: 1 maxLength: 255 spec: description: An object that represents a gateway route specification. Specify one gateway route type. type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcGatewayRoute' - description: An object that represents the specification of a gRPC gateway route. http2Route: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP/2 gateway route. httpRoute: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP gateway route. priority: allOf: - $ref: '#/components/schemas/GatewayRoutePriority' - description: The ordering of the gateway routes spec. tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 examples: CreateGatewayRouteRequestExample: summary: Default CreateGatewayRoute request x-microcks-default: true value: clientToken: example-value gatewayRouteName: my-resource-01 spec: grpcRoute: example-value http2Route: example-value httpRoute: example-value priority: example-value tags: - example-value summary: AWS App Mesh Create Gateway Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListGatewayRoutes description: Returns a list of existing gateway routes that are associated to a virtual gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListGatewayRoutesOutput' examples: ListGatewayRoutes200Example: summary: Default ListGatewayRoutes 200 response x-microcks-default: true value: gatewayRoutes: example-value nextToken: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListGatewayRoutes480Example: summary: Default ListGatewayRoutes 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListGatewayRoutes481Example: summary: Default ListGatewayRoutes 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListGatewayRoutes482Example: summary: Default ListGatewayRoutes 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListGatewayRoutes483Example: summary: Default ListGatewayRoutes 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListGatewayRoutes484Example: summary: Default ListGatewayRoutes 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListGatewayRoutes485Example: summary: Default ListGatewayRoutes 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list gateway routes in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string - name: virtualGatewayName in: path required: true description: The name of the virtual gateway to list gateway routes in. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh List Gateway Routes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateMesh description:

Creates a service mesh.

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.

For more information about service meshes, see Service meshes.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMeshOutput' examples: CreateMesh200Example: summary: Default CreateMesh 200 response x-microcks-default: true value: mesh: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateMesh480Example: summary: Default CreateMesh 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateMesh481Example: summary: Default CreateMesh 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateMesh482Example: summary: Default CreateMesh 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateMesh483Example: summary: Default CreateMesh 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateMesh484Example: summary: Default CreateMesh 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateMesh485Example: summary: Default CreateMesh 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateMesh486Example: summary: Default CreateMesh 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateMesh487Example: summary: Default CreateMesh 487 response x-microcks-default: true value: example parameters: [] requestBody: required: true content: application/json: schema: type: object required: - meshName properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string meshName: description: The name to use for the service mesh. type: string minLength: 1 maxLength: 255 spec: description: An object that represents the specification of a service mesh. type: object properties: egressFilter: allOf: - $ref: '#/components/schemas/EgressFilter' - description: The egress filter rules for the service mesh. serviceDiscovery: $ref: '#/components/schemas/MeshServiceDiscovery' tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 examples: CreateMeshRequestExample: summary: Default CreateMesh request x-microcks-default: true value: clientToken: example-value meshName: my-resource-01 spec: egressFilter: example-value serviceDiscovery: example-value tags: - example-value summary: AWS App Mesh Create Mesh x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListMeshes description: Returns a list of existing service meshes. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMeshesOutput' examples: ListMeshes200Example: summary: Default ListMeshes 200 response x-microcks-default: true value: meshes: example-value nextToken: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListMeshes480Example: summary: Default ListMeshes 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListMeshes481Example: summary: Default ListMeshes 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListMeshes482Example: summary: Default ListMeshes 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListMeshes483Example: summary: Default ListMeshes 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListMeshes484Example: summary: Default ListMeshes 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListMeshes485Example: summary: Default ListMeshes 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description:

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

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.

schema: type: string summary: AWS App Mesh List Meshes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateRoute description:

Creates a route that is associated with a virtual router.

You can route several different protocols and define a retry policy for a route. Traffic can be routed to one or more virtual nodes.

For more information about routes, see Routes.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateRouteOutput' examples: CreateRoute200Example: summary: Default CreateRoute 200 response x-microcks-default: true value: route: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateRoute480Example: summary: Default CreateRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateRoute481Example: summary: Default CreateRoute 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateRoute482Example: summary: Default CreateRoute 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateRoute483Example: summary: Default CreateRoute 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateRoute484Example: summary: Default CreateRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateRoute485Example: summary: Default CreateRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateRoute486Example: summary: Default CreateRoute 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateRoute487Example: summary: Default CreateRoute 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the route in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualRouterName in: path required: true description: 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. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - routeName - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string routeName: description: The name to use for the route. type: string minLength: 1 maxLength: 255 spec: description: An object that represents a route specification. Specify one route type. type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcRoute' - description: An object that represents the specification of a gRPC route. http2Route: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP/2 route. httpRoute: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP route. priority: allOf: - $ref: '#/components/schemas/RoutePriority' - description: The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority. tcpRoute: allOf: - $ref: '#/components/schemas/TcpRoute' - description: An object that represents the specification of a TCP route. tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 examples: CreateRouteRequestExample: summary: Default CreateRoute request x-microcks-default: true value: clientToken: example-value routeName: my-resource-01 spec: grpcRoute: example-value http2Route: example-value httpRoute: example-value priority: example-value tcpRoute: example-value tags: - example-value summary: AWS App Mesh Create Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListRoutes description: Returns a list of existing routes in a service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListRoutesOutput' examples: ListRoutes200Example: summary: Default ListRoutes 200 response x-microcks-default: true value: nextToken: example-value routes: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListRoutes480Example: summary: Default ListRoutes 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListRoutes481Example: summary: Default ListRoutes 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListRoutes482Example: summary: Default ListRoutes 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListRoutes483Example: summary: Default ListRoutes 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListRoutes484Example: summary: Default ListRoutes 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListRoutes485Example: summary: Default ListRoutes 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list routes in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string - name: virtualRouterName in: path required: true description: The name of the virtual router to list routes in. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh List Routes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualGateways: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateVirtualGateway description:

Creates a virtual gateway.

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.

For more information about virtual gateways, see Virtual gateways.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVirtualGatewayOutput' examples: CreateVirtualGateway200Example: summary: Default CreateVirtualGateway 200 response x-microcks-default: true value: virtualGateway: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateVirtualGateway480Example: summary: Default CreateVirtualGateway 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateVirtualGateway481Example: summary: Default CreateVirtualGateway 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateVirtualGateway482Example: summary: Default CreateVirtualGateway 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateVirtualGateway483Example: summary: Default CreateVirtualGateway 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateVirtualGateway484Example: summary: Default CreateVirtualGateway 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateVirtualGateway485Example: summary: Default CreateVirtualGateway 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateVirtualGateway486Example: summary: Default CreateVirtualGateway 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateVirtualGateway487Example: summary: Default CreateVirtualGateway 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the virtual gateway in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 requestBody: required: true content: application/json: schema: type: object required: - spec - virtualGatewayName properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a service mesh resource. type: object properties: backendDefaults: allOf: - $ref: '#/components/schemas/VirtualGatewayBackendDefaults' - description: A reference to an object that represents the defaults for backends. listeners: allOf: - $ref: '#/components/schemas/VirtualGatewayListeners' - description: The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener. logging: $ref: '#/components/schemas/VirtualGatewayLogging' tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 virtualGatewayName: description: The name to use for the virtual gateway. type: string minLength: 1 maxLength: 255 examples: CreateVirtualGatewayRequestExample: summary: Default CreateVirtualGateway request x-microcks-default: true value: clientToken: example-value spec: backendDefaults: example-value listeners: example-value logging: example-value tags: - example-value virtualGatewayName: my-resource-01 summary: AWS App Mesh Create Virtual Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListVirtualGateways description: Returns a list of existing virtual gateways in a service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVirtualGatewaysOutput' examples: ListVirtualGateways200Example: summary: Default ListVirtualGateways 200 response x-microcks-default: true value: nextToken: example-value virtualGateways: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListVirtualGateways480Example: summary: Default ListVirtualGateways 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListVirtualGateways481Example: summary: Default ListVirtualGateways 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListVirtualGateways482Example: summary: Default ListVirtualGateways 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListVirtualGateways483Example: summary: Default ListVirtualGateways 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListVirtualGateways484Example: summary: Default ListVirtualGateways 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListVirtualGateways485Example: summary: Default ListVirtualGateways 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list virtual gateways in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string summary: AWS App Mesh List Virtual Gateways x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualNodes: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateVirtualNode description:

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).

You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend.

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.

For more information about virtual nodes, see Virtual nodes. You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the App Mesh User Guide.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVirtualNodeOutput' examples: CreateVirtualNode200Example: summary: Default CreateVirtualNode 200 response x-microcks-default: true value: virtualNode: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateVirtualNode480Example: summary: Default CreateVirtualNode 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateVirtualNode481Example: summary: Default CreateVirtualNode 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateVirtualNode482Example: summary: Default CreateVirtualNode 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateVirtualNode483Example: summary: Default CreateVirtualNode 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateVirtualNode484Example: summary: Default CreateVirtualNode 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateVirtualNode485Example: summary: Default CreateVirtualNode 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateVirtualNode486Example: summary: Default CreateVirtualNode 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateVirtualNode487Example: summary: Default CreateVirtualNode 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the virtual node in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 requestBody: required: true content: application/json: schema: type: object required: - spec - virtualNodeName properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual node. type: object properties: backendDefaults: allOf: - $ref: '#/components/schemas/BackendDefaults' - description: A reference to an object that represents the defaults for backends. backends: allOf: - $ref: '#/components/schemas/Backends' - description: The backends that the virtual node is expected to send outbound traffic to. listeners: allOf: - $ref: '#/components/schemas/Listeners' - description: The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener. logging: allOf: - $ref: '#/components/schemas/Logging' - description: The inbound and outbound access logging information for the virtual node. serviceDiscovery: allOf: - $ref: '#/components/schemas/ServiceDiscovery' - description: 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 listener, then you must specify service discovery information. tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 virtualNodeName: description: The name to use for the virtual node. type: string minLength: 1 maxLength: 255 examples: CreateVirtualNodeRequestExample: summary: Default CreateVirtualNode request x-microcks-default: true value: clientToken: example-value spec: backendDefaults: example-value backends: example-value listeners: example-value logging: example-value serviceDiscovery: example-value tags: - example-value virtualNodeName: my-resource-01 summary: AWS App Mesh Create Virtual Node x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListVirtualNodes description: Returns a list of existing virtual nodes. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVirtualNodesOutput' examples: ListVirtualNodes200Example: summary: Default ListVirtualNodes 200 response x-microcks-default: true value: nextToken: example-value virtualNodes: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListVirtualNodes480Example: summary: Default ListVirtualNodes 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListVirtualNodes481Example: summary: Default ListVirtualNodes 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListVirtualNodes482Example: summary: Default ListVirtualNodes 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListVirtualNodes483Example: summary: Default ListVirtualNodes 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListVirtualNodes484Example: summary: Default ListVirtualNodes 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListVirtualNodes485Example: summary: Default ListVirtualNodes 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list virtual nodes in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string summary: AWS App Mesh List Virtual Nodes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualRouters: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateVirtualRouter description:

Creates a virtual router within a service mesh.

Specify a listener 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.

For more information about virtual routers, see Virtual routers.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVirtualRouterOutput' examples: CreateVirtualRouter200Example: summary: Default CreateVirtualRouter 200 response x-microcks-default: true value: virtualRouter: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateVirtualRouter480Example: summary: Default CreateVirtualRouter 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateVirtualRouter481Example: summary: Default CreateVirtualRouter 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateVirtualRouter482Example: summary: Default CreateVirtualRouter 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateVirtualRouter483Example: summary: Default CreateVirtualRouter 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateVirtualRouter484Example: summary: Default CreateVirtualRouter 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateVirtualRouter485Example: summary: Default CreateVirtualRouter 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateVirtualRouter486Example: summary: Default CreateVirtualRouter 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateVirtualRouter487Example: summary: Default CreateVirtualRouter 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the virtual router in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 requestBody: required: true content: application/json: schema: type: object required: - spec - virtualRouterName properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual router. type: object properties: listeners: allOf: - $ref: '#/components/schemas/VirtualRouterListeners' - description: The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener. tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 virtualRouterName: description: The name to use for the virtual router. type: string minLength: 1 maxLength: 255 examples: CreateVirtualRouterRequestExample: summary: Default CreateVirtualRouter request x-microcks-default: true value: clientToken: example-value spec: listeners: example-value tags: - example-value virtualRouterName: my-resource-01 summary: AWS App Mesh Create Virtual Router x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListVirtualRouters description: Returns a list of existing virtual routers in a service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVirtualRoutersOutput' examples: ListVirtualRouters200Example: summary: Default ListVirtualRouters 200 response x-microcks-default: true value: nextToken: example-value virtualRouters: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListVirtualRouters480Example: summary: Default ListVirtualRouters 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListVirtualRouters481Example: summary: Default ListVirtualRouters 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListVirtualRouters482Example: summary: Default ListVirtualRouters 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListVirtualRouters483Example: summary: Default ListVirtualRouters 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListVirtualRouters484Example: summary: Default ListVirtualRouters 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListVirtualRouters485Example: summary: Default ListVirtualRouters 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list virtual routers in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string summary: AWS App Mesh List Virtual Routers x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualServices: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: CreateVirtualService description:

Creates a virtual service within a service mesh.

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

For more information about virtual services, see Virtual services.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateVirtualServiceOutput' examples: CreateVirtualService200Example: summary: Default CreateVirtualService 200 response x-microcks-default: true value: virtualService: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateVirtualService480Example: summary: Default CreateVirtualService 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateVirtualService481Example: summary: Default CreateVirtualService 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateVirtualService482Example: summary: Default CreateVirtualService 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateVirtualService483Example: summary: Default CreateVirtualService 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateVirtualService484Example: summary: Default CreateVirtualService 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateVirtualService485Example: summary: Default CreateVirtualService 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateVirtualService486Example: summary: Default CreateVirtualService 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: CreateVirtualService487Example: summary: Default CreateVirtualService 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to create the virtual service in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services 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 Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 requestBody: required: true content: application/json: schema: type: object required: - spec - virtualServiceName properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual service. type: object properties: provider: allOf: - $ref: '#/components/schemas/VirtualServiceProvider' - description: The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router. tags: description: 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. type: array items: $ref: '#/components/schemas/TagRef' minItems: 0 maxItems: 50 virtualServiceName: description: The name to use for the virtual service. type: string examples: CreateVirtualServiceRequestExample: summary: Default CreateVirtualService request x-microcks-default: true value: clientToken: example-value spec: provider: my-resource-01 tags: - example-value virtualServiceName: my-resource-01 summary: AWS App Mesh Create Virtual Service x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: ListVirtualServices description: Returns a list of existing virtual services in a service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVirtualServicesOutput' examples: ListVirtualServices200Example: summary: Default ListVirtualServices 200 response x-microcks-default: true value: nextToken: example-value virtualServices: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListVirtualServices480Example: summary: Default ListVirtualServices 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListVirtualServices481Example: summary: Default ListVirtualServices 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListVirtualServices482Example: summary: Default ListVirtualServices 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListVirtualServices483Example: summary: Default ListVirtualServices 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListVirtualServices484Example: summary: Default ListVirtualServices 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListVirtualServices485Example: summary: Default ListVirtualServices 485 response x-microcks-default: true value: example parameters: - name: limit in: query required: false description: The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable. schema: type: integer minimum: 1 maximum: 100 - name: meshName in: path required: true description: The name of the service mesh to list virtual services in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: nextToken in: query required: false description: The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. schema: type: string summary: AWS App Mesh List Virtual Services x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteGatewayRoute description: Deletes an existing gateway route. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteGatewayRouteOutput' examples: DeleteGatewayRoute200Example: summary: Default DeleteGatewayRoute 200 response x-microcks-default: true value: gatewayRoute: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteGatewayRoute480Example: summary: Default DeleteGatewayRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteGatewayRoute481Example: summary: Default DeleteGatewayRoute 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteGatewayRoute482Example: summary: Default DeleteGatewayRoute 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteGatewayRoute483Example: summary: Default DeleteGatewayRoute 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteGatewayRoute484Example: summary: Default DeleteGatewayRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteGatewayRoute485Example: summary: Default DeleteGatewayRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteGatewayRoute486Example: summary: Default DeleteGatewayRoute 486 response x-microcks-default: true value: example parameters: - name: gatewayRouteName in: path required: true description: The name of the gateway route to delete. schema: type: string minLength: 1 maxLength: 255 - name: meshName in: path required: true description: The name of the service mesh to delete the gateway route from. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway to delete the route from. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Gateway Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeGatewayRoute description: Describes an existing gateway route. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeGatewayRouteOutput' examples: DescribeGatewayRoute200Example: summary: Default DescribeGatewayRoute 200 response x-microcks-default: true value: gatewayRoute: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeGatewayRoute480Example: summary: Default DescribeGatewayRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeGatewayRoute481Example: summary: Default DescribeGatewayRoute 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeGatewayRoute482Example: summary: Default DescribeGatewayRoute 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeGatewayRoute483Example: summary: Default DescribeGatewayRoute 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeGatewayRoute484Example: summary: Default DescribeGatewayRoute 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeGatewayRoute485Example: summary: Default DescribeGatewayRoute 485 response x-microcks-default: true value: example parameters: - name: gatewayRouteName in: path required: true description: The name of the gateway route to describe. schema: type: string minLength: 1 maxLength: 255 - name: meshName in: path required: true description: The name of the service mesh that the gateway route resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway that the gateway route is associated with. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Describe Gateway Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateGatewayRoute description: Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateGatewayRouteOutput' examples: UpdateGatewayRoute200Example: summary: Default UpdateGatewayRoute 200 response x-microcks-default: true value: gatewayRoute: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateGatewayRoute480Example: summary: Default UpdateGatewayRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateGatewayRoute481Example: summary: Default UpdateGatewayRoute 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateGatewayRoute482Example: summary: Default UpdateGatewayRoute 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateGatewayRoute483Example: summary: Default UpdateGatewayRoute 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateGatewayRoute484Example: summary: Default UpdateGatewayRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateGatewayRoute485Example: summary: Default UpdateGatewayRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateGatewayRoute486Example: summary: Default UpdateGatewayRoute 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateGatewayRoute487Example: summary: Default UpdateGatewayRoute 487 response x-microcks-default: true value: example parameters: - name: gatewayRouteName in: path required: true description: The name of the gateway route to update. schema: type: string minLength: 1 maxLength: 255 - name: meshName in: path required: true description: The name of the service mesh that the gateway route resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway that the gateway route is associated with. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents a gateway route specification. Specify one gateway route type. type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcGatewayRoute' - description: An object that represents the specification of a gRPC gateway route. http2Route: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP/2 gateway route. httpRoute: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP gateway route. priority: allOf: - $ref: '#/components/schemas/GatewayRoutePriority' - description: The ordering of the gateway routes spec. examples: UpdateGatewayRouteRequestExample: summary: Default UpdateGatewayRoute request x-microcks-default: true value: clientToken: example-value spec: grpcRoute: example-value http2Route: example-value httpRoute: example-value priority: example-value summary: AWS App Mesh Update Gateway Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteMesh description:

Deletes an existing service mesh.

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteMeshOutput' examples: DeleteMesh200Example: summary: Default DeleteMesh 200 response x-microcks-default: true value: mesh: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteMesh480Example: summary: Default DeleteMesh 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteMesh481Example: summary: Default DeleteMesh 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteMesh482Example: summary: Default DeleteMesh 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteMesh483Example: summary: Default DeleteMesh 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteMesh484Example: summary: Default DeleteMesh 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteMesh485Example: summary: Default DeleteMesh 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteMesh486Example: summary: Default DeleteMesh 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Mesh x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeMesh description: Describes an existing service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeMeshOutput' examples: DescribeMesh200Example: summary: Default DescribeMesh 200 response x-microcks-default: true value: mesh: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeMesh480Example: summary: Default DescribeMesh 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeMesh481Example: summary: Default DescribeMesh 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeMesh482Example: summary: Default DescribeMesh 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeMesh483Example: summary: Default DescribeMesh 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeMesh484Example: summary: Default DescribeMesh 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeMesh485Example: summary: Default DescribeMesh 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to describe. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 summary: AWS App Mesh Describe Mesh x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateMesh description: Updates an existing service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMeshOutput' examples: UpdateMesh200Example: summary: Default UpdateMesh 200 response x-microcks-default: true value: mesh: meshName: my-resource-01 metadata: example-value spec: example-value status: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateMesh480Example: summary: Default UpdateMesh 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateMesh481Example: summary: Default UpdateMesh 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateMesh482Example: summary: Default UpdateMesh 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateMesh483Example: summary: Default UpdateMesh 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateMesh484Example: summary: Default UpdateMesh 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateMesh485Example: summary: Default UpdateMesh 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateMesh486Example: summary: Default UpdateMesh 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to update. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a service mesh. type: object properties: egressFilter: allOf: - $ref: '#/components/schemas/EgressFilter' - description: The egress filter rules for the service mesh. serviceDiscovery: $ref: '#/components/schemas/MeshServiceDiscovery' examples: UpdateMeshRequestExample: summary: Default UpdateMesh request x-microcks-default: true value: clientToken: example-value spec: egressFilter: example-value serviceDiscovery: example-value summary: AWS App Mesh Update Mesh x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteRoute description: Deletes an existing route. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteRouteOutput' examples: DeleteRoute200Example: summary: Default DeleteRoute 200 response x-microcks-default: true value: route: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteRoute480Example: summary: Default DeleteRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteRoute481Example: summary: Default DeleteRoute 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteRoute482Example: summary: Default DeleteRoute 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteRoute483Example: summary: Default DeleteRoute 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteRoute484Example: summary: Default DeleteRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteRoute485Example: summary: Default DeleteRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteRoute486Example: summary: Default DeleteRoute 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete the route in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: routeName in: path required: true description: The name of the route to delete. schema: type: string minLength: 1 maxLength: 255 - name: virtualRouterName in: path required: true description: The name of the virtual router to delete the route in. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeRoute description: Describes an existing route. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRouteOutput' examples: DescribeRoute200Example: summary: Default DescribeRoute 200 response x-microcks-default: true value: route: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeRoute480Example: summary: Default DescribeRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeRoute481Example: summary: Default DescribeRoute 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeRoute482Example: summary: Default DescribeRoute 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeRoute483Example: summary: Default DescribeRoute 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeRoute484Example: summary: Default DescribeRoute 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeRoute485Example: summary: Default DescribeRoute 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the route resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: routeName in: path required: true description: The name of the route to describe. schema: type: string minLength: 1 maxLength: 255 - name: virtualRouterName in: path required: true description: The name of the virtual router that the route is associated with. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Describe Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateRoute description: Updates an existing route for a specified service mesh and virtual router. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateRouteOutput' examples: UpdateRoute200Example: summary: Default UpdateRoute 200 response x-microcks-default: true value: route: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateRoute480Example: summary: Default UpdateRoute 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateRoute481Example: summary: Default UpdateRoute 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateRoute482Example: summary: Default UpdateRoute 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateRoute483Example: summary: Default UpdateRoute 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateRoute484Example: summary: Default UpdateRoute 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateRoute485Example: summary: Default UpdateRoute 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateRoute486Example: summary: Default UpdateRoute 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateRoute487Example: summary: Default UpdateRoute 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the route resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: routeName in: path required: true description: The name of the route to update. schema: type: string minLength: 1 maxLength: 255 - name: virtualRouterName in: path required: true description: The name of the virtual router that the route is associated with. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents a route specification. Specify one route type. type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcRoute' - description: An object that represents the specification of a gRPC route. http2Route: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP/2 route. httpRoute: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP route. priority: allOf: - $ref: '#/components/schemas/RoutePriority' - description: The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority. tcpRoute: allOf: - $ref: '#/components/schemas/TcpRoute' - description: An object that represents the specification of a TCP route. examples: UpdateRouteRequestExample: summary: Default UpdateRoute request x-microcks-default: true value: clientToken: example-value spec: grpcRoute: example-value http2Route: example-value httpRoute: example-value priority: example-value tcpRoute: example-value summary: AWS App Mesh Update Route x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVirtualGateway description: Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVirtualGatewayOutput' examples: DeleteVirtualGateway200Example: summary: Default DeleteVirtualGateway 200 response x-microcks-default: true value: virtualGateway: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteVirtualGateway480Example: summary: Default DeleteVirtualGateway 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteVirtualGateway481Example: summary: Default DeleteVirtualGateway 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteVirtualGateway482Example: summary: Default DeleteVirtualGateway 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteVirtualGateway483Example: summary: Default DeleteVirtualGateway 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteVirtualGateway484Example: summary: Default DeleteVirtualGateway 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteVirtualGateway485Example: summary: Default DeleteVirtualGateway 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteVirtualGateway486Example: summary: Default DeleteVirtualGateway 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete the virtual gateway from. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway to delete. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Virtual Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeVirtualGateway description: Describes an existing virtual gateway. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeVirtualGatewayOutput' examples: DescribeVirtualGateway200Example: summary: Default DescribeVirtualGateway 200 response x-microcks-default: true value: virtualGateway: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeVirtualGateway480Example: summary: Default DescribeVirtualGateway 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeVirtualGateway481Example: summary: Default DescribeVirtualGateway 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeVirtualGateway482Example: summary: Default DescribeVirtualGateway 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeVirtualGateway483Example: summary: Default DescribeVirtualGateway 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeVirtualGateway484Example: summary: Default DescribeVirtualGateway 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeVirtualGateway485Example: summary: Default DescribeVirtualGateway 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the gateway route resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway to describe. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Describe Virtual Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateVirtualGateway description: Updates an existing virtual gateway in a specified service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualGatewayOutput' examples: UpdateVirtualGateway200Example: summary: Default UpdateVirtualGateway 200 response x-microcks-default: true value: virtualGateway: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateVirtualGateway480Example: summary: Default UpdateVirtualGateway 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateVirtualGateway481Example: summary: Default UpdateVirtualGateway 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateVirtualGateway482Example: summary: Default UpdateVirtualGateway 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateVirtualGateway483Example: summary: Default UpdateVirtualGateway 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateVirtualGateway484Example: summary: Default UpdateVirtualGateway 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateVirtualGateway485Example: summary: Default UpdateVirtualGateway 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateVirtualGateway486Example: summary: Default UpdateVirtualGateway 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateVirtualGateway487Example: summary: Default UpdateVirtualGateway 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual gateway resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualGatewayName in: path required: true description: The name of the virtual gateway to update. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a service mesh resource. type: object properties: backendDefaults: allOf: - $ref: '#/components/schemas/VirtualGatewayBackendDefaults' - description: A reference to an object that represents the defaults for backends. listeners: allOf: - $ref: '#/components/schemas/VirtualGatewayListeners' - description: The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener. logging: $ref: '#/components/schemas/VirtualGatewayLogging' examples: UpdateVirtualGatewayRequestExample: summary: Default UpdateVirtualGateway request x-microcks-default: true value: clientToken: example-value spec: backendDefaults: example-value listeners: example-value logging: example-value summary: AWS App Mesh Update Virtual Gateway x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVirtualNode description:

Deletes an existing virtual node.

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVirtualNodeOutput' examples: DeleteVirtualNode200Example: summary: Default DeleteVirtualNode 200 response x-microcks-default: true value: virtualNode: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteVirtualNode480Example: summary: Default DeleteVirtualNode 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteVirtualNode481Example: summary: Default DeleteVirtualNode 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteVirtualNode482Example: summary: Default DeleteVirtualNode 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteVirtualNode483Example: summary: Default DeleteVirtualNode 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteVirtualNode484Example: summary: Default DeleteVirtualNode 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteVirtualNode485Example: summary: Default DeleteVirtualNode 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteVirtualNode486Example: summary: Default DeleteVirtualNode 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete the virtual node in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualNodeName in: path required: true description: The name of the virtual node to delete. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Virtual Node x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeVirtualNode description: Describes an existing virtual node. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeVirtualNodeOutput' examples: DescribeVirtualNode200Example: summary: Default DescribeVirtualNode 200 response x-microcks-default: true value: virtualNode: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeVirtualNode480Example: summary: Default DescribeVirtualNode 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeVirtualNode481Example: summary: Default DescribeVirtualNode 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeVirtualNode482Example: summary: Default DescribeVirtualNode 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeVirtualNode483Example: summary: Default DescribeVirtualNode 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeVirtualNode484Example: summary: Default DescribeVirtualNode 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeVirtualNode485Example: summary: Default DescribeVirtualNode 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual node resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualNodeName in: path required: true description: The name of the virtual node to describe. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Describe Virtual Node x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateVirtualNode description: Updates an existing virtual node in a specified service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualNodeOutput' examples: UpdateVirtualNode200Example: summary: Default UpdateVirtualNode 200 response x-microcks-default: true value: virtualNode: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateVirtualNode480Example: summary: Default UpdateVirtualNode 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateVirtualNode481Example: summary: Default UpdateVirtualNode 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateVirtualNode482Example: summary: Default UpdateVirtualNode 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateVirtualNode483Example: summary: Default UpdateVirtualNode 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateVirtualNode484Example: summary: Default UpdateVirtualNode 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateVirtualNode485Example: summary: Default UpdateVirtualNode 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateVirtualNode486Example: summary: Default UpdateVirtualNode 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateVirtualNode487Example: summary: Default UpdateVirtualNode 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual node resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualNodeName in: path required: true description: The name of the virtual node to update. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual node. type: object properties: backendDefaults: allOf: - $ref: '#/components/schemas/BackendDefaults' - description: A reference to an object that represents the defaults for backends. backends: allOf: - $ref: '#/components/schemas/Backends' - description: The backends that the virtual node is expected to send outbound traffic to. listeners: allOf: - $ref: '#/components/schemas/Listeners' - description: The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener. logging: allOf: - $ref: '#/components/schemas/Logging' - description: The inbound and outbound access logging information for the virtual node. serviceDiscovery: allOf: - $ref: '#/components/schemas/ServiceDiscovery' - description: 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 listener, then you must specify service discovery information. examples: UpdateVirtualNodeRequestExample: summary: Default UpdateVirtualNode request x-microcks-default: true value: clientToken: example-value spec: backendDefaults: example-value backends: example-value listeners: example-value logging: example-value serviceDiscovery: example-value summary: AWS App Mesh Update Virtual Node x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVirtualRouter description:

Deletes an existing virtual router.

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

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVirtualRouterOutput' examples: DeleteVirtualRouter200Example: summary: Default DeleteVirtualRouter 200 response x-microcks-default: true value: virtualRouter: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteVirtualRouter480Example: summary: Default DeleteVirtualRouter 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteVirtualRouter481Example: summary: Default DeleteVirtualRouter 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteVirtualRouter482Example: summary: Default DeleteVirtualRouter 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteVirtualRouter483Example: summary: Default DeleteVirtualRouter 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteVirtualRouter484Example: summary: Default DeleteVirtualRouter 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteVirtualRouter485Example: summary: Default DeleteVirtualRouter 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteVirtualRouter486Example: summary: Default DeleteVirtualRouter 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete the virtual router in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualRouterName in: path required: true description: The name of the virtual router to delete. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Delete Virtual Router x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeVirtualRouter description: Describes an existing virtual router. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeVirtualRouterOutput' examples: DescribeVirtualRouter200Example: summary: Default DescribeVirtualRouter 200 response x-microcks-default: true value: virtualRouter: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeVirtualRouter480Example: summary: Default DescribeVirtualRouter 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeVirtualRouter481Example: summary: Default DescribeVirtualRouter 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeVirtualRouter482Example: summary: Default DescribeVirtualRouter 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeVirtualRouter483Example: summary: Default DescribeVirtualRouter 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeVirtualRouter484Example: summary: Default DescribeVirtualRouter 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeVirtualRouter485Example: summary: Default DescribeVirtualRouter 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual router resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualRouterName in: path required: true description: The name of the virtual router to describe. schema: type: string minLength: 1 maxLength: 255 summary: AWS App Mesh Describe Virtual Router x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateVirtualRouter description: Updates an existing virtual router in a specified service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualRouterOutput' examples: UpdateVirtualRouter200Example: summary: Default UpdateVirtualRouter 200 response x-microcks-default: true value: virtualRouter: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateVirtualRouter480Example: summary: Default UpdateVirtualRouter 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateVirtualRouter481Example: summary: Default UpdateVirtualRouter 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateVirtualRouter482Example: summary: Default UpdateVirtualRouter 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateVirtualRouter483Example: summary: Default UpdateVirtualRouter 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateVirtualRouter484Example: summary: Default UpdateVirtualRouter 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateVirtualRouter485Example: summary: Default UpdateVirtualRouter 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateVirtualRouter486Example: summary: Default UpdateVirtualRouter 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateVirtualRouter487Example: summary: Default UpdateVirtualRouter 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual router resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualRouterName in: path required: true description: The name of the virtual router to update. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual router. type: object properties: listeners: allOf: - $ref: '#/components/schemas/VirtualRouterListeners' - description: The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener. examples: UpdateVirtualRouterRequestExample: summary: Default UpdateVirtualRouter request x-microcks-default: true value: clientToken: example-value spec: listeners: example-value summary: AWS App Mesh Update Virtual Router x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes /v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteVirtualService description: Deletes an existing virtual service. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteVirtualServiceOutput' examples: DeleteVirtualService200Example: summary: Default DeleteVirtualService 200 response x-microcks-default: true value: virtualService: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteVirtualService480Example: summary: Default DeleteVirtualService 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteVirtualService481Example: summary: Default DeleteVirtualService 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteVirtualService482Example: summary: Default DeleteVirtualService 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteVirtualService483Example: summary: Default DeleteVirtualService 483 response x-microcks-default: true value: example '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' examples: DeleteVirtualService484Example: summary: Default DeleteVirtualService 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteVirtualService485Example: summary: Default DeleteVirtualService 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteVirtualService486Example: summary: Default DeleteVirtualService 486 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh to delete the virtual service in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualServiceName in: path required: true description: The name of the virtual service to delete. schema: type: string summary: AWS App Mesh Delete Virtual Service x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes get: operationId: DescribeVirtualService description: Describes an existing virtual service. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeVirtualServiceOutput' examples: DescribeVirtualService200Example: summary: Default DescribeVirtualService 200 response x-microcks-default: true value: virtualService: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeVirtualService480Example: summary: Default DescribeVirtualService 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeVirtualService481Example: summary: Default DescribeVirtualService 481 response x-microcks-default: true value: example '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeVirtualService482Example: summary: Default DescribeVirtualService 482 response x-microcks-default: true value: example '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeVirtualService483Example: summary: Default DescribeVirtualService 483 response x-microcks-default: true value: example '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeVirtualService484Example: summary: Default DescribeVirtualService 484 response x-microcks-default: true value: example '485': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeVirtualService485Example: summary: Default DescribeVirtualService 485 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual service resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualServiceName in: path required: true description: The name of the virtual service to describe. schema: type: string summary: AWS App Mesh Describe Virtual Service x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes put: operationId: UpdateVirtualService description: Updates an existing virtual service in a specified service mesh. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualServiceOutput' examples: UpdateVirtualService200Example: summary: Default UpdateVirtualService 200 response x-microcks-default: true value: virtualService: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateVirtualService480Example: summary: Default UpdateVirtualService 480 response x-microcks-default: true value: example '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateVirtualService481Example: summary: Default UpdateVirtualService 481 response x-microcks-default: true value: example '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: UpdateVirtualService482Example: summary: Default UpdateVirtualService 482 response x-microcks-default: true value: example '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateVirtualService483Example: summary: Default UpdateVirtualService 483 response x-microcks-default: true value: example '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateVirtualService484Example: summary: Default UpdateVirtualService 484 response x-microcks-default: true value: example '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateVirtualService485Example: summary: Default UpdateVirtualService 485 response x-microcks-default: true value: example '486': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateVirtualService486Example: summary: Default UpdateVirtualService 486 response x-microcks-default: true value: example '487': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' examples: UpdateVirtualService487Example: summary: Default UpdateVirtualService 487 response x-microcks-default: true value: example parameters: - name: meshName in: path required: true description: The name of the service mesh that the virtual service resides in. schema: type: string minLength: 1 maxLength: 255 - name: meshOwner in: query required: false description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. schema: type: string minLength: 12 maxLength: 12 - name: virtualServiceName in: path required: true description: The name of the virtual service to update. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - spec properties: clientToken: description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. type: string spec: description: An object that represents the specification of a virtual service. type: object properties: provider: allOf: - $ref: '#/components/schemas/VirtualServiceProvider' - description: The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router. examples: UpdateVirtualServiceRequestExample: summary: Default UpdateVirtualService request x-microcks-default: true value: clientToken: example-value spec: provider: my-resource-01 summary: AWS App Mesh Update Virtual Service x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Meshes components: schemas: MethodName: type: string minLength: 1 maxLength: 50 VirtualNodeRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - version - virtualNodeName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the virtual node. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual node resides in. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualNodeName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual node. description: An object that represents a virtual node returned by a list operation. VirtualNodeServiceProvider: type: object required: - virtualNodeName properties: virtualNodeName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual node that is acting as a service provider. description: An object that represents a virtual node service provider. VirtualGatewayClientPolicyTls: type: object required: - validation properties: certificate: allOf: - $ref: '#/components/schemas/VirtualGatewayClientTlsCertificate' - description: A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate. enforce: allOf: - $ref: '#/components/schemas/Boolean' - description: Whether the policy is enforced. The default is True, if a value isn't specified. ports: allOf: - $ref: '#/components/schemas/PortSet' - description: One or more ports that the policy is enforced for. validation: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContext' - description: A reference to an object that represents a Transport Layer Security (TLS) validation context. description: An object that represents a Transport Layer Security (TLS) client policy. RoutePriority: type: integer minimum: 0 maximum: 1000 GrpcRouteAction: type: object required: - weightedTargets properties: weightedTargets: allOf: - $ref: '#/components/schemas/WeightedTargets' - description: An object that represents the targets that traffic is routed to when a request matches the route. description: An object that represents the action to take if a match is determined. HttpGatewayRouteAction: type: object required: - target properties: rewrite: allOf: - $ref: '#/components/schemas/HttpGatewayRouteRewrite' - description: The gateway route action to rewrite. target: allOf: - $ref: '#/components/schemas/GatewayRouteTarget' - description: An object that represents the target that traffic is routed to when a request matches the gateway route. description: An object that represents the action to take if a match is determined. ClientTlsCertificate: type: object properties: file: allOf: - $ref: '#/components/schemas/ListenerTlsFileCertificate' - description: 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 Transport Layer Security (TLS). sds: allOf: - $ref: '#/components/schemas/ListenerTlsSdsCertificate' - description: A reference to an object that represents a client's TLS Secret Discovery Service certificate. description: An object that represents the client's certificate. ListMeshesOutput: type: object required: - meshes properties: meshes: allOf: - $ref: '#/components/schemas/MeshList' - description: The list of existing service meshes. nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. description: DeleteMeshOutput: type: object required: - mesh properties: mesh: allOf: - $ref: '#/components/schemas/MeshData' - description: The service mesh that was deleted. description: HttpRoute: type: object required: - action - match properties: action: allOf: - $ref: '#/components/schemas/HttpRouteAction' - description: An object that represents the action to take if a match is determined. match: allOf: - $ref: '#/components/schemas/HttpRouteMatch' - description: An object that represents the criteria for determining a request match. retryPolicy: allOf: - $ref: '#/components/schemas/HttpRetryPolicy' - description: An object that represents a retry policy. timeout: allOf: - $ref: '#/components/schemas/HttpTimeout' - description: 'An object that represents types of timeouts. ' description: An object that represents an HTTP or HTTP/2 route type. GrpcRouteMetadataList: type: array items: $ref: '#/components/schemas/GrpcRouteMetadata' minItems: 1 maxItems: 10 VirtualServiceStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED HttpScheme: type: string enum: - http - https HealthCheckIntervalMillis: type: integer minimum: 5000 maximum: 300000 VirtualGatewayListener: type: object required: - portMapping properties: connectionPool: allOf: - $ref: '#/components/schemas/VirtualGatewayConnectionPool' - description: The connection pool information for the virtual gateway listener. healthCheck: allOf: - $ref: '#/components/schemas/VirtualGatewayHealthCheckPolicy' - description: The health check information for the listener. portMapping: allOf: - $ref: '#/components/schemas/VirtualGatewayPortMapping' - description: The port mapping information for the listener. tls: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTls' - description: A reference to an object that represents the Transport Layer Security (TLS) properties for the listener. description: An object that represents a listener for a virtual gateway. VirtualGatewayHealthCheckPolicy: type: object required: - healthyThreshold - intervalMillis - protocol - timeoutMillis - unhealthyThreshold properties: healthyThreshold: allOf: - $ref: '#/components/schemas/VirtualGatewayHealthCheckThreshold' - description: The number of consecutive successful health checks that must occur before declaring the listener healthy. intervalMillis: allOf: - $ref: '#/components/schemas/VirtualGatewayHealthCheckIntervalMillis' - description: The time period in milliseconds between each health check execution. path: allOf: - $ref: '#/components/schemas/String' - description: 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. port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The destination port for the health check request. This port must match the port defined in the PortMapping for the listener. protocol: allOf: - $ref: '#/components/schemas/VirtualGatewayPortProtocol' - description: The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol. timeoutMillis: allOf: - $ref: '#/components/schemas/VirtualGatewayHealthCheckTimeoutMillis' - description: The amount of time to wait when receiving a response from the health check, in milliseconds. unhealthyThreshold: allOf: - $ref: '#/components/schemas/VirtualGatewayHealthCheckThreshold' - description: The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy. description: An object that represents the health check policy for a virtual gateway's listener. LoggingFormat: type: object properties: json: allOf: - $ref: '#/components/schemas/JsonFormat' - description:

text: allOf: - $ref: '#/components/schemas/TextFormat' - description:

description: An object that represents the format for the logs. AwsCloudMapInstanceAttribute: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/AwsCloudMapInstanceAttributeKey' - description: The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned. value: allOf: - $ref: '#/components/schemas/AwsCloudMapInstanceAttributeValue' - description: The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned. description:

An object that represents the Cloud Map attribute information for your virtual node.

Cloud Map is not available in the eu-south-1 Region.

ServiceUnavailableException: {} SubjectAlternativeNameMatchers: type: object required: - exact properties: exact: allOf: - $ref: '#/components/schemas/SubjectAlternativeNameList' - description: The values sent must match the specified values exactly. description: An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched. HttpRouteHeader: type: object required: - name properties: invert: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify True to match anything except the match criteria. The default value is False. match: allOf: - $ref: '#/components/schemas/HeaderMatchMethod' - description: The HeaderMatchMethod object. name: allOf: - $ref: '#/components/schemas/HeaderName' - description: A name for the HTTP header in the client request that will be matched on. description: An object that represents the HTTP header in the request. HttpQueryParameter: type: object required: - name properties: match: allOf: - $ref: '#/components/schemas/QueryParameterMatch' - description: The query parameter to match on. name: allOf: - $ref: '#/components/schemas/QueryParameterName' - description: A name for the query parameter that will be matched on. description: An object that represents the query parameter in the request. EgressFilter: type: object required: - type properties: type: allOf: - $ref: '#/components/schemas/EgressFilterType' - description: The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh. description: An object that represents the egress filter rules for a service mesh. TcpRouteAction: type: object required: - weightedTargets properties: weightedTargets: allOf: - $ref: '#/components/schemas/WeightedTargets' - description: An object that represents the targets that traffic is routed to when a request matches the route. description: An object that represents the action to take if a match is determined. HttpPathMatch: type: object properties: exact: allOf: - $ref: '#/components/schemas/HttpPathExact' - description: The exact path to match on. regex: allOf: - $ref: '#/components/schemas/HttpPathRegex' - description: The regex used to match the path. description: An object representing the path to match in the request. RouteSpec: type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcRoute' - description: An object that represents the specification of a gRPC route. http2Route: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP/2 route. httpRoute: allOf: - $ref: '#/components/schemas/HttpRoute' - description: An object that represents the specification of an HTTP route. priority: allOf: - $ref: '#/components/schemas/RoutePriority' - description: The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority. tcpRoute: allOf: - $ref: '#/components/schemas/TcpRoute' - description: An object that represents the specification of a TCP route. description: An object that represents a route specification. Specify one route type. DescribeVirtualNodeOutput: type: object required: - virtualNode properties: virtualNode: allOf: - $ref: '#/components/schemas/VirtualNodeData' - description: The full description of your virtual node. description: HttpPathRegex: type: string minLength: 1 maxLength: 255 TcpRetryPolicyEvents: type: array items: $ref: '#/components/schemas/TcpRetryPolicyEvent' minItems: 1 maxItems: 1 PortMapping: type: object required: - port - protocol properties: port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The port used for the port mapping. protocol: allOf: - $ref: '#/components/schemas/PortProtocol' - description: The protocol used for the port mapping. Specify one protocol. description: An object that represents a port mapping. VirtualGatewayHealthCheckTimeoutMillis: type: integer minimum: 2000 maximum: 60000 VirtualGatewayGrpcConnectionPool: type: object required: - maxRequests properties: maxRequests: allOf: - $ref: '#/components/schemas/MaxRequests' - description: Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. description: An object that represents a type of connection pool. RouteStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED VirtualNodeConnectionPool: type: object properties: grpc: allOf: - $ref: '#/components/schemas/VirtualNodeGrpcConnectionPool' - description: An object that represents a type of connection pool. http: allOf: - $ref: '#/components/schemas/VirtualNodeHttpConnectionPool' - description: An object that represents a type of connection pool. http2: allOf: - $ref: '#/components/schemas/VirtualNodeHttp2ConnectionPool' - description: An object that represents a type of connection pool. tcp: allOf: - $ref: '#/components/schemas/VirtualNodeTcpConnectionPool' - description: An object that represents a type of connection pool. description:

An object that represents the type of virtual node connection pool.

Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.

If not present the default value for maxPendingRequests is 2147483647.

VirtualGatewayListenerTlsValidationContext: type: object required: - trust properties: subjectAlternativeNames: allOf: - $ref: '#/components/schemas/SubjectAlternativeNames' - description: A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context. trust: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsValidationContextTrust' - description: A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate. description: An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context. HttpGatewayRoutePrefix: type: string minLength: 1 maxLength: 255 PortNumber: type: integer minimum: 1 maximum: 65535 MeshStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED Listener: type: object required: - portMapping properties: connectionPool: allOf: - $ref: '#/components/schemas/VirtualNodeConnectionPool' - description: The connection pool information for the listener. healthCheck: allOf: - $ref: '#/components/schemas/HealthCheckPolicy' - description: The health check information for the listener. outlierDetection: allOf: - $ref: '#/components/schemas/OutlierDetection' - description: The outlier detection information for the listener. portMapping: allOf: - $ref: '#/components/schemas/PortMapping' - description: The port mapping information for the listener. timeout: allOf: - $ref: '#/components/schemas/ListenerTimeout' - description: An object that represents timeouts for different protocols. tls: allOf: - $ref: '#/components/schemas/ListenerTls' - description: A reference to an object that represents the Transport Layer Security (TLS) properties for a listener. description: An object that represents a listener for a virtual node. VirtualGatewayFileAccessLog: type: object required: - path properties: format: allOf: - $ref: '#/components/schemas/LoggingFormat' - description: The specified format for the virtual gateway access logs. It can be either json_format or text_format. path: allOf: - $ref: '#/components/schemas/FilePath' - description: The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk. description: An object that represents an access log file. VirtualRouterStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/VirtualRouterStatusCode' - description: The current status of the virtual router. description: 'An object that represents the status of a virtual router. ' ListenerPort: type: integer minimum: 1 maximum: 65535 TlsValidationContext: type: object required: - trust properties: subjectAlternativeNames: allOf: - $ref: '#/components/schemas/SubjectAlternativeNames' - description: A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context. If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration. Since SPIRE vended certificates have a SPIFFE ID as a name, you must set the SAN since the name doesn't match the service discovery name. trust: allOf: - $ref: '#/components/schemas/TlsValidationContextTrust' - description: A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate. description: An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation. SuffixHostname: type: string minLength: 1 maxLength: 253 HttpRetryPolicy: type: object required: - maxRetries - perRetryTimeout properties: httpRetryEvents: allOf: - $ref: '#/components/schemas/HttpRetryPolicyEvents' - description:

Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
gateway-error – HTTP status codes 502, 503, and 504
client-error – HTTP status code 409
stream-error – Retry on refused stream

maxRetries: allOf: - $ref: '#/components/schemas/MaxRetries' - description: The maximum number of retry attempts. perRetryTimeout: allOf: - $ref: '#/components/schemas/Duration' - description: The timeout for each retry attempt. tcpRetryEvents: allOf: - $ref: '#/components/schemas/TcpRetryPolicyEvents' - description: 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. description: An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation. CreateVirtualGatewayOutput: type: object required: - virtualGateway properties: virtualGateway: allOf: - $ref: '#/components/schemas/VirtualGatewayData' - description: The full description of your virtual gateway following the create call. DeleteRouteOutput: type: object required: - route properties: route: allOf: - $ref: '#/components/schemas/RouteData' - description: The route that was deleted. description: VirtualGatewayTlsValidationContextAcmTrust: type: object required: - certificateAuthorityArns properties: certificateAuthorityArns: allOf: - $ref: '#/components/schemas/VirtualGatewayCertificateAuthorityArns' - description: One or more ACM Amazon Resource Name (ARN)s. description: An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate. VirtualServiceStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/VirtualServiceStatusCode' - description: The current status of the virtual service. description: An object that represents the status of a virtual service. GatewayRouteStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED ListGatewayRoutesOutput: type: object required: - gatewayRoutes properties: gatewayRoutes: allOf: - $ref: '#/components/schemas/GatewayRouteList' - description: The list of existing gateway routes for the specified service mesh and virtual gateway. nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. TcpTimeout: type: object properties: idle: allOf: - $ref: '#/components/schemas/Duration' - description: 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. description: 'An object that represents types of timeouts. ' MaxPendingRequests: type: integer minimum: 1 RouteRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - routeName - version - virtualRouterName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the route. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the route resides in. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. routeName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the route. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualRouterName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The virtual router that the route is associated with. description: An object that represents a route returned by a list operation. GatewayRoutePriority: type: integer minimum: 0 maximum: 1000 MeshStatus: type: object properties: status: allOf: - $ref: '#/components/schemas/MeshStatusCode' - description: The current mesh status. description: An object that represents the status of a service mesh. OutlierDetectionMaxEjectionPercent: type: integer minimum: 0 maximum: 100 VirtualGatewayTlsValidationContextTrust: type: object properties: acm: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextAcmTrust' - description: A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate. file: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextFileTrust' - description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. sds: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextSdsTrust' - description: A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust. description: An object that represents a Transport Layer Security (TLS) validation context trust. VirtualRouterListener: type: object required: - portMapping properties: portMapping: $ref: '#/components/schemas/PortMapping' description: An object that represents a virtual router listener. ServiceName: type: string RouteData: type: object required: - meshName - metadata - routeName - spec - status - virtualRouterName properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the route resides in. metadata: allOf: - $ref: '#/components/schemas/ResourceMetadata' - description: The associated metadata for the route. routeName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the route. spec: allOf: - $ref: '#/components/schemas/RouteSpec' - description: The specifications of the route. status: allOf: - $ref: '#/components/schemas/RouteStatus' - description: The status of the route. virtualRouterName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The virtual router that the route is associated with. description: An object that represents a route returned by a describe operation. HealthCheckTimeoutMillis: type: integer minimum: 2000 maximum: 60000 CreateVirtualServiceOutput: type: object required: - virtualService properties: virtualService: allOf: - $ref: '#/components/schemas/VirtualServiceData' - description: The full description of your virtual service following the create call. description: HttpGatewayRouteHeader: type: object required: - name properties: invert: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify True to match anything except the match criteria. The default value is False. match: allOf: - $ref: '#/components/schemas/HeaderMatchMethod' - description: An object that represents the method and value to match with the header value sent in a request. Specify one match method. name: allOf: - $ref: '#/components/schemas/HeaderName' - description: A name for the HTTP header in the gateway route that will be matched on. description: An object that represents the HTTP header in the gateway route. VirtualGatewayTlsValidationContextSdsTrust: type: object required: - secretName properties: secretName: allOf: - $ref: '#/components/schemas/VirtualGatewaySdsSecretName' - description: 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. description: 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 TLS documentation for more info. MaxRetries: type: integer minimum: 0 Logging: type: object properties: accessLog: allOf: - $ref: '#/components/schemas/AccessLog' - description: The access log configuration for a virtual node. description: An object that represents the logging information for a virtual node. ListVirtualGatewaysOutput: type: object required: - virtualGateways properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. virtualGateways: allOf: - $ref: '#/components/schemas/VirtualGatewayList' - description: The list of existing virtual gateways for the specified service mesh. HttpPathExact: type: string minLength: 1 maxLength: 255 TlsValidationContextTrust: type: object properties: acm: allOf: - $ref: '#/components/schemas/TlsValidationContextAcmTrust' - description: A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate. file: allOf: - $ref: '#/components/schemas/TlsValidationContextFileTrust' - description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. sds: allOf: - $ref: '#/components/schemas/TlsValidationContextSdsTrust' - description: A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. description: An object that represents a Transport Layer Security (TLS) validation context trust. VirtualServiceData: type: object required: - meshName - metadata - spec - status - virtualServiceName properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual service resides in. metadata: $ref: '#/components/schemas/ResourceMetadata' spec: allOf: - $ref: '#/components/schemas/VirtualServiceSpec' - description: The specifications of the virtual service. status: allOf: - $ref: '#/components/schemas/VirtualServiceStatus' - description: The current status of the virtual service. virtualServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the virtual service. description: An object that represents a virtual service returned by a describe operation. TlsValidationContextFileTrust: type: object required: - certificateChain properties: certificateChain: allOf: - $ref: '#/components/schemas/FilePath' - description: The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on. description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. VirtualNodeTcpConnectionPool: type: object required: - maxConnections properties: maxConnections: allOf: - $ref: '#/components/schemas/MaxConnections' - description: Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. description: An object that represents a type of connection pool. VirtualGatewayListeners: type: array items: $ref: '#/components/schemas/VirtualGatewayListener' ResourceInUseException: {} DescribeRouteOutput: type: object required: - route properties: route: allOf: - $ref: '#/components/schemas/RouteData' - description: The full description of your route. description: GrpcGatewayRoute: type: object required: - action - match properties: action: allOf: - $ref: '#/components/schemas/GrpcGatewayRouteAction' - description: An object that represents the action to take if a match is determined. match: allOf: - $ref: '#/components/schemas/GrpcGatewayRouteMatch' - description: An object that represents the criteria for determining a request match. description: An object that represents a gRPC gateway route. HttpGatewayRouteMatch: type: object properties: headers: allOf: - $ref: '#/components/schemas/HttpGatewayRouteHeaders' - description: The client request headers to match on. hostname: allOf: - $ref: '#/components/schemas/GatewayRouteHostnameMatch' - description: The host name to match on. method: allOf: - $ref: '#/components/schemas/HttpMethod' - description: The method to match on. path: allOf: - $ref: '#/components/schemas/HttpPathMatch' - description: The path to match on. port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number to match on. prefix: allOf: - $ref: '#/components/schemas/String' - description: Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics. queryParameters: allOf: - $ref: '#/components/schemas/HttpQueryParameters' - description: The query parameter to match on. description: An object that represents the criteria for determining a request match. PortSet: type: array items: $ref: '#/components/schemas/PortNumber' Long: type: integer SubjectAlternativeNameList: type: array items: $ref: '#/components/schemas/SubjectAlternativeName' VirtualNodeData: type: object required: - meshName - metadata - spec - status - virtualNodeName properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual node resides in. metadata: allOf: - $ref: '#/components/schemas/ResourceMetadata' - description: The associated metadata for the virtual node. spec: allOf: - $ref: '#/components/schemas/VirtualNodeSpec' - description: The specifications of the virtual node. status: allOf: - $ref: '#/components/schemas/VirtualNodeStatus' - description: The current status for the virtual node. virtualNodeName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual node. description: An object that represents a virtual node returned by a describe operation. ListenerTlsCertificate: type: object properties: acm: allOf: - $ref: '#/components/schemas/ListenerTlsAcmCertificate' - description: A reference to an object that represents an Certificate Manager certificate. file: allOf: - $ref: '#/components/schemas/ListenerTlsFileCertificate' - description: A reference to an object that represents a local file certificate. sds: allOf: - $ref: '#/components/schemas/ListenerTlsSdsCertificate' - description: A reference to an object that represents a listener's Secret Discovery Service certificate. description: An object that represents a listener's Transport Layer Security (TLS) certificate. HttpRetryPolicyEvent: type: string minLength: 1 maxLength: 25 JsonFormat: type: array items: $ref: '#/components/schemas/JsonFormatRef' DefaultGatewayRouteRewrite: type: string enum: - ENABLED - DISABLED UpdateVirtualServiceOutput: type: object required: - virtualService properties: virtualService: allOf: - $ref: '#/components/schemas/VirtualServiceData' - description: A full description of the virtual service that was updated. description: ExactHostName: type: string minLength: 1 maxLength: 253 VirtualGatewayTlsValidationContextFileTrust: type: object required: - certificateChain properties: certificateChain: allOf: - $ref: '#/components/schemas/FilePath' - description: The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on. description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. GrpcGatewayRouteMetadataList: type: array items: $ref: '#/components/schemas/GrpcGatewayRouteMetadata' minItems: 1 maxItems: 10 VirtualGatewayPortProtocol: type: string enum: - http - http2 - grpc MeshData: type: object required: - meshName - metadata - spec - status properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh. metadata: allOf: - $ref: '#/components/schemas/ResourceMetadata' - description: The associated metadata for the service mesh. spec: allOf: - $ref: '#/components/schemas/MeshSpec' - description: The associated specification for the service mesh. status: allOf: - $ref: '#/components/schemas/MeshStatus' - description: The status of the service mesh. description: An object that represents a service mesh returned by a describe operation. ListRoutesOutput: type: object required: - routes properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. routes: allOf: - $ref: '#/components/schemas/RouteList' - description: The list of existing routes for the specified service mesh and virtual router. description: NotFoundException: {} MaxRequests: type: integer minimum: 1 DescribeVirtualGatewayOutput: type: object required: - virtualGateway properties: virtualGateway: allOf: - $ref: '#/components/schemas/VirtualGatewayData' - description: The full description of your virtual gateway. VirtualGatewaySdsSecretName: type: string VirtualRouterStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED WeightedTarget: type: object required: - virtualNode - weight properties: port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The targeted port of the weighted object. virtualNode: allOf: - $ref: '#/components/schemas/ResourceName' - description: The virtual node to associate with the weighted target. weight: allOf: - $ref: '#/components/schemas/PercentInt' - description: The relative weight of the weighted target. description: 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. UpdateVirtualRouterOutput: type: object required: - virtualRouter properties: virtualRouter: allOf: - $ref: '#/components/schemas/VirtualRouterData' - description: A full description of the virtual router that was updated. description: ListVirtualServicesOutput: type: object required: - virtualServices properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. virtualServices: allOf: - $ref: '#/components/schemas/VirtualServiceList' - description: The list of existing virtual services for the specified service mesh. description: TlsValidationContextSdsTrust: type: object required: - secretName properties: secretName: allOf: - $ref: '#/components/schemas/SdsSecretName' - description: A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust. description: 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 TLS documentation for more info. VirtualRouterSpec: type: object properties: listeners: allOf: - $ref: '#/components/schemas/VirtualRouterListeners' - description: The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener. description: An object that represents the specification of a virtual router. ListenerTls: type: object required: - certificate - mode properties: certificate: allOf: - $ref: '#/components/schemas/ListenerTlsCertificate' - description: A reference to an object that represents a listener's Transport Layer Security (TLS) certificate. mode: allOf: - $ref: '#/components/schemas/ListenerTlsMode' - description:

Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

validation: allOf: - $ref: '#/components/schemas/ListenerTlsValidationContext' - description: A reference to an object that represents a listener's Transport Layer Security (TLS) validation context. description: An object that represents the Transport Layer Security (TLS) properties for a listener. UpdateVirtualNodeOutput: type: object required: - virtualNode properties: virtualNode: allOf: - $ref: '#/components/schemas/VirtualNodeData' - description: A full description of the virtual node that was updated. description: ListenerTlsSdsCertificate: type: object required: - secretName properties: secretName: allOf: - $ref: '#/components/schemas/SdsSecretName' - description: 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. description: 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 TLS documentation for more info. GrpcMetadataMatchMethod: type: object properties: exact: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The exact method header to be matched on. prefix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The specified beginning characters of the method header to be matched on. range: $ref: '#/components/schemas/MatchRange' regex: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The regex used to match the method header. suffix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The specified ending characters of the method header to match on. description: An object representing the method header to be matched. UpdateRouteOutput: type: object required: - route properties: route: allOf: - $ref: '#/components/schemas/RouteData' - description: A full description of the route that was updated. description: VirtualServiceRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - version - virtualServiceName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the virtual service. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual service resides in. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the virtual service. description: An object that represents a virtual service returned by a list operation. VirtualGatewayStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/VirtualGatewayStatusCode' - description: The current status. description: An object that represents the status of the mesh resource. MeshList: type: array items: $ref: '#/components/schemas/MeshRef' EgressFilterType: type: string enum: - ALLOW_ALL - DROP_ALL UpdateGatewayRouteOutput: type: object required: - gatewayRoute properties: gatewayRoute: allOf: - $ref: '#/components/schemas/GatewayRouteData' - description: A full description of the gateway route that was updated. GrpcRetryPolicy: type: object required: - maxRetries - perRetryTimeout properties: grpcRetryEvents: allOf: - $ref: '#/components/schemas/GrpcRetryPolicyEvents' - description: Specify at least one of the valid values. httpRetryEvents: allOf: - $ref: '#/components/schemas/HttpRetryPolicyEvents' - description:
Specify at least one of the following values.

server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511

gateway-error – HTTP status codes 502, 503, and 504

client-error – HTTP status code 409

stream-error – Retry on refused stream

maxRetries: allOf: - $ref: '#/components/schemas/MaxRetries' - description: The maximum number of retry attempts. perRetryTimeout: allOf: - $ref: '#/components/schemas/Duration' - description: The timeout for each retry attempt. tcpRetryEvents: allOf: - $ref: '#/components/schemas/TcpRetryPolicyEvents' - description: 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. description: An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation. CreateVirtualNodeOutput: type: object required: - virtualNode properties: virtualNode: allOf: - $ref: '#/components/schemas/VirtualNodeData' - description: The full description of your virtual node following the create call. description: VirtualGatewayData: type: object required: - meshName - metadata - spec - status - virtualGatewayName properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual gateway resides in. metadata: $ref: '#/components/schemas/ResourceMetadata' spec: allOf: - $ref: '#/components/schemas/VirtualGatewaySpec' - description: The specifications of the virtual gateway. status: allOf: - $ref: '#/components/schemas/VirtualGatewayStatus' - description: The current status of the virtual gateway. virtualGatewayName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual gateway. description: An object that represents a virtual gateway returned by a describe operation. VirtualRouterData: type: object required: - meshName - metadata - spec - status - virtualRouterName properties: meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual router resides in. metadata: allOf: - $ref: '#/components/schemas/ResourceMetadata' - description: The associated metadata for the virtual router. spec: allOf: - $ref: '#/components/schemas/VirtualRouterSpec' - description: The specifications of the virtual router. status: allOf: - $ref: '#/components/schemas/VirtualRouterStatus' - description: The current status of the virtual router. virtualRouterName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual router. description: An object that represents a virtual router returned by a describe operation. OutlierDetectionMaxServerErrors: type: integer minimum: 1 VirtualGatewayList: type: array items: $ref: '#/components/schemas/VirtualGatewayRef' TagValue: type: string minLength: 0 maxLength: 256 AccountId: type: string minLength: 12 maxLength: 12 GatewayRouteVirtualService: type: object required: - virtualServiceName properties: virtualServiceName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual service that traffic is routed to. description: An object that represents the virtual service that traffic is routed to. ListenerTlsMode: type: string enum: - STRICT - PERMISSIVE - DISABLED GatewayRouteList: type: array items: $ref: '#/components/schemas/GatewayRouteRef' VirtualServiceList: type: array items: $ref: '#/components/schemas/VirtualServiceRef' ClientPolicyTls: type: object required: - validation properties: certificate: allOf: - $ref: '#/components/schemas/ClientTlsCertificate' - description: A reference to an object that represents a client's TLS certificate. enforce: allOf: - $ref: '#/components/schemas/Boolean' - description: Whether the policy is enforced. The default is True, if a value isn't specified. ports: allOf: - $ref: '#/components/schemas/PortSet' - description: One or more ports that the policy is enforced for. validation: allOf: - $ref: '#/components/schemas/TlsValidationContext' - description: A reference to an object that represents a TLS validation context. description: A reference to an object that represents a Transport Layer Security (TLS) client policy. ListVirtualRoutersOutput: type: object required: - virtualRouters properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. virtualRouters: allOf: - $ref: '#/components/schemas/VirtualRouterList' - description: The list of existing virtual routers for the specified service mesh. description: VirtualRouterServiceProvider: type: object required: - virtualRouterName properties: virtualRouterName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual router that is acting as a service provider. description: An object that represents a virtual node service provider. BackendDefaults: type: object properties: clientPolicy: allOf: - $ref: '#/components/schemas/ClientPolicy' - description: A reference to an object that represents a client policy. description: An object that represents the default properties for a backend. VirtualGatewayHealthCheckThreshold: type: integer minimum: 2 maximum: 10 DeleteVirtualServiceOutput: type: object required: - virtualService properties: virtualService: allOf: - $ref: '#/components/schemas/VirtualServiceData' - description: The virtual service that was deleted. description: MaxConnections: type: integer minimum: 1 IpPreference: type: string enum: - IPv6_PREFERRED - IPv4_PREFERRED - IPv4_ONLY - IPv6_ONLY DurationValue: type: integer minimum: 0 DescribeVirtualRouterOutput: type: object required: - virtualRouter properties: virtualRouter: allOf: - $ref: '#/components/schemas/VirtualRouterData' - description: The full description of your virtual router. description: MeshSpec: type: object properties: egressFilter: allOf: - $ref: '#/components/schemas/EgressFilter' - description: The egress filter rules for the service mesh. serviceDiscovery: $ref: '#/components/schemas/MeshServiceDiscovery' description: An object that represents the specification of a service mesh. UpdateVirtualGatewayOutput: type: object required: - virtualGateway properties: virtualGateway: allOf: - $ref: '#/components/schemas/VirtualGatewayData' - description: A full description of the virtual gateway that was updated. HttpTimeout: type: object properties: idle: allOf: - $ref: '#/components/schemas/Duration' - description: 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. perRequest: allOf: - $ref: '#/components/schemas/Duration' - description: 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. description: 'An object that represents types of timeouts. ' GrpcGatewayRouteRewrite: type: object properties: hostname: allOf: - $ref: '#/components/schemas/GatewayRouteHostnameRewrite' - description: The host name of the gateway route to rewrite. description: An object that represents the gateway route to rewrite. QueryParameterName: type: string HttpMethod: type: string enum: - GET - HEAD - POST - PUT - DELETE - CONNECT - OPTIONS - TRACE - PATCH HttpRetryPolicyEvents: type: array items: $ref: '#/components/schemas/HttpRetryPolicyEvent' minItems: 1 maxItems: 25 GatewayRouteData: type: object required: - gatewayRouteName - meshName - metadata - spec - status - virtualGatewayName properties: gatewayRouteName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the gateway route. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: 'The name of the service mesh that the resource resides in. ' metadata: $ref: '#/components/schemas/ResourceMetadata' spec: allOf: - $ref: '#/components/schemas/GatewayRouteSpec' - description: The specifications of the gateway route. status: allOf: - $ref: '#/components/schemas/GatewayRouteStatus' - description: The status of the gateway route. virtualGatewayName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The virtual gateway that the gateway route is associated with. description: An object that represents a gateway route returned by a describe operation. HttpGatewayRoutePathRewrite: type: object properties: exact: allOf: - $ref: '#/components/schemas/HttpPathExact' - description: The exact path to rewrite. description: An object that represents the path to rewrite. InternalServerErrorException: {} CreateGatewayRouteOutput: type: object required: - gatewayRoute properties: gatewayRoute: allOf: - $ref: '#/components/schemas/GatewayRouteData' - description: The full description of your gateway route following the create call. RouteStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/RouteStatusCode' - description: The current status for the route. description: An object that represents the current status of a route. VirtualGatewayStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED VirtualRouterRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - version - virtualRouterName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the virtual router. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the virtual router resides in. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualRouterName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the virtual router. description: An object that represents a virtual router returned by a list operation. GrpcTimeout: type: object properties: idle: allOf: - $ref: '#/components/schemas/Duration' - description: 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. perRequest: allOf: - $ref: '#/components/schemas/Duration' - description: 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. description: 'An object that represents types of timeouts. ' PercentInt: type: integer minimum: 0 maximum: 100 JsonValue: type: string minLength: 1 maxLength: 100 VirtualGatewayListenerTlsFileCertificate: type: object required: - certificateChain - privateKey properties: certificateChain: allOf: - $ref: '#/components/schemas/FilePath' - description: The certificate chain for the certificate. privateKey: allOf: - $ref: '#/components/schemas/FilePath' - description: The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on. description: 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 Transport Layer Security (TLS). Arn: type: string TagRef: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/TagKey' - description: One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. value: allOf: - $ref: '#/components/schemas/TagValue' - description: The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). description: 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. VirtualGatewayClientPolicy: type: object properties: tls: allOf: - $ref: '#/components/schemas/VirtualGatewayClientPolicyTls' - description: A reference to an object that represents a Transport Layer Security (TLS) client policy. description: An object that represents a client policy. TextFormat: type: string minLength: 1 maxLength: 1000 ListenerTlsValidationContext: type: object required: - trust properties: subjectAlternativeNames: allOf: - $ref: '#/components/schemas/SubjectAlternativeNames' - description: A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context. trust: allOf: - $ref: '#/components/schemas/ListenerTlsValidationContextTrust' - description: A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate. description: An object that represents a listener's Transport Layer Security (TLS) validation context. VirtualGatewayListenerTls: type: object required: - certificate - mode properties: certificate: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsCertificate' - description: An object that represents a Transport Layer Security (TLS) certificate. mode: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsMode' - description:
Specify one of the following modes.

STRICT – Listener only accepts connections with TLS enabled.

PERMISSIVE – Listener accepts connections with or without TLS enabled.

DISABLED – Listener only accepts connections without TLS.

validation: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsValidationContext' - description: A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context. description: An object that represents the Transport Layer Security (TLS) properties for a listener. AccessLog: type: object properties: file: allOf: - $ref: '#/components/schemas/FileAccessLog' - description: The file object to send virtual node access logs to. description: An object that represents the access logging information for a virtual node. MeshServiceDiscovery: type: object properties: ipPreference: allOf: - $ref: '#/components/schemas/IpPreference' - description: The IP version to use to control traffic within the mesh. description: An object that represents the service discovery information for a service mesh. Duration: type: object properties: unit: allOf: - $ref: '#/components/schemas/DurationUnit' - description: A unit of time. value: allOf: - $ref: '#/components/schemas/DurationValue' - description: A number of time units. description: An object that represents a duration of time. VirtualGatewayConnectionPool: type: object properties: grpc: allOf: - $ref: '#/components/schemas/VirtualGatewayGrpcConnectionPool' - description: 'An object that represents a type of connection pool. ' http: allOf: - $ref: '#/components/schemas/VirtualGatewayHttpConnectionPool' - description: An object that represents a type of connection pool. http2: allOf: - $ref: '#/components/schemas/VirtualGatewayHttp2ConnectionPool' - description: An object that represents a type of connection pool. description:
An object that represents the type of virtual gateway connection pool.

Only one protocol is used at a time and should be the same protocol as the one chosen under port mapping.

If not present the default value for maxPendingRequests is 2147483647.
VirtualNodeStatusCode: type: string enum: - ACTIVE - INACTIVE - DELETED HealthCheckPolicy: type: object required: - healthyThreshold - intervalMillis - protocol - timeoutMillis - unhealthyThreshold properties: healthyThreshold: allOf: - $ref: '#/components/schemas/HealthCheckThreshold' - description: The number of consecutive successful health checks that must occur before declaring listener healthy. intervalMillis: allOf: - $ref: '#/components/schemas/HealthCheckIntervalMillis' - description: The time period in milliseconds between each health check execution. path: allOf: - $ref: '#/components/schemas/String' - description: 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. port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The destination port for the health check request. This port must match the port defined in the PortMapping for the listener. protocol: allOf: - $ref: '#/components/schemas/PortProtocol' - description: The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol. timeoutMillis: allOf: - $ref: '#/components/schemas/HealthCheckTimeoutMillis' - description: The amount of time to wait when receiving a response from the health check, in milliseconds. unhealthyThreshold: allOf: - $ref: '#/components/schemas/HealthCheckThreshold' - description: 'The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy. ' description: An object that represents the health check policy for a virtual node's listener. GatewayRouteStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/GatewayRouteStatusCode' - description: The current status for the gateway route. description: An object that represents the current status of a gateway route. VirtualServiceSpec: type: object properties: provider: allOf: - $ref: '#/components/schemas/VirtualServiceProvider' - description: The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router. description: An object that represents the specification of a virtual service. BadRequestException: {} DnsServiceDiscovery: type: object required: - hostname properties: hostname: allOf: - $ref: '#/components/schemas/Hostname' - description: 'Specifies the DNS service discovery hostname for the virtual node. ' ipPreference: allOf: - $ref: '#/components/schemas/IpPreference' - description: The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node. responseType: allOf: - $ref: '#/components/schemas/DnsResponseType' - description: Specifies the DNS response type for the virtual node. description: An object that represents the DNS service discovery information for your virtual node. DurationUnit: type: string enum: - s - ms GrpcRouteMatch: type: object properties: metadata: allOf: - $ref: '#/components/schemas/GrpcRouteMetadataList' - description: An object that represents the data to match from the request. methodName: allOf: - $ref: '#/components/schemas/MethodName' - description: The method name to match from the request. If you specify a name, you must also specify a serviceName. port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number to match on. serviceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The fully qualified domain name for the service to match from the request. description: An object that represents the criteria for determining a request match. VirtualGatewayHttp2ConnectionPool: type: object required: - maxRequests properties: maxRequests: allOf: - $ref: '#/components/schemas/MaxRequests' - description: Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. description: An object that represents a type of connection pool. VirtualRouterListeners: type: array items: $ref: '#/components/schemas/VirtualRouterListener' ConflictException: {} VirtualGatewayAccessLog: type: object properties: file: allOf: - $ref: '#/components/schemas/VirtualGatewayFileAccessLog' - description: The file object to send virtual gateway access logs to. description: The access log configuration for a virtual gateway. DnsResponseType: type: string enum: - LOADBALANCER - ENDPOINTS VirtualGatewayListenerTlsValidationContextTrust: type: object properties: file: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextFileTrust' - description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. sds: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextSdsTrust' - description: A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. description: An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust. VirtualGatewayPortMapping: type: object required: - port - protocol properties: port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The port used for the port mapping. Specify one protocol. protocol: allOf: - $ref: '#/components/schemas/VirtualGatewayPortProtocol' - description: The protocol used for the port mapping. description: An object that represents a port mapping. VirtualGatewaySpec: type: object required: - listeners properties: backendDefaults: allOf: - $ref: '#/components/schemas/VirtualGatewayBackendDefaults' - description: A reference to an object that represents the defaults for backends. listeners: allOf: - $ref: '#/components/schemas/VirtualGatewayListeners' - description: The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener. logging: $ref: '#/components/schemas/VirtualGatewayLogging' description: An object that represents the specification of a service mesh resource. GrpcRouteMetadata: type: object required: - name properties: invert: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify True to match anything except the match criteria. The default value is False. match: allOf: - $ref: '#/components/schemas/GrpcRouteMetadataMatchMethod' - description: An object that represents the data to match from the request. name: allOf: - $ref: '#/components/schemas/HeaderName' - description: The name of the route. description: An object that represents the match metadata for the route. VirtualNodeStatus: type: object required: - status properties: status: allOf: - $ref: '#/components/schemas/VirtualNodeStatusCode' - description: The current status of the virtual node. description: An object that represents the current status of the virtual node. Boolean: type: boolean ServiceDiscovery: type: object properties: awsCloudMap: allOf: - $ref: '#/components/schemas/AwsCloudMapServiceDiscovery' - description: Specifies any Cloud Map information for the virtual node. dns: allOf: - $ref: '#/components/schemas/DnsServiceDiscovery' - description: Specifies the DNS information for the virtual node. description: An object that represents the service discovery information for a virtual node. HealthCheckThreshold: type: integer minimum: 2 maximum: 10 TagKey: type: string minLength: 1 maxLength: 128 Listeners: type: array items: $ref: '#/components/schemas/Listener' VirtualGatewayTlsValidationContext: type: object required: - trust properties: subjectAlternativeNames: allOf: - $ref: '#/components/schemas/SubjectAlternativeNames' - description: A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context. trust: allOf: - $ref: '#/components/schemas/VirtualGatewayTlsValidationContextTrust' - description: A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate. description: An object that represents a Transport Layer Security (TLS) validation context. DeleteVirtualNodeOutput: type: object required: - virtualNode properties: virtualNode: allOf: - $ref: '#/components/schemas/VirtualNodeData' - description: The virtual node that was deleted. description: GrpcGatewayRouteMetadata: type: object required: - name properties: invert: allOf: - $ref: '#/components/schemas/Boolean' - description: Specify True to match anything except the match criteria. The default value is False. match: allOf: - $ref: '#/components/schemas/GrpcMetadataMatchMethod' - description: The criteria for determining a metadata match. name: allOf: - $ref: '#/components/schemas/HeaderName' - description: A name for the gateway route metadata. description: An object representing the metadata of the gateway route. DeleteGatewayRouteOutput: type: object required: - gatewayRoute properties: gatewayRoute: allOf: - $ref: '#/components/schemas/GatewayRouteData' - description: The gateway route that was deleted. SubjectAlternativeName: type: string minLength: 1 maxLength: 254 FileAccessLog: type: object required: - path properties: format: allOf: - $ref: '#/components/schemas/LoggingFormat' - description: The specified format for the logs. The format is either json_format or text_format. path: allOf: - $ref: '#/components/schemas/FilePath' - description:
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

<note> <p>The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.</p> </note>
description: An object that represents an access log file. HttpGatewayRoute: type: object required: - action - match properties: action: allOf: - $ref: '#/components/schemas/HttpGatewayRouteAction' - description: An object that represents the action to take if a match is determined. match: allOf: - $ref: '#/components/schemas/HttpGatewayRouteMatch' - description: An object that represents the criteria for determining a request match. description: An object that represents an HTTP gateway route. Hostname: type: string VirtualNodeGrpcConnectionPool: type: object required: - maxRequests properties: maxRequests: allOf: - $ref: '#/components/schemas/MaxRequests' - description: Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. description: An object that represents a type of connection pool. String: type: string HttpGatewayRouteRewrite: type: object properties: hostname: allOf: - $ref: '#/components/schemas/GatewayRouteHostnameRewrite' - description: The host name to rewrite. path: allOf: - $ref: '#/components/schemas/HttpGatewayRoutePathRewrite' - description: The path to rewrite. prefix: allOf: - $ref: '#/components/schemas/HttpGatewayRoutePrefixRewrite' - description: The specified beginning characters to rewrite. description: An object representing the gateway route to rewrite. Backend: type: object properties: virtualService: allOf: - $ref: '#/components/schemas/VirtualServiceBackend' - description: 'Specifies a virtual service to use as a backend. ' description: An object that represents the backends that a virtual node is expected to send outbound traffic to. GatewayRouteHostnameRewrite: type: object properties: defaultTargetHostname: allOf: - $ref: '#/components/schemas/DefaultGatewayRouteRewrite' - description: The default target host name to write to. description: An object representing the gateway route host name to rewrite. PortProtocol: type: string enum: - http - tcp - http2 - grpc CreateMeshOutput: type: object required: - mesh properties: mesh: allOf: - $ref: '#/components/schemas/MeshData' - description: The full description of your service mesh following the create call. description: AwsCloudMapInstanceAttributeKey: type: string pattern: ^[a-zA-Z0-9!-~]+$ minLength: 1 maxLength: 255 GrpcRetryPolicyEvent: type: string enum: - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable VirtualServiceBackend: type: object required: - virtualServiceName properties: clientPolicy: allOf: - $ref: '#/components/schemas/ClientPolicy' - description: A reference to an object that represents the client policy for a backend. virtualServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the virtual service that is acting as a virtual node backend. description: An object that represents a virtual service backend for a virtual node. TcpRoute: type: object required: - action properties: action: allOf: - $ref: '#/components/schemas/TcpRouteAction' - description: The action to take if a match is determined. match: allOf: - $ref: '#/components/schemas/TcpRouteMatch' - description: An object that represents the criteria for determining a request match. timeout: allOf: - $ref: '#/components/schemas/TcpTimeout' - description: 'An object that represents types of timeouts. ' description: An object that represents a TCP route type. TooManyRequestsException: {} ResourceMetadata: type: object required: - arn - createdAt - lastUpdatedAt - meshOwner - resourceOwner - uid - version properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the resource. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. uid: allOf: - $ref: '#/components/schemas/String' - description: The unique identifier for the resource. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. description: An object that represents metadata for a resource. VirtualServiceProvider: type: object properties: virtualNode: allOf: - $ref: '#/components/schemas/VirtualNodeServiceProvider' - description: The virtual node associated with a virtual service. virtualRouter: allOf: - $ref: '#/components/schemas/VirtualRouterServiceProvider' - description: The virtual router associated with a virtual service. description: An object that represents the provider for a virtual service. HeaderMatchMethod: type: object properties: exact: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must match the specified value exactly. prefix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must begin with the specified characters. range: allOf: - $ref: '#/components/schemas/MatchRange' - description: An object that represents the range of values to match on. regex: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must include the specified characters. suffix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must end with the specified characters. description: An object that represents the method and value to match with the header value sent in a request. Specify one match method. HttpGatewayRoutePrefixRewrite: type: object properties: defaultPrefix: allOf: - $ref: '#/components/schemas/DefaultGatewayRouteRewrite' - description: The default prefix used to replace the incoming route prefix when rewritten. value: allOf: - $ref: '#/components/schemas/HttpGatewayRoutePrefix' - description: The value used to replace the incoming route prefix when rewritten. description: An object representing the beginning characters of the route to rewrite. WeightedTargets: type: array items: $ref: '#/components/schemas/WeightedTarget' minItems: 1 maxItems: 10 DeleteVirtualRouterOutput: type: object required: - virtualRouter properties: virtualRouter: allOf: - $ref: '#/components/schemas/VirtualRouterData' - description: The virtual router that was deleted. description: SubjectAlternativeNames: type: object required: - match properties: match: allOf: - $ref: '#/components/schemas/SubjectAlternativeNameMatchers' - description: An object that represents the criteria for determining a SANs match. description: An object that represents the subject alternative names secured by the certificate. VirtualNodeList: type: array items: $ref: '#/components/schemas/VirtualNodeRef' TlsValidationContextAcmTrust: type: object required: - certificateAuthorityArns properties: certificateAuthorityArns: allOf: - $ref: '#/components/schemas/CertificateAuthorityArns' - description: One or more ACM Amazon Resource Name (ARN)s. description: An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate. GatewayRouteRef: type: object required: - arn - createdAt - gatewayRouteName - lastUpdatedAt - meshName - meshOwner - resourceOwner - version - virtualGatewayName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the gateway route. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. gatewayRouteName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the gateway route. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: 'The name of the service mesh that the resource resides in. ' meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualGatewayName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The virtual gateway that the gateway route is associated with. description: An object that represents a gateway route returned by a list operation. MeshRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - version properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) of the service mesh. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. description: An object that represents a service mesh returned by a list operation. VirtualGatewayBackendDefaults: type: object properties: clientPolicy: allOf: - $ref: '#/components/schemas/VirtualGatewayClientPolicy' - description: A reference to an object that represents a client policy. description: An object that represents the default properties for a backend. ListVirtualNodesOutput: type: object required: - virtualNodes properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return. virtualNodes: allOf: - $ref: '#/components/schemas/VirtualNodeList' - description: The list of existing virtual nodes for the specified service mesh. description: VirtualGatewayListenerTlsCertificate: type: object properties: acm: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsAcmCertificate' - description: A reference to an object that represents an Certificate Manager certificate. file: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsFileCertificate' - description: A reference to an object that represents a local file certificate. sds: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsSdsCertificate' - description: A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate. description: An object that represents a listener's Transport Layer Security (TLS) certificate. GatewayRouteTarget: type: object required: - virtualService properties: port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number of the gateway route target. virtualService: allOf: - $ref: '#/components/schemas/GatewayRouteVirtualService' - description: An object that represents a virtual service gateway route target. description: An object that represents a gateway route target. HttpRouteHeaders: type: array items: $ref: '#/components/schemas/HttpRouteHeader' minItems: 1 maxItems: 10 VirtualGatewayListenerTlsMode: type: string enum: - STRICT - PERMISSIVE - DISABLED ListenerTlsValidationContextTrust: type: object properties: file: allOf: - $ref: '#/components/schemas/TlsValidationContextFileTrust' - description: An object that represents a Transport Layer Security (TLS) validation context trust for a local file. sds: allOf: - $ref: '#/components/schemas/TlsValidationContextSdsTrust' - description: A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. description: An object that represents a listener's Transport Layer Security (TLS) validation context trust. GatewayRouteSpec: type: object properties: grpcRoute: allOf: - $ref: '#/components/schemas/GrpcGatewayRoute' - description: An object that represents the specification of a gRPC gateway route. http2Route: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP/2 gateway route. httpRoute: allOf: - $ref: '#/components/schemas/HttpGatewayRoute' - description: An object that represents the specification of an HTTP gateway route. priority: allOf: - $ref: '#/components/schemas/GatewayRoutePriority' - description: The ordering of the gateway routes spec. description: An object that represents a gateway route specification. Specify one gateway route type. VirtualNodeHttpConnectionPool: type: object required: - maxConnections properties: maxConnections: allOf: - $ref: '#/components/schemas/MaxConnections' - description: Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. maxPendingRequests: allOf: - $ref: '#/components/schemas/MaxPendingRequests' - description: Number of overflowing requests after max_connections Envoy will queue to upstream cluster. description: An object that represents a type of connection pool. Timestamp: type: string format: date-time AwsCloudMapServiceDiscovery: type: object required: - namespaceName - serviceName properties: attributes: allOf: - $ref: '#/components/schemas/AwsCloudMapInstanceAttributes' - description: 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. ipPreference: allOf: - $ref: '#/components/schemas/IpPreference' - description: The preferred IP version that this virtual node uses. Setting the IP preference on the virtual node only overrides the IP preference set for the mesh on this specific node. namespaceName: allOf: - $ref: '#/components/schemas/AwsCloudMapName' - description: The name of the Cloud Map namespace to use. serviceName: allOf: - $ref: '#/components/schemas/AwsCloudMapName' - description: The name of the Cloud Map service to use. description:
An object that represents the Cloud Map service discovery information for your virtual node.

Cloud Map is not available in the eu-south-1 Region.
VirtualGatewayRef: type: object required: - arn - createdAt - lastUpdatedAt - meshName - meshOwner - resourceOwner - version - virtualGatewayName properties: arn: allOf: - $ref: '#/components/schemas/Arn' - description: The full Amazon Resource Name (ARN) for the resource. createdAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was created. lastUpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The Unix epoch timestamp in seconds for when the resource was last updated. meshName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the service mesh that the resource resides in. meshOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes. resourceOwner: allOf: - $ref: '#/components/schemas/AccountId' - description: The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes. version: allOf: - $ref: '#/components/schemas/Long' - description: The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated. virtualGatewayName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The name of the resource. description: An object that represents a virtual gateway returned by a list operation. Backends: type: array items: $ref: '#/components/schemas/Backend' DescribeGatewayRouteOutput: type: object required: - gatewayRoute properties: gatewayRoute: allOf: - $ref: '#/components/schemas/GatewayRouteData' - description: The full description of your gateway route. VirtualNodeHttp2ConnectionPool: type: object required: - maxRequests properties: maxRequests: allOf: - $ref: '#/components/schemas/MaxRequests' - description: Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster. description: An object that represents a type of connection pool. AwsCloudMapName: type: string minLength: 1 maxLength: 1024 HeaderName: type: string minLength: 1 maxLength: 50 AwsCloudMapInstanceAttributeValue: type: string pattern: ^([a-zA-Z0-9!-~][ a-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}$ minLength: 1 maxLength: 1024 CreateRouteOutput: type: object required: - route properties: route: allOf: - $ref: '#/components/schemas/RouteData' - description: The full description of your mesh following the create call. description: ForbiddenException: {} HttpQueryParameters: type: array items: $ref: '#/components/schemas/HttpQueryParameter' minItems: 1 maxItems: 10 VirtualGatewayCertificateAuthorityArns: type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 3 VirtualGatewayLogging: type: object properties: accessLog: allOf: - $ref: '#/components/schemas/VirtualGatewayAccessLog' - description: The access log configuration. description: An object that represents logging information. OutlierDetection: type: object required: - baseEjectionDuration - interval - maxEjectionPercent - maxServerErrors properties: baseEjectionDuration: allOf: - $ref: '#/components/schemas/Duration' - description: The base amount of time for which a host is ejected. interval: allOf: - $ref: '#/components/schemas/Duration' - description: The time interval between ejection sweep analysis. maxEjectionPercent: allOf: - $ref: '#/components/schemas/OutlierDetectionMaxEjectionPercent' - description: 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. maxServerErrors: allOf: - $ref: '#/components/schemas/OutlierDetectionMaxServerErrors' - description: 'Number of consecutive 5xx errors required for ejection. ' description: An object that represents the outlier detection for a virtual node's listener. VirtualGatewayListenerTlsSdsCertificate: type: object required: - secretName properties: secretName: allOf: - $ref: '#/components/schemas/VirtualGatewaySdsSecretName' - description: 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. description: '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 MeshTLS documentation for more info. ' HeaderMatch: type: string minLength: 1 maxLength: 255 JsonKey: type: string minLength: 1 maxLength: 100 HttpGatewayRouteHeaders: type: array items: $ref: '#/components/schemas/HttpGatewayRouteHeader' minItems: 1 maxItems: 10 SdsSecretName: type: string UpdateMeshOutput: type: object required: - mesh properties: mesh: $ref: '#/components/schemas/MeshData' description: VirtualGatewayHealthCheckIntervalMillis: type: integer minimum: 5000 maximum: 300000 ResourceName: type: string minLength: 1 maxLength: 255 GatewayRouteHostnameMatch: type: object properties: exact: allOf: - $ref: '#/components/schemas/ExactHostName' - description: The exact host name to match on. suffix: allOf: - $ref: '#/components/schemas/SuffixHostname' - description: The specified ending characters of the host name to match on. description: An object representing the gateway route host name to match. ListenerTimeout: type: object properties: grpc: allOf: - $ref: '#/components/schemas/GrpcTimeout' - description: 'An object that represents types of timeouts. ' http: allOf: - $ref: '#/components/schemas/HttpTimeout' - description: 'An object that represents types of timeouts. ' http2: allOf: - $ref: '#/components/schemas/HttpTimeout' - description: 'An object that represents types of timeouts. ' tcp: allOf: - $ref: '#/components/schemas/TcpTimeout' - description: 'An object that represents types of timeouts. ' description: An object that represents timeouts for different protocols. GrpcRetryPolicyEvents: type: array items: $ref: '#/components/schemas/GrpcRetryPolicyEvent' minItems: 1 maxItems: 5 DescribeVirtualServiceOutput: type: object required: - virtualService properties: virtualService: allOf: - $ref: '#/components/schemas/VirtualServiceData' - description: The full description of your virtual service. description: AwsCloudMapInstanceAttributes: type: array items: $ref: '#/components/schemas/AwsCloudMapInstanceAttribute' QueryParameterMatch: type: object properties: exact: allOf: - $ref: '#/components/schemas/String' - description: The exact query parameter to match on. description: An object representing the query parameter to match. HttpRouteMatch: type: object properties: headers: allOf: - $ref: '#/components/schemas/HttpRouteHeaders' - description: The client request headers to match on. method: allOf: - $ref: '#/components/schemas/HttpMethod' - description: The client request method to match on. Specify only one. path: allOf: - $ref: '#/components/schemas/HttpPathMatch' - description: The client request path to match on. port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number to match on. prefix: allOf: - $ref: '#/components/schemas/String' - description: Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics. queryParameters: allOf: - $ref: '#/components/schemas/HttpQueryParameters' - description: The client request query parameters to match on. scheme: allOf: - $ref: '#/components/schemas/HttpScheme' - description: The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. description: An object that represents the requirements for a route to match HTTP requests for a virtual router. DeleteVirtualGatewayOutput: type: object required: - virtualGateway properties: virtualGateway: allOf: - $ref: '#/components/schemas/VirtualGatewayData' - description: The virtual gateway that was deleted. GrpcGatewayRouteAction: type: object required: - target properties: rewrite: allOf: - $ref: '#/components/schemas/GrpcGatewayRouteRewrite' - description: The gateway route action to rewrite. target: allOf: - $ref: '#/components/schemas/GatewayRouteTarget' - description: An object that represents the target that traffic is routed to when a request matches the gateway route. description: An object that represents the action to take if a match is determined. GrpcRoute: type: object required: - action - match properties: action: allOf: - $ref: '#/components/schemas/GrpcRouteAction' - description: An object that represents the action to take if a match is determined. match: allOf: - $ref: '#/components/schemas/GrpcRouteMatch' - description: An object that represents the criteria for determining a request match. retryPolicy: allOf: - $ref: '#/components/schemas/GrpcRetryPolicy' - description: An object that represents a retry policy. timeout: allOf: - $ref: '#/components/schemas/GrpcTimeout' - description: 'An object that represents types of timeouts. ' description: An object that represents a gRPC route type. ListenerTlsFileCertificate: type: object required: - certificateChain - privateKey properties: certificateChain: allOf: - $ref: '#/components/schemas/FilePath' - description: The certificate chain for the certificate. privateKey: allOf: - $ref: '#/components/schemas/FilePath' - description: The private key for a certificate stored on the file system of the virtual node that the proxy is running on. description: 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 Transport Layer Security (TLS). GrpcGatewayRouteMatch: type: object properties: hostname: allOf: - $ref: '#/components/schemas/GatewayRouteHostnameMatch' - description: The gateway route host name to be matched on. metadata: allOf: - $ref: '#/components/schemas/GrpcGatewayRouteMetadataList' - description: The gateway route metadata to be matched on. port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number to match from the request. serviceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The fully qualified domain name for the service to match from the request. description: An object that represents the criteria for determining a request match. FilePath: type: string minLength: 1 maxLength: 255 TcpRouteMatch: type: object properties: port: allOf: - $ref: '#/components/schemas/ListenerPort' - description: The port number to match on. description: An object representing the TCP route to match. VirtualGatewayListenerTlsAcmCertificate: type: object required: - certificateArn properties: certificateArn: allOf: - $ref: '#/components/schemas/Arn' - description: 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 Transport Layer Security (TLS). description: An object that represents an Certificate Manager certificate. VirtualGatewayHttpConnectionPool: type: object required: - maxConnections properties: maxConnections: allOf: - $ref: '#/components/schemas/MaxConnections' - description: Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster. maxPendingRequests: allOf: - $ref: '#/components/schemas/MaxPendingRequests' - description: Number of overflowing requests after max_connections Envoy will queue to upstream cluster. description: An object that represents a type of connection pool. ClientPolicy: type: object properties: tls: allOf: - $ref: '#/components/schemas/ClientPolicyTls' - description: A reference to an object that represents a Transport Layer Security (TLS) client policy. description: An object that represents a client policy. VirtualRouterList: type: array items: $ref: '#/components/schemas/VirtualRouterRef' DescribeMeshOutput: type: object required: - mesh properties: mesh: allOf: - $ref: '#/components/schemas/MeshData' - description: The full description of your service mesh. description: HttpRouteAction: type: object required: - weightedTargets properties: weightedTargets: allOf: - $ref: '#/components/schemas/WeightedTargets' - description: An object that represents the targets that traffic is routed to when a request matches the route. description: An object that represents the action to take if a match is determined. TcpRetryPolicyEvent: type: string enum: - connection-error JsonFormatRef: type: object required: - key - value properties: key: allOf: - $ref: '#/components/schemas/JsonKey' - description: The specified key for the JSON. value: allOf: - $ref: '#/components/schemas/JsonValue' - description: The specified value for the JSON. description: An object that represents the key value pairs for the JSON. MatchRange: type: object required: - end - start properties: end: allOf: - $ref: '#/components/schemas/Long' - description: The end of the range. start: allOf: - $ref: '#/components/schemas/Long' - description: The start of the range. description: 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. RouteList: type: array items: $ref: '#/components/schemas/RouteRef' GrpcRouteMetadataMatchMethod: type: object properties: exact: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must match the specified value exactly. prefix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must begin with the specified characters. range: allOf: - $ref: '#/components/schemas/MatchRange' - description: An object that represents the range of values to match on. regex: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must include the specified characters. suffix: allOf: - $ref: '#/components/schemas/HeaderMatch' - description: The value sent by the client must end with the specified characters. description: An object that represents the match method. Specify one of the match values. CertificateAuthorityArns: type: array items: $ref: '#/components/schemas/Arn' minItems: 1 maxItems: 3 VirtualGatewayClientTlsCertificate: type: object properties: file: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsFileCertificate' - description: 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 Transport Layer Security (TLS) . sds: allOf: - $ref: '#/components/schemas/VirtualGatewayListenerTlsSdsCertificate' - description: A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate. description: An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate. VirtualNodeSpec: type: object properties: backendDefaults: allOf: - $ref: '#/components/schemas/BackendDefaults' - description: A reference to an object that represents the defaults for backends. backends: allOf: - $ref: '#/components/schemas/Backends' - description: The backends that the virtual node is expected to send outbound traffic to. listeners: allOf: - $ref: '#/components/schemas/Listeners' - description: The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener. logging: allOf: - $ref: '#/components/schemas/Logging' - description: The inbound and outbound access logging information for the virtual node. serviceDiscovery: allOf: - $ref: '#/components/schemas/ServiceDiscovery' - description: 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 listener, then you must specify service discovery information. description: An object that represents the specification of a virtual node. ListenerTlsAcmCertificate: type: object required: - certificateArn properties: certificateArn: allOf: - $ref: '#/components/schemas/Arn' - description: 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 Transport Layer Security (TLS). description: An object that represents an Certificate Manager certificate. CreateVirtualRouterOutput: type: object required: - virtualRouter properties: virtualRouter: allOf: - $ref: '#/components/schemas/VirtualRouterData' - description: The full description of your virtual router following the create call. description: LimitExceededException: {} parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/appmesh/