JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.appmesh

Class AWSAppMeshClient

  • All Implemented Interfaces:
    AWSAppMesh
    Direct Known Subclasses:
    AWSAppMeshAsyncClient


    @ThreadSafe
     @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
    public class AWSAppMeshClient
    extends AmazonWebServiceClient
    implements AWSAppMesh 
    Client for accessing AWS App Mesh. All service calls made using this client are blocking, and will not return until the service call completes.

    App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.

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

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

    • Method Detail

      • createGatewayRoute

        public CreateGatewayRouteResult createGatewayRoute(CreateGatewayRouteRequest request)

        Creates a gateway route.

        A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

        For more information about gateway routes, see Gateway routes.

        Specified by:
        createGatewayRoute in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createMesh

        public CreateMeshResult createMesh(CreateMeshRequest request)

        Creates a service mesh.

        A service mesh is a logical boundary for network traffic between services that are represented by resources within the mesh. After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

        For more information about service meshes, see Service meshes.

        Specified by:
        createMesh in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createRoute

        public CreateRouteResult createRoute(CreateRouteRequest request)

        Creates a route that is associated with a virtual router.

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

        For more information about routes, see Routes.

        Specified by:
        createRoute in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createVirtualGateway

        public CreateVirtualGatewayResult createVirtualGateway(CreateVirtualGatewayRequest request)

        Creates a virtual gateway.

        A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

        For more information about virtual gateways, see Virtual gateways.

        Specified by:
        createVirtualGateway in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createVirtualNode

        public CreateVirtualNodeResult createVirtualNode(CreateVirtualNodeRequest request)

        Creates a virtual node within a service mesh.

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

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

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

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

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

        Specified by:
        createVirtualNode in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createVirtualRouter

        public CreateVirtualRouterResult createVirtualRouter(CreateVirtualRouterRequest request)

        Creates a virtual router within a service mesh.

        Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

        For more information about virtual routers, see Virtual routers.

        Specified by:
        createVirtualRouter in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • createVirtualService

        public CreateVirtualServiceResult createVirtualService(CreateVirtualServiceRequest request)

        Creates a virtual service within a service mesh.

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

        For more information about virtual services, see Virtual services.

        Specified by:
        createVirtualService in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • deleteMesh

        public DeleteMeshResult deleteMesh(DeleteMeshRequest request)

        Deletes an existing service mesh.

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

        Specified by:
        deleteMesh in interface AWSAppMesh
        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
      • deleteVirtualNode

        public DeleteVirtualNodeResult deleteVirtualNode(DeleteVirtualNodeRequest request)

        Deletes an existing virtual node.

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

        Specified by:
        deleteVirtualNode in interface AWSAppMesh
        Parameters:
        deleteVirtualNodeRequest - Deletes a virtual node input.
        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
      • tagResource

        public TagResourceResult tagResource(TagResourceRequest request)

        Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

        Specified by:
        tagResource in interface AWSAppMesh
        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
      • updateGatewayRoute

        public UpdateGatewayRouteResult updateGatewayRoute(UpdateGatewayRouteRequest request)

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

        Specified by:
        updateGatewayRoute in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • updateMesh

        public UpdateMeshResult updateMesh(UpdateMeshRequest request)

        Updates an existing service mesh.

        Specified by:
        updateMesh in interface AWSAppMesh
        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

        public UpdateRouteResult updateRoute(UpdateRouteRequest request)

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

        Specified by:
        updateRoute in interface AWSAppMesh
        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 App Mesh User Guide.
        See Also:
        AWS API Documentation
      • getCachedResponseMetadata

        public 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 the request.

        Specified by:
        getCachedResponseMetadata in interface AWSAppMesh
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.
      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AWSAppMesh
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /