@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppMesh
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppMesh
instead.
AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, and Amazon EC2.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateGatewayRouteResult |
createGatewayRoute(CreateGatewayRouteRequest createGatewayRouteRequest)
Creates a gateway route.
|
CreateMeshResult |
createMesh(CreateMeshRequest createMeshRequest)
Creates a service mesh.
|
CreateRouteResult |
createRoute(CreateRouteRequest createRouteRequest)
Creates a route that is associated with a virtual router.
|
CreateVirtualGatewayResult |
createVirtualGateway(CreateVirtualGatewayRequest createVirtualGatewayRequest)
Creates a virtual gateway.
|
CreateVirtualNodeResult |
createVirtualNode(CreateVirtualNodeRequest createVirtualNodeRequest)
Creates a virtual node within a service mesh.
|
CreateVirtualRouterResult |
createVirtualRouter(CreateVirtualRouterRequest createVirtualRouterRequest)
Creates a virtual router within a service mesh.
|
CreateVirtualServiceResult |
createVirtualService(CreateVirtualServiceRequest createVirtualServiceRequest)
Creates a virtual service within a service mesh.
|
DeleteGatewayRouteResult |
deleteGatewayRoute(DeleteGatewayRouteRequest deleteGatewayRouteRequest)
Deletes an existing gateway route.
|
DeleteMeshResult |
deleteMesh(DeleteMeshRequest deleteMeshRequest)
Deletes an existing service mesh.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes an existing route.
|
DeleteVirtualGatewayResult |
deleteVirtualGateway(DeleteVirtualGatewayRequest deleteVirtualGatewayRequest)
Deletes an existing virtual gateway.
|
DeleteVirtualNodeResult |
deleteVirtualNode(DeleteVirtualNodeRequest deleteVirtualNodeRequest)
Deletes an existing virtual node.
|
DeleteVirtualRouterResult |
deleteVirtualRouter(DeleteVirtualRouterRequest deleteVirtualRouterRequest)
Deletes an existing virtual router.
|
DeleteVirtualServiceResult |
deleteVirtualService(DeleteVirtualServiceRequest deleteVirtualServiceRequest)
Deletes an existing virtual service.
|
DescribeGatewayRouteResult |
describeGatewayRoute(DescribeGatewayRouteRequest describeGatewayRouteRequest)
Describes an existing gateway route.
|
DescribeMeshResult |
describeMesh(DescribeMeshRequest describeMeshRequest)
Describes an existing service mesh.
|
DescribeRouteResult |
describeRoute(DescribeRouteRequest describeRouteRequest)
Describes an existing route.
|
DescribeVirtualGatewayResult |
describeVirtualGateway(DescribeVirtualGatewayRequest describeVirtualGatewayRequest)
Describes an existing virtual gateway.
|
DescribeVirtualNodeResult |
describeVirtualNode(DescribeVirtualNodeRequest describeVirtualNodeRequest)
Describes an existing virtual node.
|
DescribeVirtualRouterResult |
describeVirtualRouter(DescribeVirtualRouterRequest describeVirtualRouterRequest)
Describes an existing virtual router.
|
DescribeVirtualServiceResult |
describeVirtualService(DescribeVirtualServiceRequest describeVirtualServiceRequest)
Describes an existing virtual service.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListGatewayRoutesResult |
listGatewayRoutes(ListGatewayRoutesRequest listGatewayRoutesRequest)
Returns a list of existing gateway routes that are associated to a virtual gateway.
|
ListMeshesResult |
listMeshes(ListMeshesRequest listMeshesRequest)
Returns a list of existing service meshes.
|
ListRoutesResult |
listRoutes(ListRoutesRequest listRoutesRequest)
Returns a list of existing routes in a service mesh.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an App Mesh resource.
|
ListVirtualGatewaysResult |
listVirtualGateways(ListVirtualGatewaysRequest listVirtualGatewaysRequest)
Returns a list of existing virtual gateways in a service mesh.
|
ListVirtualNodesResult |
listVirtualNodes(ListVirtualNodesRequest listVirtualNodesRequest)
Returns a list of existing virtual nodes.
|
ListVirtualRoutersResult |
listVirtualRouters(ListVirtualRoutersRequest listVirtualRoutersRequest)
Returns a list of existing virtual routers in a service mesh.
|
ListVirtualServicesResult |
listVirtualServices(ListVirtualServicesRequest listVirtualServicesRequest)
Returns a list of existing virtual services in a service mesh.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn . |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
UpdateGatewayRouteResult |
updateGatewayRoute(UpdateGatewayRouteRequest updateGatewayRouteRequest)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
|
UpdateMeshResult |
updateMesh(UpdateMeshRequest updateMeshRequest)
Updates an existing service mesh.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest updateRouteRequest)
Updates an existing route for a specified service mesh and virtual router.
|
UpdateVirtualGatewayResult |
updateVirtualGateway(UpdateVirtualGatewayRequest updateVirtualGatewayRequest)
Updates an existing virtual gateway in a specified service mesh.
|
UpdateVirtualNodeResult |
updateVirtualNode(UpdateVirtualNodeRequest updateVirtualNodeRequest)
Updates an existing virtual node in a specified service mesh.
|
UpdateVirtualRouterResult |
updateVirtualRouter(UpdateVirtualRouterRequest updateVirtualRouterRequest)
Updates an existing virtual router in a specified service mesh.
|
UpdateVirtualServiceResult |
updateVirtualService(UpdateVirtualServiceRequest updateVirtualServiceRequest)
Updates an existing virtual service in a specified service mesh.
|
static final String ENDPOINT_PREFIX
CreateGatewayRouteResult createGatewayRoute(CreateGatewayRouteRequest createGatewayRouteRequest)
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.
createGatewayRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateMeshResult createMesh(CreateMeshRequest createMeshRequest)
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.
createMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateRouteResult createRoute(CreateRouteRequest createRouteRequest)
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.
createRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateVirtualGatewayResult createVirtualGateway(CreateVirtualGatewayRequest createVirtualGatewayRequest)
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.
createVirtualGatewayRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest createVirtualNodeRequest)
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 (either the full ARN or the truncated resource name: for example,
mesh/default/virtualNode/simpleapp
) as the APPMESH_VIRTUAL_NODE_NAME
environment
variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to
the node.id
and node.cluster
Envoy parameters.
If you require your Envoy stats or tracing to use a different name, you can override the
node.cluster
value that is set by APPMESH_VIRTUAL_NODE_NAME
with the
APPMESH_VIRTUAL_NODE_CLUSTER
environment variable.
For more information about virtual nodes, see Virtual nodes.
createVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest createVirtualRouterRequest)
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.
createVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.CreateVirtualServiceResult createVirtualService(CreateVirtualServiceRequest createVirtualServiceRequest)
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.
createVirtualServiceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteGatewayRouteResult deleteGatewayRoute(DeleteGatewayRouteRequest deleteGatewayRouteRequest)
Deletes an existing gateway route.
deleteGatewayRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteMeshResult deleteMesh(DeleteMeshRequest deleteMeshRequest)
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.
deleteMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteRouteResult deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes an existing route.
deleteRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteVirtualGatewayResult deleteVirtualGateway(DeleteVirtualGatewayRequest deleteVirtualGatewayRequest)
Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
deleteVirtualGatewayRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest deleteVirtualNodeRequest)
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.
deleteVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteVirtualRouterResult deleteVirtualRouter(DeleteVirtualRouterRequest deleteVirtualRouterRequest)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
deleteVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DeleteVirtualServiceResult deleteVirtualService(DeleteVirtualServiceRequest deleteVirtualServiceRequest)
Deletes an existing virtual service.
deleteVirtualServiceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ResourceInUseException
- You can't delete the specified resource because it's in use or required by another resource.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeGatewayRouteResult describeGatewayRoute(DescribeGatewayRouteRequest describeGatewayRouteRequest)
Describes an existing gateway route.
describeGatewayRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeMeshResult describeMesh(DescribeMeshRequest describeMeshRequest)
Describes an existing service mesh.
describeMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeRouteResult describeRoute(DescribeRouteRequest describeRouteRequest)
Describes an existing route.
describeRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeVirtualGatewayResult describeVirtualGateway(DescribeVirtualGatewayRequest describeVirtualGatewayRequest)
Describes an existing virtual gateway.
describeVirtualGatewayRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest describeVirtualNodeRequest)
Describes an existing virtual node.
describeVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest describeVirtualRouterRequest)
Describes an existing virtual router.
describeVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.DescribeVirtualServiceResult describeVirtualService(DescribeVirtualServiceRequest describeVirtualServiceRequest)
Describes an existing virtual service.
describeVirtualServiceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListGatewayRoutesResult listGatewayRoutes(ListGatewayRoutesRequest listGatewayRoutesRequest)
Returns a list of existing gateway routes that are associated to a virtual gateway.
listGatewayRoutesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListMeshesResult listMeshes(ListMeshesRequest listMeshesRequest)
Returns a list of existing service meshes.
listMeshesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListRoutesResult listRoutes(ListRoutesRequest listRoutesRequest)
Returns a list of existing routes in a service mesh.
listRoutesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an App Mesh resource.
listTagsForResourceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListVirtualGatewaysResult listVirtualGateways(ListVirtualGatewaysRequest listVirtualGatewaysRequest)
Returns a list of existing virtual gateways in a service mesh.
listVirtualGatewaysRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest listVirtualNodesRequest)
Returns a list of existing virtual nodes.
listVirtualNodesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest listVirtualRoutersRequest)
Returns a list of existing virtual routers in a service mesh.
listVirtualRoutersRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.ListVirtualServicesResult listVirtualServices(ListVirtualServicesRequest listVirtualServicesRequest)
Returns a list of existing virtual services in a service mesh.
listVirtualServicesRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.TooManyTagsException
- The request exceeds the maximum allowed number of tags allowed per resource. The current limit is 50 user
tags per resource. You must reduce the number of tags in the request. None of the tags in this request
were applied.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateGatewayRouteResult updateGatewayRoute(UpdateGatewayRouteRequest updateGatewayRouteRequest)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
updateGatewayRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateMeshResult updateMesh(UpdateMeshRequest updateMeshRequest)
Updates an existing service mesh.
updateMeshRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateRouteResult updateRoute(UpdateRouteRequest updateRouteRequest)
Updates an existing route for a specified service mesh and virtual router.
updateRouteRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateVirtualGatewayResult updateVirtualGateway(UpdateVirtualGatewayRequest updateVirtualGatewayRequest)
Updates an existing virtual gateway in a specified service mesh.
updateVirtualGatewayRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest updateVirtualNodeRequest)
Updates an existing virtual node in a specified service mesh.
updateVirtualNodeRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest updateVirtualRouterRequest)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouterRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.UpdateVirtualServiceResult updateVirtualService(UpdateVirtualServiceRequest updateVirtualServiceRequest)
Updates an existing virtual service in a specified service mesh.
updateVirtualServiceRequest
- BadRequestException
- The request syntax was malformed. Check your request syntax and try again.ConflictException
- The request contains a client token that was used for a previous update resource call with different
specifications. Try the request again with a new client token.ForbiddenException
- You don't have permissions to perform this action.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.LimitExceededException
- You have exceeded a service limit for your account. For more information, see Service Limits in
the AWS App Mesh User Guide.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.TooManyRequestsException
- The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best
results, use an increasing or variable sleep interval between requests.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.