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.
com.amazonaws.services.apigateway

Class AmazonApiGatewayClient

  • All Implemented Interfaces:
    AmazonApiGateway
    Direct Known Subclasses:
    AmazonApiGatewayAsyncClient


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

    Amazon API Gateway

    Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

    • Constructor Detail

      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient()
        Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient(AWSCredentials awsCredentials)
        Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
        Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient(AWSCredentials awsCredentials,
         ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).
      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      • AmazonApiGatewayClient

        @Deprecated
        public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
         ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).
    • Method Detail

      • createApiKey

        public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)

        Create an ApiKey resource.

        Specified by:
        createApiKey in interface AmazonApiGateway
        Parameters:
        createApiKeyRequest - Request to create an ApiKey resource.
        Returns:
        Result of the CreateApiKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createAuthorizer

        public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)

        Adds a new Authorizer resource to an existing RestApi resource.

        Specified by:
        createAuthorizer in interface AmazonApiGateway
        Parameters:
        createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.
        Returns:
        Result of the CreateAuthorizer operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createBasePathMapping

        public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)

        Creates a new BasePathMapping resource.

        Specified by:
        createBasePathMapping in interface AmazonApiGateway
        Parameters:
        createBasePathMappingRequest - Requests API Gateway to create a new BasePathMapping resource.
        Returns:
        Result of the CreateBasePathMapping operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createDeployment

        public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)

        Creates a Deployment resource, which makes a specified RestApi callable over the internet.

        Specified by:
        createDeployment in interface AmazonApiGateway
        Parameters:
        createDeploymentRequest - Requests API Gateway to create a Deployment resource.
        Returns:
        Result of the CreateDeployment operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • createDomainName

        public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)

        Creates a new domain name.

        Specified by:
        createDomainName in interface AmazonApiGateway
        Parameters:
        createDomainNameRequest - A request to create a new domain name.
        Returns:
        Result of the CreateDomainName operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createModel

        public CreateModelResult createModel(CreateModelRequest request)

        Adds a new Model resource to an existing RestApi resource.

        Specified by:
        createModel in interface AmazonApiGateway
        Parameters:
        createModelRequest - Request to add a new Model to an existing RestApi resource.
        Returns:
        Result of the CreateModel operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createRequestValidator

        public CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest request)

        Creates a RequestValidator of a given RestApi.

        Specified by:
        createRequestValidator in interface AmazonApiGateway
        Parameters:
        createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.
        Returns:
        Result of the CreateRequestValidator operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createResource

        public CreateResourceResult createResource(CreateResourceRequest request)

        Creates a Resource resource.

        Specified by:
        createResource in interface AmazonApiGateway
        Parameters:
        createResourceRequest - Requests API Gateway to create a Resource resource.
        Returns:
        Result of the CreateResource operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createRestApi

        public CreateRestApiResult createRestApi(CreateRestApiRequest request)

        Creates a new RestApi resource.

        Specified by:
        createRestApi in interface AmazonApiGateway
        Parameters:
        createRestApiRequest - The POST Request to add a new RestApi resource to your collection.
        Returns:
        Result of the CreateRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createStage

        public CreateStageResult createStage(CreateStageRequest request)

        Creates a new Stage resource that references a pre-existing Deployment for the API.

        Specified by:
        createStage in interface AmazonApiGateway
        Parameters:
        createStageRequest - Requests API Gateway to create a Stage resource.
        Returns:
        Result of the CreateStage operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createUsagePlan

        public CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest request)

        Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

        Specified by:
        createUsagePlan in interface AmazonApiGateway
        Parameters:
        createUsagePlanRequest - The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
        Returns:
        Result of the CreateUsagePlan operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createUsagePlanKey

        public CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest request)

        Creates a usage plan key for adding an existing API key to a usage plan.

        Specified by:
        createUsagePlanKey in interface AmazonApiGateway
        Parameters:
        createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.
        Returns:
        Result of the CreateUsagePlanKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • createVpcLink

        public CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest request)

        Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

        Specified by:
        createVpcLink in interface AmazonApiGateway
        Parameters:
        createVpcLinkRequest - Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
        Returns:
        Result of the CreateVpcLink operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteApiKey

        public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)

        Deletes the ApiKey resource.

        Specified by:
        deleteApiKey in interface AmazonApiGateway
        Parameters:
        deleteApiKeyRequest - A request to delete the ApiKey resource.
        Returns:
        Result of the DeleteApiKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteAuthorizer

        public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)

        Deletes an existing Authorizer resource.

        Specified by:
        deleteAuthorizer in interface AmazonApiGateway
        Parameters:
        deleteAuthorizerRequest - Request to delete an existing Authorizer resource.
        Returns:
        Result of the DeleteAuthorizer operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteBasePathMapping

        public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)

        Deletes the BasePathMapping resource.

        Specified by:
        deleteBasePathMapping in interface AmazonApiGateway
        Parameters:
        deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.
        Returns:
        Result of the DeleteBasePathMapping operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteClientCertificate

        public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request)

        Deletes the ClientCertificate resource.

        Specified by:
        deleteClientCertificate in interface AmazonApiGateway
        Parameters:
        deleteClientCertificateRequest - A request to delete the ClientCertificate resource.
        Returns:
        Result of the DeleteClientCertificate operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteDeployment

        public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)

        Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

        Specified by:
        deleteDeployment in interface AmazonApiGateway
        Parameters:
        deleteDeploymentRequest - Requests API Gateway to delete a Deployment resource.
        Returns:
        Result of the DeleteDeployment operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteDocumentationPart

        public DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)

        Deletes a documentation part

        Specified by:
        deleteDocumentationPart in interface AmazonApiGateway
        Parameters:
        deleteDocumentationPartRequest - Deletes an existing documentation part of an API.
        Returns:
        Result of the DeleteDocumentationPart operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteDomainName

        public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)

        Deletes the DomainName resource.

        Specified by:
        deleteDomainName in interface AmazonApiGateway
        Parameters:
        deleteDomainNameRequest - A request to delete the DomainName resource.
        Returns:
        Result of the DeleteDomainName operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteGatewayResponse

        public DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest request)

        Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

        Specified by:
        deleteGatewayResponse in interface AmazonApiGateway
        Parameters:
        deleteGatewayResponseRequest - Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
        Returns:
        Result of the DeleteGatewayResponse operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteIntegration

        public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)

        Represents a delete integration.

        Specified by:
        deleteIntegration in interface AmazonApiGateway
        Parameters:
        deleteIntegrationRequest - Represents a delete integration request.
        Returns:
        Result of the DeleteIntegration operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteMethod

        public DeleteMethodResult deleteMethod(DeleteMethodRequest request)

        Deletes an existing Method resource.

        Specified by:
        deleteMethod in interface AmazonApiGateway
        Parameters:
        deleteMethodRequest - Request to delete an existing Method resource.
        Returns:
        Result of the DeleteMethod operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
      • deleteMethodResponse

        public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest request)

        Deletes an existing MethodResponse resource.

        Specified by:
        deleteMethodResponse in interface AmazonApiGateway
        Parameters:
        deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.
        Returns:
        Result of the DeleteMethodResponse operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
      • deleteModel

        public DeleteModelResult deleteModel(DeleteModelRequest request)

        Deletes a model.

        Specified by:
        deleteModel in interface AmazonApiGateway
        Parameters:
        deleteModelRequest - Request to delete an existing model in an existing RestApi resource.
        Returns:
        Result of the DeleteModel operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteRequestValidator

        public DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest request)

        Deletes a RequestValidator of a given RestApi.

        Specified by:
        deleteRequestValidator in interface AmazonApiGateway
        Parameters:
        deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.
        Returns:
        Result of the DeleteRequestValidator operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteResource

        public DeleteResourceResult deleteResource(DeleteResourceRequest request)

        Deletes a Resource resource.

        Specified by:
        deleteResource in interface AmazonApiGateway
        Parameters:
        deleteResourceRequest - Request to delete a Resource.
        Returns:
        Result of the DeleteResource operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteRestApi

        public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest request)

        Deletes the specified API.

        Specified by:
        deleteRestApi in interface AmazonApiGateway
        Parameters:
        deleteRestApiRequest - Request to delete the specified API from your collection.
        Returns:
        Result of the DeleteRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteStage

        public DeleteStageResult deleteStage(DeleteStageRequest request)

        Deletes a Stage resource.

        Specified by:
        deleteStage in interface AmazonApiGateway
        Parameters:
        deleteStageRequest - Requests API Gateway to delete a Stage resource.
        Returns:
        Result of the DeleteStage operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteUsagePlan

        public DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest request)

        Deletes a usage plan of a given plan Id.

        Specified by:
        deleteUsagePlan in interface AmazonApiGateway
        Parameters:
        deleteUsagePlanRequest - The DELETE request to delete a usage plan of a given plan Id.
        Returns:
        Result of the DeleteUsagePlan operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteUsagePlanKey

        public DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)

        Deletes a usage plan key and remove the underlying API key from the associated usage plan.

        Specified by:
        deleteUsagePlanKey in interface AmazonApiGateway
        Parameters:
        deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
        Returns:
        Result of the DeleteUsagePlanKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • deleteVpcLink

        public DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest request)

        Deletes an existing VpcLink of a specified identifier.

        Specified by:
        deleteVpcLink in interface AmazonApiGateway
        Parameters:
        deleteVpcLinkRequest - Deletes an existing VpcLink of a specified identifier.
        Returns:
        Result of the DeleteVpcLink operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • flushStageAuthorizersCache

        public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)

        Flushes all authorizer cache entries on a stage.

        Specified by:
        flushStageAuthorizersCache in interface AmazonApiGateway
        Parameters:
        flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.
        Returns:
        Result of the FlushStageAuthorizersCache operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • flushStageCache

        public FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)

        Flushes a stage's cache.

        Specified by:
        flushStageCache in interface AmazonApiGateway
        Parameters:
        flushStageCacheRequest - Requests API Gateway to flush a stage's cache.
        Returns:
        Result of the FlushStageCache operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getAccount

        public GetAccountResult getAccount(GetAccountRequest request)

        Gets information about the current Account resource.

        Specified by:
        getAccount in interface AmazonApiGateway
        Parameters:
        getAccountRequest - Requests API Gateway to get information about the current Account resource.
        Returns:
        Result of the GetAccount operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getApiKey

        public GetApiKeyResult getApiKey(GetApiKeyRequest request)

        Gets information about the current ApiKey resource.

        Specified by:
        getApiKey in interface AmazonApiGateway
        Parameters:
        getApiKeyRequest - A request to get information about the current ApiKey resource.
        Returns:
        Result of the GetApiKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getApiKeys

        public GetApiKeysResult getApiKeys(GetApiKeysRequest request)

        Gets information about the current ApiKeys resource.

        Specified by:
        getApiKeys in interface AmazonApiGateway
        Parameters:
        getApiKeysRequest - A request to get information about the current ApiKeys resource.
        Returns:
        Result of the GetApiKeys operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getAuthorizer

        public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)

        Describe an existing Authorizer resource.

        Specified by:
        getAuthorizer in interface AmazonApiGateway
        Parameters:
        getAuthorizerRequest - Request to describe an existing Authorizer resource.
        Returns:
        Result of the GetAuthorizer operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getAuthorizers

        public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)

        Describe an existing Authorizers resource.

        Specified by:
        getAuthorizers in interface AmazonApiGateway
        Parameters:
        getAuthorizersRequest - Request to describe an existing Authorizers resource.
        Returns:
        Result of the GetAuthorizers operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getBasePathMapping

        public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)

        Describe a BasePathMapping resource.

        Specified by:
        getBasePathMapping in interface AmazonApiGateway
        Parameters:
        getBasePathMappingRequest - Request to describe a BasePathMapping resource.
        Returns:
        Result of the GetBasePathMapping operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getBasePathMappings

        public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)

        Represents a collection of BasePathMapping resources.

        Specified by:
        getBasePathMappings in interface AmazonApiGateway
        Parameters:
        getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.
        Returns:
        Result of the GetBasePathMappings operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getClientCertificate

        public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest request)

        Gets information about the current ClientCertificate resource.

        Specified by:
        getClientCertificate in interface AmazonApiGateway
        Parameters:
        getClientCertificateRequest - A request to get information about the current ClientCertificate resource.
        Returns:
        Result of the GetClientCertificate operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getClientCertificates

        public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)

        Gets a collection of ClientCertificate resources.

        Specified by:
        getClientCertificates in interface AmazonApiGateway
        Parameters:
        getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.
        Returns:
        Result of the GetClientCertificates operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getDeployment

        public GetDeploymentResult getDeployment(GetDeploymentRequest request)

        Gets information about a Deployment resource.

        Specified by:
        getDeployment in interface AmazonApiGateway
        Parameters:
        getDeploymentRequest - Requests API Gateway to get information about a Deployment resource.
        Returns:
        Result of the GetDeployment operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • getDeployments

        public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)

        Gets information about a Deployments collection.

        Specified by:
        getDeployments in interface AmazonApiGateway
        Parameters:
        getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.
        Returns:
        Result of the GetDeployments operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • getDocumentationPart

        public GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest request)

        Gets a documentation part.

        Specified by:
        getDocumentationPart in interface AmazonApiGateway
        Parameters:
        getDocumentationPartRequest - Gets a specified documentation part of a given API.
        Returns:
        Result of the GetDocumentationPart operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getDocumentationParts

        public GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest request)

        Gets documentation parts.

        Specified by:
        getDocumentationParts in interface AmazonApiGateway
        Parameters:
        getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
        Returns:
        Result of the GetDocumentationParts operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getDomainName

        public GetDomainNameResult getDomainName(GetDomainNameRequest request)

        Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

        Specified by:
        getDomainName in interface AmazonApiGateway
        Parameters:
        getDomainNameRequest - Request to get the name of a DomainName resource.
        Returns:
        Result of the GetDomainName operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getDomainNames

        public GetDomainNamesResult getDomainNames(GetDomainNamesRequest request)

        Represents a collection of DomainName resources.

        Specified by:
        getDomainNames in interface AmazonApiGateway
        Parameters:
        getDomainNamesRequest - Request to describe a collection of DomainName resources.
        Returns:
        Result of the GetDomainNames operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getExport

        public GetExportResult getExport(GetExportRequest request)

        Exports a deployed version of a RestApi in a specified format.

        Specified by:
        getExport in interface AmazonApiGateway
        Parameters:
        getExportRequest - Request a new export of a RestApi for a particular Stage.
        Returns:
        Result of the GetExport operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getGatewayResponse

        public GetGatewayResponseResult getGatewayResponse(GetGatewayResponseRequest request)

        Gets a GatewayResponse of a specified response type on the given RestApi.

        Specified by:
        getGatewayResponse in interface AmazonApiGateway
        Parameters:
        getGatewayResponseRequest - Gets a GatewayResponse of a specified response type on the given RestApi.
        Returns:
        Result of the GetGatewayResponse operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getGatewayResponses

        public GetGatewayResponsesResult getGatewayResponses(GetGatewayResponsesRequest request)

        Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

        Specified by:
        getGatewayResponses in interface AmazonApiGateway
        Parameters:
        getGatewayResponsesRequest - Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
        Returns:
        Result of the GetGatewayResponses operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getIntegration

        public GetIntegrationResult getIntegration(GetIntegrationRequest request)

        Get the integration settings.

        Specified by:
        getIntegration in interface AmazonApiGateway
        Parameters:
        getIntegrationRequest - Represents a request to get the integration configuration.
        Returns:
        Result of the GetIntegration operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getMethod

        public GetMethodResult getMethod(GetMethodRequest request)

        Describe an existing Method resource.

        Specified by:
        getMethod in interface AmazonApiGateway
        Parameters:
        getMethodRequest - Request to describe an existing Method resource.
        Returns:
        Result of the GetMethod operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getModel

        public GetModelResult getModel(GetModelRequest request)

        Describes an existing model defined for a RestApi resource.

        Specified by:
        getModel in interface AmazonApiGateway
        Parameters:
        getModelRequest - Request to list information about a model in an existing RestApi resource.
        Returns:
        Result of the GetModel operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getModelTemplate

        public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest request)

        Generates a sample mapping template that can be used to transform a payload into the structure of a model.

        Specified by:
        getModelTemplate in interface AmazonApiGateway
        Parameters:
        getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.
        Returns:
        Result of the GetModelTemplate operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getModels

        public GetModelsResult getModels(GetModelsRequest request)

        Describes existing Models defined for a RestApi resource.

        Specified by:
        getModels in interface AmazonApiGateway
        Parameters:
        getModelsRequest - Request to list existing Models defined for a RestApi resource.
        Returns:
        Result of the GetModels operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getRequestValidator

        public GetRequestValidatorResult getRequestValidator(GetRequestValidatorRequest request)

        Gets a RequestValidator of a given RestApi.

        Specified by:
        getRequestValidator in interface AmazonApiGateway
        Parameters:
        getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.
        Returns:
        Result of the GetRequestValidator operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getRequestValidators

        public GetRequestValidatorsResult getRequestValidators(GetRequestValidatorsRequest request)

        Gets the RequestValidators collection of a given RestApi.

        Specified by:
        getRequestValidators in interface AmazonApiGateway
        Parameters:
        getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.
        Returns:
        Result of the GetRequestValidators operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getResource

        public GetResourceResult getResource(GetResourceRequest request)

        Lists information about a resource.

        Specified by:
        getResource in interface AmazonApiGateway
        Parameters:
        getResourceRequest - Request to list information about a resource.
        Returns:
        Result of the GetResource operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getResources

        public GetResourcesResult getResources(GetResourcesRequest request)

        Lists information about a collection of Resource resources.

        Specified by:
        getResources in interface AmazonApiGateway
        Parameters:
        getResourcesRequest - Request to list information about a collection of resources.
        Returns:
        Result of the GetResources operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getRestApi

        public GetRestApiResult getRestApi(GetRestApiRequest request)

        Lists the RestApi resource in the collection.

        Specified by:
        getRestApi in interface AmazonApiGateway
        Parameters:
        getRestApiRequest - The GET request to list an existing RestApi defined for your collection.
        Returns:
        Result of the GetRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getRestApis

        public GetRestApisResult getRestApis(GetRestApisRequest request)

        Lists the RestApis resources for your collection.

        Specified by:
        getRestApis in interface AmazonApiGateway
        Parameters:
        getRestApisRequest - The GET request to list existing RestApis defined for your collection.
        Returns:
        Result of the GetRestApis operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getSdk

        public GetSdkResult getSdk(GetSdkRequest request)

        Generates a client SDK for a RestApi and Stage.

        Specified by:
        getSdk in interface AmazonApiGateway
        Parameters:
        getSdkRequest - Request a new generated client SDK for a RestApi and Stage.
        Returns:
        Result of the GetSdk operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getSdkType

        public GetSdkTypeResult getSdkType(GetSdkTypeRequest request)

        Gets an SDK type.

        Specified by:
        getSdkType in interface AmazonApiGateway
        Parameters:
        getSdkTypeRequest - Get an SdkType instance.
        Returns:
        Result of the GetSdkType operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getSdkTypes

        public GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)

        Gets SDK types

        Specified by:
        getSdkTypes in interface AmazonApiGateway
        Parameters:
        getSdkTypesRequest - Get the SdkTypes collection.
        Returns:
        Result of the GetSdkTypes operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getStage

        public GetStageResult getStage(GetStageRequest request)

        Gets information about a Stage resource.

        Specified by:
        getStage in interface AmazonApiGateway
        Parameters:
        getStageRequest - Requests API Gateway to get information about a Stage resource.
        Returns:
        Result of the GetStage operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getStages

        public GetStagesResult getStages(GetStagesRequest request)

        Gets information about one or more Stage resources.

        Specified by:
        getStages in interface AmazonApiGateway
        Parameters:
        getStagesRequest - Requests API Gateway to get information about one or more Stage resources.
        Returns:
        Result of the GetStages operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getTags

        public GetTagsResult getTags(GetTagsRequest request)

        Gets the Tags collection for a given resource.

        Specified by:
        getTags in interface AmazonApiGateway
        Parameters:
        getTagsRequest - Gets the Tags collection for a given resource.
        Returns:
        Result of the GetTags operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getUsage

        public GetUsageResult getUsage(GetUsageRequest request)

        Gets the usage data of a usage plan in a specified time interval.

        Specified by:
        getUsage in interface AmazonApiGateway
        Parameters:
        getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.
        Returns:
        Result of the GetUsage operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getUsagePlan

        public GetUsagePlanResult getUsagePlan(GetUsagePlanRequest request)

        Gets a usage plan of a given plan identifier.

        Specified by:
        getUsagePlan in interface AmazonApiGateway
        Parameters:
        getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.
        Returns:
        Result of the GetUsagePlan operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getUsagePlanKey

        public GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest request)

        Gets a usage plan key of a given key identifier.

        Specified by:
        getUsagePlanKey in interface AmazonApiGateway
        Parameters:
        getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.
        Returns:
        Result of the GetUsagePlanKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getUsagePlanKeys

        public GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest request)

        Gets all the usage plan keys representing the API keys added to a specified usage plan.

        Specified by:
        getUsagePlanKeys in interface AmazonApiGateway
        Parameters:
        getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
        Returns:
        Result of the GetUsagePlanKeys operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getUsagePlans

        public GetUsagePlansResult getUsagePlans(GetUsagePlansRequest request)

        Gets all the usage plans of the caller's account.

        Specified by:
        getUsagePlans in interface AmazonApiGateway
        Parameters:
        getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.
        Returns:
        Result of the GetUsagePlans operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getVpcLink

        public GetVpcLinkResult getVpcLink(GetVpcLinkRequest request)

        Gets a specified VPC link under the caller's account in a region.

        Specified by:
        getVpcLink in interface AmazonApiGateway
        Parameters:
        getVpcLinkRequest - Gets a specified VPC link under the caller's account in a region.
        Returns:
        Result of the GetVpcLink operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • getVpcLinks

        public GetVpcLinksResult getVpcLinks(GetVpcLinksRequest request)

        Gets the VpcLinks collection under the caller's account in a selected region.

        Specified by:
        getVpcLinks in interface AmazonApiGateway
        Parameters:
        getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.
        Returns:
        Result of the GetVpcLinks operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • importApiKeys

        public ImportApiKeysResult importApiKeys(ImportApiKeysRequest request)

        Import API keys from an external source, such as a CSV-formatted file.

        Specified by:
        importApiKeys in interface AmazonApiGateway
        Parameters:
        importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.
        Returns:
        Result of the ImportApiKeys operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • importDocumentationParts

        public ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)

        Imports documentation parts

        Specified by:
        importDocumentationParts in interface AmazonApiGateway
        Parameters:
        importDocumentationPartsRequest - Import documentation parts from an external (e.g., OpenAPI) definition file.
        Returns:
        Result of the ImportDocumentationParts operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • importRestApi

        public ImportRestApiResult importRestApi(ImportRestApiRequest request)

        A feature of the API Gateway control service for creating a new API from an external API definition file.

        Specified by:
        importRestApi in interface AmazonApiGateway
        Parameters:
        importRestApiRequest - A POST request to import an API to API Gateway using an input of an API definition file.
        Returns:
        Result of the ImportRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • putGatewayResponse

        public PutGatewayResponseResult putGatewayResponse(PutGatewayResponseRequest request)

        Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

        Specified by:
        putGatewayResponse in interface AmazonApiGateway
        Parameters:
        putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
        Returns:
        Result of the PutGatewayResponse operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • putIntegration

        public PutIntegrationResult putIntegration(PutIntegrationRequest request)

        Sets up a method's integration.

        Specified by:
        putIntegration in interface AmazonApiGateway
        Parameters:
        putIntegrationRequest - Sets up a method's integration.
        Returns:
        Result of the PutIntegration operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • putMethod

        public PutMethodResult putMethod(PutMethodRequest request)

        Add a method to an existing Resource resource.

        Specified by:
        putMethod in interface AmazonApiGateway
        Parameters:
        putMethodRequest - Request to add a method to an existing Resource resource.
        Returns:
        Result of the PutMethod operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • putMethodResponse

        public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest request)

        Adds a MethodResponse to an existing Method resource.

        Specified by:
        putMethodResponse in interface AmazonApiGateway
        Parameters:
        putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.
        Returns:
        Result of the PutMethodResponse operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • putRestApi

        public PutRestApiResult putRestApi(PutRestApiRequest request)

        A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

        Specified by:
        putRestApi in interface AmazonApiGateway
        Parameters:
        putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.
        Returns:
        Result of the PutRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • tagResource

        public TagResourceResult tagResource(TagResourceRequest request)

        Adds or updates a tag on a given resource.

        Specified by:
        tagResource in interface AmazonApiGateway
        Parameters:
        tagResourceRequest - Adds or updates a tag on a given resource.
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • testInvokeAuthorizer

        public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)

        Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

        Specified by:
        testInvokeAuthorizer in interface AmazonApiGateway
        Parameters:
        testInvokeAuthorizerRequest - Make a request to simulate the invocation of an Authorizer.
        Returns:
        Result of the TestInvokeAuthorizer operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • testInvokeMethod

        public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)

        Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

        Specified by:
        testInvokeMethod in interface AmazonApiGateway
        Parameters:
        testInvokeMethodRequest - Make a request to simulate the invocation of a Method.
        Returns:
        Result of the TestInvokeMethod operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • untagResource

        public UntagResourceResult untagResource(UntagResourceRequest request)

        Removes a tag from a given resource.

        Specified by:
        untagResource in interface AmazonApiGateway
        Parameters:
        untagResourceRequest - Removes a tag from a given resource.
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateAccount

        public UpdateAccountResult updateAccount(UpdateAccountRequest request)

        Changes information about the current Account resource.

        Specified by:
        updateAccount in interface AmazonApiGateway
        Parameters:
        updateAccountRequest - Requests API Gateway to change information about the current Account resource.
        Returns:
        Result of the UpdateAccount operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateApiKey

        public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)

        Changes information about an ApiKey resource.

        Specified by:
        updateApiKey in interface AmazonApiGateway
        Parameters:
        updateApiKeyRequest - A request to change information about an ApiKey resource.
        Returns:
        Result of the UpdateApiKey operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateAuthorizer

        public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)

        Updates an existing Authorizer resource.

        Specified by:
        updateAuthorizer in interface AmazonApiGateway
        Parameters:
        updateAuthorizerRequest - Request to update an existing Authorizer resource.
        Returns:
        Result of the UpdateAuthorizer operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateBasePathMapping

        public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)

        Changes information about the BasePathMapping resource.

        Specified by:
        updateBasePathMapping in interface AmazonApiGateway
        Parameters:
        updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.
        Returns:
        Result of the UpdateBasePathMapping operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateClientCertificate

        public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request)

        Changes information about an ClientCertificate resource.

        Specified by:
        updateClientCertificate in interface AmazonApiGateway
        Parameters:
        updateClientCertificateRequest - A request to change information about an ClientCertificate resource.
        Returns:
        Result of the UpdateClientCertificate operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateDeployment

        public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)

        Changes information about a Deployment resource.

        Specified by:
        updateDeployment in interface AmazonApiGateway
        Parameters:
        updateDeploymentRequest - Requests API Gateway to change information about a Deployment resource.
        Returns:
        Result of the UpdateDeployment operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
        ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
      • updateDomainName

        public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)

        Changes information about the DomainName resource.

        Specified by:
        updateDomainName in interface AmazonApiGateway
        Parameters:
        updateDomainNameRequest - A request to change information about the DomainName resource.
        Returns:
        Result of the UpdateDomainName operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateGatewayResponse

        public UpdateGatewayResponseResult updateGatewayResponse(UpdateGatewayResponseRequest request)

        Updates a GatewayResponse of a specified response type on the given RestApi.

        Specified by:
        updateGatewayResponse in interface AmazonApiGateway
        Parameters:
        updateGatewayResponseRequest - Updates a GatewayResponse of a specified response type on the given RestApi.
        Returns:
        Result of the UpdateGatewayResponse operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateIntegration

        public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)

        Represents an update integration.

        Specified by:
        updateIntegration in interface AmazonApiGateway
        Parameters:
        updateIntegrationRequest - Represents an update integration request.
        Returns:
        Result of the UpdateIntegration operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateMethod

        public UpdateMethodResult updateMethod(UpdateMethodRequest request)

        Updates an existing Method resource.

        Specified by:
        updateMethod in interface AmazonApiGateway
        Parameters:
        updateMethodRequest - Request to update an existing Method resource.
        Returns:
        Result of the UpdateMethod operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateMethodResponse

        public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)

        Updates an existing MethodResponse resource.

        Specified by:
        updateMethodResponse in interface AmazonApiGateway
        Parameters:
        updateMethodResponseRequest - A request to update an existing MethodResponse resource.
        Returns:
        Result of the UpdateMethodResponse operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateModel

        public UpdateModelResult updateModel(UpdateModelRequest request)

        Changes information about a model. The maximum size of the model is 400 KB.

        Specified by:
        updateModel in interface AmazonApiGateway
        Parameters:
        updateModelRequest - Request to update an existing model in an existing RestApi resource.
        Returns:
        Result of the UpdateModel operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateRequestValidator

        public UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest request)

        Updates a RequestValidator of a given RestApi.

        Specified by:
        updateRequestValidator in interface AmazonApiGateway
        Parameters:
        updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.
        Returns:
        Result of the UpdateRequestValidator operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateResource

        public UpdateResourceResult updateResource(UpdateResourceRequest request)

        Changes information about a Resource resource.

        Specified by:
        updateResource in interface AmazonApiGateway
        Parameters:
        updateResourceRequest - Request to change information about a Resource resource.
        Returns:
        Result of the UpdateResource operation returned by the service.
        Throws:
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateRestApi

        public UpdateRestApiResult updateRestApi(UpdateRestApiRequest request)

        Changes information about the specified API.

        Specified by:
        updateRestApi in interface AmazonApiGateway
        Parameters:
        updateRestApiRequest - Request to update an existing RestApi resource in your collection.
        Returns:
        Result of the UpdateRestApi operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateStage

        public UpdateStageResult updateStage(UpdateStageRequest request)

        Changes information about a Stage resource.

        Specified by:
        updateStage in interface AmazonApiGateway
        Parameters:
        updateStageRequest - Requests API Gateway to change information about a Stage resource.
        Returns:
        Result of the UpdateStage operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateUsage

        public UpdateUsageResult updateUsage(UpdateUsageRequest request)

        Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

        Specified by:
        updateUsage in interface AmazonApiGateway
        Parameters:
        updateUsageRequest - The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
        Returns:
        Result of the UpdateUsage operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateUsagePlan

        public UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest request)

        Updates a usage plan of a given plan Id.

        Specified by:
        updateUsagePlan in interface AmazonApiGateway
        Parameters:
        updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.
        Returns:
        Result of the UpdateUsagePlan operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • updateVpcLink

        public UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest request)

        Updates an existing VpcLink of a specified identifier.

        Specified by:
        updateVpcLink in interface AmazonApiGateway
        Parameters:
        updateVpcLinkRequest - Updates an existing VpcLink of a specified identifier.
        Returns:
        Result of the UpdateVpcLink operation returned by the service.
        Throws:
        BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
        ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
        LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
        NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
        UnauthorizedException - The request is denied because the caller has insufficient permissions.
        TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
      • 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 AmazonApiGateway
        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 AmazonApiGateway
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links

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