@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAppMeshClient extends AmazonWebServiceClient implements AWSAppMesh
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSAppMeshClientBuilder |
builder() |
CreateGatewayRouteResult |
createGatewayRoute(CreateGatewayRouteRequest request)
Creates a gateway route.
|
CreateMeshResult |
createMesh(CreateMeshRequest request)
Creates a service mesh.
|
CreateRouteResult |
createRoute(CreateRouteRequest request)
Creates a route that is associated with a virtual router.
|
CreateVirtualGatewayResult |
createVirtualGateway(CreateVirtualGatewayRequest request)
Creates a virtual gateway.
|
CreateVirtualNodeResult |
createVirtualNode(CreateVirtualNodeRequest request)
Creates a virtual node within a service mesh.
|
CreateVirtualRouterResult |
createVirtualRouter(CreateVirtualRouterRequest request)
Creates a virtual router within a service mesh.
|
CreateVirtualServiceResult |
createVirtualService(CreateVirtualServiceRequest request)
Creates a virtual service within a service mesh.
|
DeleteGatewayRouteResult |
deleteGatewayRoute(DeleteGatewayRouteRequest request)
Deletes an existing gateway route.
|
DeleteMeshResult |
deleteMesh(DeleteMeshRequest request)
Deletes an existing service mesh.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest request)
Deletes an existing route.
|
DeleteVirtualGatewayResult |
deleteVirtualGateway(DeleteVirtualGatewayRequest request)
Deletes an existing virtual gateway.
|
DeleteVirtualNodeResult |
deleteVirtualNode(DeleteVirtualNodeRequest request)
Deletes an existing virtual node.
|
DeleteVirtualRouterResult |
deleteVirtualRouter(DeleteVirtualRouterRequest request)
Deletes an existing virtual router.
|
DeleteVirtualServiceResult |
deleteVirtualService(DeleteVirtualServiceRequest request)
Deletes an existing virtual service.
|
DescribeGatewayRouteResult |
describeGatewayRoute(DescribeGatewayRouteRequest request)
Describes an existing gateway route.
|
DescribeMeshResult |
describeMesh(DescribeMeshRequest request)
Describes an existing service mesh.
|
DescribeRouteResult |
describeRoute(DescribeRouteRequest request)
Describes an existing route.
|
DescribeVirtualGatewayResult |
describeVirtualGateway(DescribeVirtualGatewayRequest request)
Describes an existing virtual gateway.
|
DescribeVirtualNodeResult |
describeVirtualNode(DescribeVirtualNodeRequest request)
Describes an existing virtual node.
|
DescribeVirtualRouterResult |
describeVirtualRouter(DescribeVirtualRouterRequest request)
Describes an existing virtual router.
|
DescribeVirtualServiceResult |
describeVirtualService(DescribeVirtualServiceRequest request)
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 request)
Returns a list of existing gateway routes that are associated to a virtual gateway.
|
ListMeshesResult |
listMeshes(ListMeshesRequest request)
Returns a list of existing service meshes.
|
ListRoutesResult |
listRoutes(ListRoutesRequest request)
Returns a list of existing routes in a service mesh.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List the tags for an App Mesh resource.
|
ListVirtualGatewaysResult |
listVirtualGateways(ListVirtualGatewaysRequest request)
Returns a list of existing virtual gateways in a service mesh.
|
ListVirtualNodesResult |
listVirtualNodes(ListVirtualNodesRequest request)
Returns a list of existing virtual nodes.
|
ListVirtualRoutersResult |
listVirtualRouters(ListVirtualRoutersRequest request)
Returns a list of existing virtual routers in a service mesh.
|
ListVirtualServicesResult |
listVirtualServices(ListVirtualServicesRequest request)
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 request)
Associates the specified tags to a resource with the specified
resourceArn . |
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
|
UpdateGatewayRouteResult |
updateGatewayRoute(UpdateGatewayRouteRequest request)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
|
UpdateMeshResult |
updateMesh(UpdateMeshRequest request)
Updates an existing service mesh.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest request)
Updates an existing route for a specified service mesh and virtual router.
|
UpdateVirtualGatewayResult |
updateVirtualGateway(UpdateVirtualGatewayRequest request)
Updates an existing virtual gateway in a specified service mesh.
|
UpdateVirtualNodeResult |
updateVirtualNode(UpdateVirtualNodeRequest request)
Updates an existing virtual node in a specified service mesh.
|
UpdateVirtualRouterResult |
updateVirtualRouter(UpdateVirtualRouterRequest request)
Updates an existing virtual router in a specified service mesh.
|
UpdateVirtualServiceResult |
updateVirtualService(UpdateVirtualServiceRequest request)
Updates an existing virtual service in a specified service mesh.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSAppMeshClientBuilder builder()
public CreateGatewayRouteResult createGatewayRoute(CreateGatewayRouteRequest request)
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.
createGatewayRoute
in interface AWSAppMesh
createGatewayRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateMeshResult createMesh(CreateMeshRequest request)
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.
createMesh
in interface AWSAppMesh
createMeshRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateRouteResult createRoute(CreateRouteRequest request)
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.
createRoute
in interface AWSAppMesh
createRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateVirtualGatewayResult createVirtualGateway(CreateVirtualGatewayRequest request)
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.
createVirtualGateway
in interface AWSAppMesh
createVirtualGatewayRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest request)
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.
createVirtualNode
in interface AWSAppMesh
createVirtualNodeRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest request)
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.
createVirtualRouter
in interface AWSAppMesh
createVirtualRouterRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public CreateVirtualServiceResult createVirtualService(CreateVirtualServiceRequest request)
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.
createVirtualService
in interface AWSAppMesh
createVirtualServiceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public DeleteGatewayRouteResult deleteGatewayRoute(DeleteGatewayRouteRequest request)
Deletes an existing gateway route.
deleteGatewayRoute
in interface AWSAppMesh
deleteGatewayRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteMeshResult deleteMesh(DeleteMeshRequest request)
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.
deleteMesh
in interface AWSAppMesh
deleteMeshRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
Deletes an existing route.
deleteRoute
in interface AWSAppMesh
deleteRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteVirtualGatewayResult deleteVirtualGateway(DeleteVirtualGatewayRequest request)
Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
deleteVirtualGateway
in interface AWSAppMesh
deleteVirtualGatewayRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest request)
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.
deleteVirtualNode
in interface AWSAppMesh
deleteVirtualNodeRequest
- Deletes a virtual node input.NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteVirtualRouterResult deleteVirtualRouter(DeleteVirtualRouterRequest request)
Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the router itself.
deleteVirtualRouter
in interface AWSAppMesh
deleteVirtualRouterRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DeleteVirtualServiceResult deleteVirtualService(DeleteVirtualServiceRequest request)
Deletes an existing virtual service.
deleteVirtualService
in interface AWSAppMesh
deleteVirtualServiceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.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.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeGatewayRouteResult describeGatewayRoute(DescribeGatewayRouteRequest request)
Describes an existing gateway route.
describeGatewayRoute
in interface AWSAppMesh
describeGatewayRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeMeshResult describeMesh(DescribeMeshRequest request)
Describes an existing service mesh.
describeMesh
in interface AWSAppMesh
describeMeshRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeRouteResult describeRoute(DescribeRouteRequest request)
Describes an existing route.
describeRoute
in interface AWSAppMesh
describeRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeVirtualGatewayResult describeVirtualGateway(DescribeVirtualGatewayRequest request)
Describes an existing virtual gateway.
describeVirtualGateway
in interface AWSAppMesh
describeVirtualGatewayRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest request)
Describes an existing virtual node.
describeVirtualNode
in interface AWSAppMesh
describeVirtualNodeRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest request)
Describes an existing virtual router.
describeVirtualRouter
in interface AWSAppMesh
describeVirtualRouterRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public DescribeVirtualServiceResult describeVirtualService(DescribeVirtualServiceRequest request)
Describes an existing virtual service.
describeVirtualService
in interface AWSAppMesh
describeVirtualServiceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListGatewayRoutesResult listGatewayRoutes(ListGatewayRoutesRequest request)
Returns a list of existing gateway routes that are associated to a virtual gateway.
listGatewayRoutes
in interface AWSAppMesh
listGatewayRoutesRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListMeshesResult listMeshes(ListMeshesRequest request)
Returns a list of existing service meshes.
listMeshes
in interface AWSAppMesh
listMeshesRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListRoutesResult listRoutes(ListRoutesRequest request)
Returns a list of existing routes in a service mesh.
listRoutes
in interface AWSAppMesh
listRoutesRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List the tags for an App Mesh resource.
listTagsForResource
in interface AWSAppMesh
listTagsForResourceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListVirtualGatewaysResult listVirtualGateways(ListVirtualGatewaysRequest request)
Returns a list of existing virtual gateways in a service mesh.
listVirtualGateways
in interface AWSAppMesh
listVirtualGatewaysRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest request)
Returns a list of existing virtual nodes.
listVirtualNodes
in interface AWSAppMesh
listVirtualNodesRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest request)
Returns a list of existing virtual routers in a service mesh.
listVirtualRouters
in interface AWSAppMesh
listVirtualRoutersRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public ListVirtualServicesResult listVirtualServices(ListVirtualServicesRequest request)
Returns a list of existing virtual services in a service mesh.
listVirtualServices
in interface AWSAppMesh
listVirtualServicesRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource
in interface AWSAppMesh
tagResourceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
untagResource
in interface AWSAppMesh
untagResourceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.BadRequestException
- The request syntax was malformed. Check your request syntax and try again.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public UpdateGatewayRouteResult updateGatewayRoute(UpdateGatewayRouteRequest request)
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
updateGatewayRoute
in interface AWSAppMesh
updateGatewayRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public UpdateMeshResult updateMesh(UpdateMeshRequest request)
Updates an existing service mesh.
updateMesh
in interface AWSAppMesh
updateMeshRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.InternalServerErrorException
- The request processing has failed because of an unknown error, exception, or failure.public UpdateRouteResult updateRoute(UpdateRouteRequest request)
Updates an existing route for a specified service mesh and virtual router.
updateRoute
in interface AWSAppMesh
updateRouteRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public UpdateVirtualGatewayResult updateVirtualGateway(UpdateVirtualGatewayRequest request)
Updates an existing virtual gateway in a specified service mesh.
updateVirtualGateway
in interface AWSAppMesh
updateVirtualGatewayRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest request)
Updates an existing virtual node in a specified service mesh.
updateVirtualNode
in interface AWSAppMesh
updateVirtualNodeRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest request)
Updates an existing virtual router in a specified service mesh.
updateVirtualRouter
in interface AWSAppMesh
updateVirtualRouterRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public UpdateVirtualServiceResult updateVirtualService(UpdateVirtualServiceRequest request)
Updates an existing virtual service in a specified service mesh.
updateVirtualService
in interface AWSAppMesh
updateVirtualServiceRequest
- NotFoundException
- The specified resource doesn't exist. Check your request syntax and try again.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.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.ForbiddenException
- You don't have permissions to perform this action.ServiceUnavailableException
- The request has failed due to a temporary failure of the service.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 App Mesh User Guide.public 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 the request.
getCachedResponseMetadata
in interface AWSAppMesh
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSAppMesh
shutdown
in class AmazonWebServiceClient