com.amazonaws.services.appmesh

Interface AWSAppMesh

All Known Subinterfaces:

AWSAppMeshAsync

All Known Implementing Classes:

AbstractAWSAppMesh, AbstractAWSAppMeshAsync, AWSAppMeshAsyncClient, AWSAppMeshClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppMesh

Interface for accessing AWS App Mesh.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createGatewayRoute

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.

Parameters:

createGatewayRouteRequest -

Returns:

Result of the CreateGatewayRoute operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createMesh

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.

Parameters:

createMeshRequest -

Returns:

Result of the CreateMesh operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createRoute

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.

Parameters:

createRouteRequest -

Returns:

Result of the CreateRoute operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createVirtualGateway

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.

Parameters:

createVirtualGatewayRequest -

Returns:

Result of the CreateVirtualGateway operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createVirtualNode

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 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.

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

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 about App Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

Parameters:

createVirtualNodeRequest -

Returns:

Result of the CreateVirtualNode operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createVirtualRouter

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.

Parameters:

createVirtualRouterRequest -

Returns:

Result of the CreateVirtualRouter operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

createVirtualService

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.

Parameters:

createVirtualServiceRequest -

Returns:

Result of the CreateVirtualService operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

deleteGatewayRoute

DeleteGatewayRouteResult deleteGatewayRoute(DeleteGatewayRouteRequest deleteGatewayRouteRequest)

Deletes an existing gateway route.

Parameters:

deleteGatewayRouteRequest -

Returns:

Result of the DeleteGatewayRoute operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteMesh

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.

Parameters:

deleteMeshRequest -

Returns:

Result of the DeleteMesh operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteRoute

DeleteRouteResult deleteRoute(DeleteRouteRequest deleteRouteRequest)

Deletes an existing route.

Parameters:

deleteRouteRequest -

Returns:

Result of the DeleteRoute operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteVirtualGateway

DeleteVirtualGatewayResult deleteVirtualGateway(DeleteVirtualGatewayRequest deleteVirtualGatewayRequest)

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.

Parameters:

deleteVirtualGatewayRequest -

Returns:

Result of the DeleteVirtualGateway operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteVirtualNode

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.

Parameters:

deleteVirtualNodeRequest -

Returns:

Result of the DeleteVirtualNode operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteVirtualRouter

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.

Parameters:

deleteVirtualRouterRequest -

Returns:

Result of the DeleteVirtualRouter operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteVirtualService

DeleteVirtualServiceResult deleteVirtualService(DeleteVirtualServiceRequest deleteVirtualServiceRequest)

Deletes an existing virtual service.

Parameters:

deleteVirtualServiceRequest -

Returns:

Result of the DeleteVirtualService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeGatewayRoute

DescribeGatewayRouteResult describeGatewayRoute(DescribeGatewayRouteRequest describeGatewayRouteRequest)

Describes an existing gateway route.

Parameters:

describeGatewayRouteRequest -

Returns:

Result of the DescribeGatewayRoute operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeMesh

DescribeMeshResult describeMesh(DescribeMeshRequest describeMeshRequest)

Describes an existing service mesh.

Parameters:

describeMeshRequest -

Returns:

Result of the DescribeMesh operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeRoute

DescribeRouteResult describeRoute(DescribeRouteRequest describeRouteRequest)

Describes an existing route.

Parameters:

describeRouteRequest -

Returns:

Result of the DescribeRoute operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeVirtualGateway

DescribeVirtualGatewayResult describeVirtualGateway(DescribeVirtualGatewayRequest describeVirtualGatewayRequest)

Describes an existing virtual gateway.

Parameters:

describeVirtualGatewayRequest -

Returns:

Result of the DescribeVirtualGateway operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeVirtualNode

DescribeVirtualNodeResult describeVirtualNode(DescribeVirtualNodeRequest describeVirtualNodeRequest)

Describes an existing virtual node.

Parameters:

describeVirtualNodeRequest -

Returns:

Result of the DescribeVirtualNode operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeVirtualRouter

DescribeVirtualRouterResult describeVirtualRouter(DescribeVirtualRouterRequest describeVirtualRouterRequest)

Describes an existing virtual router.

Parameters:

describeVirtualRouterRequest -

Returns:

Result of the DescribeVirtualRouter operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeVirtualService

DescribeVirtualServiceResult describeVirtualService(DescribeVirtualServiceRequest describeVirtualServiceRequest)

Describes an existing virtual service.

Parameters:

describeVirtualServiceRequest -

Returns:

Result of the DescribeVirtualService operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listGatewayRoutes

ListGatewayRoutesResult listGatewayRoutes(ListGatewayRoutesRequest listGatewayRoutesRequest)

Returns a list of existing gateway routes that are associated to a virtual gateway.

Parameters:

listGatewayRoutesRequest -

Returns:

Result of the ListGatewayRoutes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listMeshes

ListMeshesResult listMeshes(ListMeshesRequest listMeshesRequest)

Returns a list of existing service meshes.

Parameters:

listMeshesRequest -

Returns:

Result of the ListMeshes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRoutes

ListRoutesResult listRoutes(ListRoutesRequest listRoutesRequest)

Returns a list of existing routes in a service mesh.

Parameters:

listRoutesRequest -

Returns:

Result of the ListRoutes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List the tags for an App Mesh resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listVirtualGateways

ListVirtualGatewaysResult listVirtualGateways(ListVirtualGatewaysRequest listVirtualGatewaysRequest)

Returns a list of existing virtual gateways in a service mesh.

Parameters:

listVirtualGatewaysRequest -

Returns:

Result of the ListVirtualGateways operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listVirtualNodes

ListVirtualNodesResult listVirtualNodes(ListVirtualNodesRequest listVirtualNodesRequest)

Returns a list of existing virtual nodes.

Parameters:

listVirtualNodesRequest -

Returns:

Result of the ListVirtualNodes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listVirtualRouters

ListVirtualRoutersResult listVirtualRouters(ListVirtualRoutersRequest listVirtualRoutersRequest)

Returns a list of existing virtual routers in a service mesh.

Parameters:

listVirtualRoutersRequest -

Returns:

Result of the ListVirtualRouters operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listVirtualServices

ListVirtualServicesResult listVirtualServices(ListVirtualServicesRequest listVirtualServicesRequest)

Returns a list of existing virtual services in a service mesh.

Parameters:

listVirtualServicesRequest -

Returns:

Result of the ListVirtualServices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deletes specified tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateGatewayRoute

UpdateGatewayRouteResult updateGatewayRoute(UpdateGatewayRouteRequest updateGatewayRouteRequest)

Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.

Parameters:

updateGatewayRouteRequest -

Returns:

Result of the UpdateGatewayRoute operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

updateMesh

UpdateMeshResult updateMesh(UpdateMeshRequest updateMeshRequest)

Updates an existing service mesh.

Parameters:

updateMeshRequest -

Returns:

Result of the UpdateMesh operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateRoute

UpdateRouteResult updateRoute(UpdateRouteRequest updateRouteRequest)

Updates an existing route for a specified service mesh and virtual router.

Parameters:

updateRouteRequest -

Returns:

Result of the UpdateRoute operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

updateVirtualGateway

UpdateVirtualGatewayResult updateVirtualGateway(UpdateVirtualGatewayRequest updateVirtualGatewayRequest)

Updates an existing virtual gateway in a specified service mesh.

Parameters:

updateVirtualGatewayRequest -

Returns:

Result of the UpdateVirtualGateway operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

updateVirtualNode

UpdateVirtualNodeResult updateVirtualNode(UpdateVirtualNodeRequest updateVirtualNodeRequest)

Updates an existing virtual node in a specified service mesh.

Parameters:

updateVirtualNodeRequest -

Returns:

Result of the UpdateVirtualNode operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

updateVirtualRouter

UpdateVirtualRouterResult updateVirtualRouter(UpdateVirtualRouterRequest updateVirtualRouterRequest)

Updates an existing virtual router in a specified service mesh.

Parameters:

updateVirtualRouterRequest -

Returns:

Result of the UpdateVirtualRouter operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

updateVirtualService

UpdateVirtualServiceResult updateVirtualService(UpdateVirtualServiceRequest updateVirtualServiceRequest)

Updates an existing virtual service in a specified service mesh.

Parameters:

updateVirtualServiceRequest -

Returns:

Result of the UpdateVirtualService operation returned by the service.

Throws:

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 AWS App Mesh User Guide.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.