AWSAppMesh (AWS SDK for Java

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, and Kubernetes on AWS.

App Mesh supports microservice applications that use service discovery naming for their components. To use App Mesh, you must have an application running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. 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.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateMeshResult`	`createMesh(CreateMeshRequest createMeshRequest)` Creates a service mesh.
`CreateRouteResult`	`createRoute(CreateRouteRequest createRouteRequest)` Creates a route that is associated with a virtual router.
`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.
`DeleteMeshResult`	`deleteMesh(DeleteMeshRequest deleteMeshRequest)` Deletes an existing service mesh.
`DeleteRouteResult`	`deleteRoute(DeleteRouteRequest deleteRouteRequest)` Deletes an existing route.
`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.
`DescribeMeshResult`	`describeMesh(DescribeMeshRequest describeMeshRequest)` Describes an existing service mesh.
`DescribeRouteResult`	`describeRoute(DescribeRouteRequest describeRouteRequest)` Describes an existing route.
`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.
`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.
`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.
`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.
`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
  - createMesh
```
CreateMeshResult createMesh(CreateMeshRequest createMeshRequest)
```
    Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.
    
    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.
    
    Parameters:
    
    createMeshRequest -
    
    Returns:
    
    Result of the CreateMesh operation returned by the service.
    
    Throws:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    See Also:
    
    AWS API Documentation
  - createRoute
```
CreateRouteResult createRoute(CreateRouteRequest createRouteRequest)
```
    Creates a route that is associated with a virtual router.
    
    You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    
    If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.
    
    Parameters:
    
    createRouteRequest -
    
    Returns:
    
    Result of the CreateRoute operation returned by the service.
    
    Throws:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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 must specify the DNS service discovery hostname for your task group.
    
    Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.
    
    The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.
    
    If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.
    
    Parameters:
    
    createVirtualNodeRequest -
    
    Returns:
    
    Result of the CreateVirtualNode operation returned by the service.
    
    Throws:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    See Also:
    
    AWS API Documentation
  - createVirtualRouter
```
CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest createVirtualRouterRequest)
```
    Creates a virtual router within a service mesh.
    
    Any inbound traffic that your virtual router expects should be specified as a listener.
    
    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.
    
    Parameters:
    
    createVirtualRouterRequest -
    
    Returns:
    
    Result of the CreateVirtualRouter operation returned by the service.
    
    Throws:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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.
    
    Parameters:
    
    createVirtualServiceRequest -
    
    Returns:
    
    Result of the CreateVirtualService operation returned by the service.
    
    Throws:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ResourceInUseException - You can't delete the specified resource because it's in use or required by another resource.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ResourceInUseException - You can't delete the specified resource because it's in use or required by another resource.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ResourceInUseException - You can't delete the specified resource because it's in use or required by another resource.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ResourceInUseException - You can't delete the specified resource because it's in use or required by another resource.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    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.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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:
    
    BadRequestException - The request syntax was malformed. Check your request syntax and try again.
    
    ConflictException - The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.
    
    ForbiddenException - You don't have permissions to perform this action.
    
    InternalServerErrorException - The request processing has failed because of an unknown error, exception, or failure.
    
    LimitExceededException - You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.
    
    NotFoundException - The specified resource doesn't exist. Check your request syntax and try again.
    
    ServiceUnavailableException - The request has failed due to a temporary failure of the service.
    
    TooManyRequestsException - The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
    
    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.

Did this page help you?

Interface AWSAppMesh

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createMesh

createRoute

createVirtualNode

createVirtualRouter

createVirtualService

deleteMesh

deleteRoute

deleteVirtualNode

deleteVirtualRouter

deleteVirtualService

describeMesh

describeRoute

describeVirtualNode

describeVirtualRouter

describeVirtualService

listMeshes

listRoutes

listTagsForResource

listVirtualNodes

listVirtualRouters

listVirtualServices

tagResource

untagResource

updateMesh

updateRoute

updateVirtualNode

updateVirtualRouter

updateVirtualService

shutdown

getCachedResponseMetadata