AmazonApiGatewayClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.apigateway.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. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AmazonApiGatewayClient()` Deprecated. use `AmazonApiGatewayClientBuilder.defaultClient()`
`AmazonApiGatewayClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonApiGatewayClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonApiGatewayClientBuilder`	`builder()`
`CreateApiKeyResult`	`createApiKey(CreateApiKeyRequest request)` Create an ApiKey resource.
`CreateAuthorizerResult`	`createAuthorizer(CreateAuthorizerRequest request)` Adds a new Authorizer resource to an existing RestApi resource.
`CreateBasePathMappingResult`	`createBasePathMapping(CreateBasePathMappingRequest request)` Creates a new BasePathMapping resource.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest request)` Creates a Deployment resource, which makes a specified RestApi callable over the internet.
`CreateDocumentationPartResult`	`createDocumentationPart(CreateDocumentationPartRequest request)`
`CreateDocumentationVersionResult`	`createDocumentationVersion(CreateDocumentationVersionRequest request)`
`CreateDomainNameResult`	`createDomainName(CreateDomainNameRequest request)` Creates a new domain name.
`CreateModelResult`	`createModel(CreateModelRequest request)` Adds a new Model resource to an existing RestApi resource.
`CreateRequestValidatorResult`	`createRequestValidator(CreateRequestValidatorRequest request)` Creates a ReqeustValidator of a given RestApi.
`CreateResourceResult`	`createResource(CreateResourceRequest request)` Creates a Resource resource.
`CreateRestApiResult`	`createRestApi(CreateRestApiRequest request)` Creates a new RestApi resource.
`CreateStageResult`	`createStage(CreateStageRequest request)` Creates a new Stage resource that references a pre-existing Deployment for the API.
`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.
`CreateUsagePlanKeyResult`	`createUsagePlanKey(CreateUsagePlanKeyRequest request)` Creates a usage plan key for adding an existing API key to a usage plan.
`DeleteApiKeyResult`	`deleteApiKey(DeleteApiKeyRequest request)` Deletes the ApiKey resource.
`DeleteAuthorizerResult`	`deleteAuthorizer(DeleteAuthorizerRequest request)` Deletes an existing Authorizer resource.
`DeleteBasePathMappingResult`	`deleteBasePathMapping(DeleteBasePathMappingRequest request)` Deletes the BasePathMapping resource.
`DeleteClientCertificateResult`	`deleteClientCertificate(DeleteClientCertificateRequest request)` Deletes the ClientCertificate resource.
`DeleteDeploymentResult`	`deleteDeployment(DeleteDeploymentRequest request)` Deletes a Deployment resource.
`DeleteDocumentationPartResult`	`deleteDocumentationPart(DeleteDocumentationPartRequest request)`
`DeleteDocumentationVersionResult`	`deleteDocumentationVersion(DeleteDocumentationVersionRequest request)`
`DeleteDomainNameResult`	`deleteDomainName(DeleteDomainNameRequest request)` Deletes the DomainName resource.
`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.
`DeleteIntegrationResult`	`deleteIntegration(DeleteIntegrationRequest request)` Represents a delete integration.
`DeleteIntegrationResponseResult`	`deleteIntegrationResponse(DeleteIntegrationResponseRequest request)` Represents a delete integration response.
`DeleteMethodResult`	`deleteMethod(DeleteMethodRequest request)` Deletes an existing Method resource.
`DeleteMethodResponseResult`	`deleteMethodResponse(DeleteMethodResponseRequest request)` Deletes an existing MethodResponse resource.
`DeleteModelResult`	`deleteModel(DeleteModelRequest request)` Deletes a model.
`DeleteRequestValidatorResult`	`deleteRequestValidator(DeleteRequestValidatorRequest request)` Deletes a RequestValidator of a given RestApi.
`DeleteResourceResult`	`deleteResource(DeleteResourceRequest request)` Deletes a Resource resource.
`DeleteRestApiResult`	`deleteRestApi(DeleteRestApiRequest request)` Deletes the specified API.
`DeleteStageResult`	`deleteStage(DeleteStageRequest request)` Deletes a Stage resource.
`DeleteUsagePlanResult`	`deleteUsagePlan(DeleteUsagePlanRequest request)` Deletes a usage plan of a given plan Id.
`DeleteUsagePlanKeyResult`	`deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)` Deletes a usage plan key and remove the underlying API key from the associated usage plan.
`FlushStageAuthorizersCacheResult`	`flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)` Flushes all authorizer cache entries on a stage.
`FlushStageCacheResult`	`flushStageCache(FlushStageCacheRequest request)` Flushes a stage's cache.
`GenerateClientCertificateResult`	`generateClientCertificate(GenerateClientCertificateRequest request)` Generates a ClientCertificate resource.
`GetAccountResult`	`getAccount(GetAccountRequest request)` Gets information about the current Account resource.
`GetApiKeyResult`	`getApiKey(GetApiKeyRequest request)` Gets information about the current ApiKey resource.
`GetApiKeysResult`	`getApiKeys(GetApiKeysRequest request)` Gets information about the current ApiKeys resource.
`GetAuthorizerResult`	`getAuthorizer(GetAuthorizerRequest request)` Describe an existing Authorizer resource.
`GetAuthorizersResult`	`getAuthorizers(GetAuthorizersRequest request)` Describe an existing Authorizers resource.
`GetBasePathMappingResult`	`getBasePathMapping(GetBasePathMappingRequest request)` Describe a BasePathMapping resource.
`GetBasePathMappingsResult`	`getBasePathMappings(GetBasePathMappingsRequest request)` Represents a collection of BasePathMapping resources.
`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.
`GetClientCertificateResult`	`getClientCertificate(GetClientCertificateRequest request)` Gets information about the current ClientCertificate resource.
`GetClientCertificatesResult`	`getClientCertificates(GetClientCertificatesRequest request)` Gets a collection of ClientCertificate resources.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest request)` Gets information about a Deployment resource.
`GetDeploymentsResult`	`getDeployments(GetDeploymentsRequest request)` Gets information about a Deployments collection.
`GetDocumentationPartResult`	`getDocumentationPart(GetDocumentationPartRequest request)`
`GetDocumentationPartsResult`	`getDocumentationParts(GetDocumentationPartsRequest request)`
`GetDocumentationVersionResult`	`getDocumentationVersion(GetDocumentationVersionRequest request)`
`GetDocumentationVersionsResult`	`getDocumentationVersions(GetDocumentationVersionsRequest request)`
`GetDomainNameResult`	`getDomainName(GetDomainNameRequest request)` Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
`GetDomainNamesResult`	`getDomainNames(GetDomainNamesRequest request)` Represents a collection of DomainName resources.
`GetExportResult`	`getExport(GetExportRequest request)` Exports a deployed version of a RestApi in a specified format.
`GetGatewayResponseResult`	`getGatewayResponse(GetGatewayResponseRequest request)` Gets a GatewayResponse of a specified response type on the given RestApi.
`GetGatewayResponsesResult`	`getGatewayResponses(GetGatewayResponsesRequest request)` Gets the GatewayResponses collection on the given RestApi.
`GetIntegrationResult`	`getIntegration(GetIntegrationRequest request)` Represents a get integration.
`GetIntegrationResponseResult`	`getIntegrationResponse(GetIntegrationResponseRequest request)` Represents a get integration response.
`GetMethodResult`	`getMethod(GetMethodRequest request)` Describe an existing Method resource.
`GetMethodResponseResult`	`getMethodResponse(GetMethodResponseRequest request)` Describes a MethodResponse resource.
`GetModelResult`	`getModel(GetModelRequest request)` Describes an existing model defined for a RestApi resource.
`GetModelsResult`	`getModels(GetModelsRequest request)` Describes existing Models defined for a RestApi resource.
`GetModelTemplateResult`	`getModelTemplate(GetModelTemplateRequest request)` Generates a sample mapping template that can be used to transform a payload into the structure of a model.
`GetRequestValidatorResult`	`getRequestValidator(GetRequestValidatorRequest request)` Gets a RequestValidator of a given RestApi.
`GetRequestValidatorsResult`	`getRequestValidators(GetRequestValidatorsRequest request)` Gets the RequestValidators collection of a given RestApi.
`GetResourceResult`	`getResource(GetResourceRequest request)` Lists information about a resource.
`GetResourcesResult`	`getResources(GetResourcesRequest request)` Lists information about a collection of Resource resources.
`GetRestApiResult`	`getRestApi(GetRestApiRequest request)` Lists the RestApi resource in the collection.
`GetRestApisResult`	`getRestApis(GetRestApisRequest request)` Lists the RestApis resources for your collection.
`GetSdkResult`	`getSdk(GetSdkRequest request)` Generates a client SDK for a RestApi and Stage.
`GetSdkTypeResult`	`getSdkType(GetSdkTypeRequest request)`
`GetSdkTypesResult`	`getSdkTypes(GetSdkTypesRequest request)`
`GetStageResult`	`getStage(GetStageRequest request)` Gets information about a Stage resource.
`GetStagesResult`	`getStages(GetStagesRequest request)` Gets information about one or more Stage resources.
`GetUsageResult`	`getUsage(GetUsageRequest request)` Gets the usage data of a usage plan in a specified time interval.
`GetUsagePlanResult`	`getUsagePlan(GetUsagePlanRequest request)` Gets a usage plan of a given plan identifier.
`GetUsagePlanKeyResult`	`getUsagePlanKey(GetUsagePlanKeyRequest request)` Gets a usage plan key of a given key identifier.
`GetUsagePlanKeysResult`	`getUsagePlanKeys(GetUsagePlanKeysRequest request)` Gets all the usage plan keys representing the API keys added to a specified usage plan.
`GetUsagePlansResult`	`getUsagePlans(GetUsagePlansRequest request)` Gets all the usage plans of the caller's account.
`ImportApiKeysResult`	`importApiKeys(ImportApiKeysRequest request)` Import API keys from an external source, such as a CSV-formatted file.
`ImportDocumentationPartsResult`	`importDocumentationParts(ImportDocumentationPartsRequest request)`
`ImportRestApiResult`	`importRestApi(ImportRestApiRequest request)` A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
`PutGatewayResponseResult`	`putGatewayResponse(PutGatewayResponseRequest request)` Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
`PutIntegrationResult`	`putIntegration(PutIntegrationRequest request)` Sets up a method's integration.
`PutIntegrationResponseResult`	`putIntegrationResponse(PutIntegrationResponseRequest request)` Represents a put integration.
`PutMethodResult`	`putMethod(PutMethodRequest request)` Add a method to an existing Resource resource.
`PutMethodResponseResult`	`putMethodResponse(PutMethodResponseRequest request)` Adds a MethodResponse to an existing Method resource.
`PutRestApiResult`	`putRestApi(PutRestApiRequest request)` A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions.
`TestInvokeAuthorizerResult`	`testInvokeAuthorizer(TestInvokeAuthorizerRequest request)` Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
`TestInvokeMethodResult`	`testInvokeMethod(TestInvokeMethodRequest request)` Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
`UpdateAccountResult`	`updateAccount(UpdateAccountRequest request)` Changes information about the current Account resource.
`UpdateApiKeyResult`	`updateApiKey(UpdateApiKeyRequest request)` Changes information about an ApiKey resource.
`UpdateAuthorizerResult`	`updateAuthorizer(UpdateAuthorizerRequest request)` Updates an existing Authorizer resource.
`UpdateBasePathMappingResult`	`updateBasePathMapping(UpdateBasePathMappingRequest request)` Changes information about the BasePathMapping resource.
`UpdateClientCertificateResult`	`updateClientCertificate(UpdateClientCertificateRequest request)` Changes information about an ClientCertificate resource.
`UpdateDeploymentResult`	`updateDeployment(UpdateDeploymentRequest request)` Changes information about a Deployment resource.
`UpdateDocumentationPartResult`	`updateDocumentationPart(UpdateDocumentationPartRequest request)`
`UpdateDocumentationVersionResult`	`updateDocumentationVersion(UpdateDocumentationVersionRequest request)`
`UpdateDomainNameResult`	`updateDomainName(UpdateDomainNameRequest request)` Changes information about the DomainName resource.
`UpdateGatewayResponseResult`	`updateGatewayResponse(UpdateGatewayResponseRequest request)` Updates a GatewayResponse of a specified response type on the given RestApi.
`UpdateIntegrationResult`	`updateIntegration(UpdateIntegrationRequest request)` Represents an update integration.
`UpdateIntegrationResponseResult`	`updateIntegrationResponse(UpdateIntegrationResponseRequest request)` Represents an update integration response.
`UpdateMethodResult`	`updateMethod(UpdateMethodRequest request)` Updates an existing Method resource.
`UpdateMethodResponseResult`	`updateMethodResponse(UpdateMethodResponseRequest request)` Updates an existing MethodResponse resource.
`UpdateModelResult`	`updateModel(UpdateModelRequest request)` Changes information about a model.
`UpdateRequestValidatorResult`	`updateRequestValidator(UpdateRequestValidatorRequest request)` Updates a RequestValidator of a given RestApi.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest request)` Changes information about a Resource resource.
`UpdateRestApiResult`	`updateRestApi(UpdateRestApiRequest request)` Changes information about the specified API.
`UpdateStageResult`	`updateStage(UpdateStageRequest request)` Changes information about a Stage resource.
`UpdateUsageResult`	`updateUsage(UpdateUsageRequest request)` Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
`UpdateUsagePlanResult`	`updateUsagePlan(UpdateUsagePlanRequest request)` Updates a usage plan of a given plan Id.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AmazonApiGatewayClient
```
@Deprecated
public AmazonApiGatewayClient()
```
    Deprecated. use AmazonApiGatewayClientBuilder.defaultClient()
    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)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(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)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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)
```
    Deprecated. use AwsClientBuilder.withCredentials(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)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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.).
  - AmazonApiGatewayClient
```
@Deprecated
public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider, client configuration options, and request metric collector.
    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.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AmazonApiGatewayClientBuilder builder()
```
  - createApiKey
```
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
```
    Create an ApiKey resource.
    
    AWS CLI
    
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    LimitExceededException
    
    BadRequestException
    
    ConflictException
  - createAuthorizer
```
public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
```
    Adds a new Authorizer resource to an existing RestApi resource.
    
    AWS CLI
    
    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
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    TooManyRequestsException
  - createBasePathMapping
```
public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
```
    Creates a new BasePathMapping resource.
    
    Specified by:
    
    createBasePathMapping in interface AmazonApiGateway
    
    Parameters:
    
    createBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.
    
    Returns:
    
    Result of the CreateBasePathMapping operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    ConflictException
    
    BadRequestException
    
    NotFoundException
    
    TooManyRequestsException
  - 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 Amazon API Gateway to create a Deployment resource.
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    BadRequestException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    TooManyRequestsException
    
    ServiceUnavailableException
  - createDocumentationPart
```
public CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest request)
```
    Specified by:
    
    createDocumentationPart in interface AmazonApiGateway
    
    Parameters:
    
    createDocumentationPartRequest - Creates a new documentation part of a given API.
    
    Returns:
    
    Result of the CreateDocumentationPart operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    ConflictException
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    TooManyRequestsException
  - createDocumentationVersion
```
public CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest request)
```
    Specified by:
    
    createDocumentationVersion in interface AmazonApiGateway
    
    Parameters:
    
    createDocumentationVersionRequest - Creates a new documentation version of a given API.
    
    Returns:
    
    Result of the CreateDocumentationVersion operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    ConflictException
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    TooManyRequestsException
  - createRequestValidator
```
public CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest request)
```
    Creates a ReqeustValidator 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
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    TooManyRequestsException
  - createResource
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Creates a Resource resource.
    
    Specified by:
    
    createResource in interface AmazonApiGateway
    
    Parameters:
    
    createResourceRequest - Requests Amazon API Gateway to create a Resource resource.
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
  - 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 Amazon API Gateway to create a Stage resource.
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    BadRequestException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
    
    LimitExceededException
    
    ConflictException
    
    NotFoundException
  - 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
    
    ConflictException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - deleteAuthorizer
```
public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
```
    Deletes an existing Authorizer resource.
    
    AWS CLI
    
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    BadRequestException
    
    NotFoundException
  - 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 Amazon API Gateway to delete a Deployment resource.
    
    Returns:
    
    Result of the DeleteDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - deleteDocumentationPart
```
public DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)
```
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    ConflictException
    
    BadRequestException
  - deleteDocumentationVersion
```
public DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
```
    Specified by:
    
    deleteDocumentationVersion in interface AmazonApiGateway
    
    Parameters:
    
    deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.
    
    Returns:
    
    Result of the DeleteDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    ConflictException
  - deleteIntegrationResponse
```
public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
```
    Represents a delete integration response.
    
    Specified by:
    
    deleteIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    deleteIntegrationResponseRequest - Represents a delete integration response request.
    
    Returns:
    
    Result of the DeleteIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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
    
    NotFoundException
    
    TooManyRequestsException
    
    ConflictException
  - 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
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
    
    ConflictException
  - 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
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
  - deleteStage
```
public DeleteStageResult deleteStage(DeleteStageRequest request)
```
    Deletes a Stage resource.
    
    Specified by:
    
    deleteStage in interface AmazonApiGateway
    
    Parameters:
    
    deleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    BadRequestException
  - 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:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    BadRequestException
    
    NotFoundException
  - 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
    
    ConflictException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - flushStageCache
```
public FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)
```
    Flushes a stage's cache.
    
    Specified by:
    
    flushStageCache in interface AmazonApiGateway
    
    Parameters:
    
    flushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.
    
    Returns:
    
    Result of the FlushStageCache operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - generateClientCertificate
```
public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
```
    Generates a ClientCertificate resource.
    
    Specified by:
    
    generateClientCertificate in interface AmazonApiGateway
    
    Parameters:
    
    generateClientCertificateRequest - A request to generate a ClientCertificate resource.
    
    Returns:
    
    Result of the GenerateClientCertificate operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    LimitExceededException
  - getAccount
```
public GetAccountResult getAccount(GetAccountRequest request)
```
    Gets information about the current Account resource.
    
    Specified by:
    
    getAccount in interface AmazonApiGateway
    
    Parameters:
    
    getAccountRequest - Requests Amazon API Gateway to get information about the current Account resource.
    
    Returns:
    
    Result of the GetAccount operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
  - getAuthorizer
```
public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
```
    Describe an existing Authorizer resource.
    
    AWS CLI
    
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getAuthorizers
```
public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
```
    Describe an existing Authorizers resource.
    
    AWS CLI
    
    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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
  - getDeployment
```
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
```
    Gets information about a Deployment resource.
    
    Specified by:
    
    getDeployment in interface AmazonApiGateway
    
    Parameters:
    
    getDeploymentRequest - Requests Amazon API Gateway to get information about a Deployment resource.
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    ServiceUnavailableException
  - getDeployments
```
public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
```
    Gets information about a Deployments collection.
    
    Specified by:
    
    getDeployments in interface AmazonApiGateway
    
    Parameters:
    
    getDeploymentsRequest - Requests Amazon API Gateway to get information about a Deployments collection.
    
    Returns:
    
    Result of the GetDeployments operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    TooManyRequestsException
    
    ServiceUnavailableException
  - getDocumentationPart
```
public GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest request)
```
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getDocumentationParts
```
public GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest request)
```
    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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getDocumentationVersion
```
public GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest request)
```
    Specified by:
    
    getDocumentationVersion in interface AmazonApiGateway
    
    Parameters:
    
    getDocumentationVersionRequest - Gets a documentation snapshot of an API.
    
    Returns:
    
    Result of the GetDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getDocumentationVersions
```
public GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest request)
```
    Specified by:
    
    getDocumentationVersions in interface AmazonApiGateway
    
    Parameters:
    
    getDocumentationVersionsRequest - Gets the documentation versions of an API.
    
    Returns:
    
    Result of the GetDocumentationVersions operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    ServiceUnavailableException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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 Amazon 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 Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
    
    Returns:
    
    Result of the GetGatewayResponses operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getIntegration
```
public GetIntegrationResult getIntegration(GetIntegrationRequest request)
```
    Represents a get integration.
    
    Specified by:
    
    getIntegration in interface AmazonApiGateway
    
    Parameters:
    
    getIntegrationRequest - Represents a get integration request.
    
    Returns:
    
    Result of the GetIntegration operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getIntegrationResponse
```
public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
```
    Represents a get integration response.
    
    Specified by:
    
    getIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    getIntegrationResponseRequest - Represents a get integration response request.
    
    Returns:
    
    Result of the GetIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    TooManyRequestsException
  - getMethodResponse
```
public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
```
    Describes a MethodResponse resource.
    
    Specified by:
    
    getMethodResponse in interface AmazonApiGateway
    
    Parameters:
    
    getMethodResponseRequest - Request to describe a MethodResponse resource.
    
    Returns:
    
    Result of the GetMethodResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - getSdkType
```
public GetSdkTypeResult getSdkType(GetSdkTypeRequest request)
```
    Specified by:
    
    getSdkType in interface AmazonApiGateway
    
    Parameters:
    
    getSdkTypeRequest - Get an SdkType instance.
    
    Returns:
    
    Result of the GetSdkType operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getSdkTypes
```
public GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)
```
    Specified by:
    
    getSdkTypes in interface AmazonApiGateway
    
    Parameters:
    
    getSdkTypesRequest - Get the SdkTypes collection.
    
    Returns:
    
    Result of the GetSdkTypes operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    TooManyRequestsException
  - getStage
```
public GetStageResult getStage(GetStageRequest request)
```
    Gets information about a Stage resource.
    
    Specified by:
    
    getStage in interface AmazonApiGateway
    
    Parameters:
    
    getStageRequest - Requests Amazon API Gateway to get information about a Stage resource.
    
    Returns:
    
    Result of the GetStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - getStages
```
public GetStagesResult getStages(GetStagesRequest request)
```
    Gets information about one or more Stage resources.
    
    Specified by:
    
    getStages in interface AmazonApiGateway
    
    Parameters:
    
    getStagesRequest - Requests Amazon API Gateway to get information about one or more Stage resources.
    
    Returns:
    
    Result of the GetStages operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - 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
    
    UnauthorizedException
    
    TooManyRequestsException
    
    ConflictException
    
    NotFoundException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
    
    LimitExceededException
    
    BadRequestException
    
    ConflictException
  - importDocumentationParts
```
public ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)
```
    Specified by:
    
    importDocumentationParts in interface AmazonApiGateway
    
    Parameters:
    
    importDocumentationPartsRequest - Import documentation parts from an external (e.g., Swagger) definition file.
    
    Returns:
    
    Result of the ImportDocumentationParts operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    LimitExceededException
    
    TooManyRequestsException
  - importRestApi
```
public ImportRestApiResult importRestApi(ImportRestApiRequest request)
```
    A feature of the Amazon 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 Amazon API Gateway using an input of an API definition file.
    
    Returns:
    
    Result of the ImportRestApi operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
    
    ConflictException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    BadRequestException
    
    ConflictException
    
    NotFoundException
    
    TooManyRequestsException
  - putIntegrationResponse
```
public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
```
    Represents a put integration.
    
    Specified by:
    
    putIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    putIntegrationResponseRequest - Represents a put integration response request.
    
    Returns:
    
    Result of the PutIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
    
    ConflictException
  - 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
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
  - putRestApi
```
public PutRestApiResult putRestApi(PutRestApiRequest request)
```
    A feature of the Amazon 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:
    
    UnauthorizedException
    
    LimitExceededException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
    
    ConflictException
  - testInvokeAuthorizer
```
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
```
    Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
    
    Enable custom authorizers
    
    Specified by:
    
    testInvokeAuthorizer in interface AmazonApiGateway
    
    Parameters:
    
    testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.
    
    Returns:
    
    Result of the TestInvokeAuthorizer operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - testInvokeMethod
```
public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
```
    Simulate the execution 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 execution of a Method.
    
    Returns:
    
    Result of the TestInvokeMethod operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    NotFoundException
    
    TooManyRequestsException
  - updateAccount
```
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
```
    Changes information about the current Account resource.
    
    Specified by:
    
    updateAccount in interface AmazonApiGateway
    
    Parameters:
    
    updateAccountRequest - Requests Amazon API Gateway to change information about the current Account resource.
    
    Returns:
    
    Result of the UpdateAccount operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    BadRequestException
    
    NotFoundException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
    
    ConflictException
  - updateAuthorizer
```
public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
```
    Updates an existing Authorizer resource.
    
    AWS CLI
    
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    BadRequestException
    
    NotFoundException
  - updateDeployment
```
public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
```
    Changes information about a Deployment resource.
    
    Specified by:
    
    updateDeployment in interface AmazonApiGateway
    
    Parameters:
    
    updateDeploymentRequest - Requests Amazon API Gateway to change information about a Deployment resource.
    
    Returns:
    
    Result of the UpdateDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
    
    ServiceUnavailableException
  - updateDocumentationPart
```
public UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest request)
```
    Specified by:
    
    updateDocumentationPart in interface AmazonApiGateway
    
    Parameters:
    
    updateDocumentationPartRequest - Updates an existing documentation part of a given API.
    
    Returns:
    
    Result of the UpdateDocumentationPart operation returned by the service.
    
    Throws:
    
    BadRequestException
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    TooManyRequestsException
  - updateDocumentationVersion
```
public UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest request)
```
    Specified by:
    
    updateDocumentationVersion in interface AmazonApiGateway
    
    Parameters:
    
    updateDocumentationVersionRequest - Updates an existing documentation version of an API.
    
    Returns:
    
    Result of the UpdateDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
    
    ConflictException
  - updateIntegrationResponse
```
public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
```
    Represents an update integration response.
    
    Specified by:
    
    updateIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    updateIntegrationResponseRequest - Represents an update integration response request.
    
    Returns:
    
    Result of the UpdateIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    ConflictException
    
    LimitExceededException
    
    BadRequestException
    
    TooManyRequestsException
  - updateModel
```
public UpdateModelResult updateModel(UpdateModelRequest request)
```
    Changes information about a model.
    
    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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    ConflictException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    BadRequestException
    
    TooManyRequestsException
  - 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
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - updateStage
```
public UpdateStageResult updateStage(UpdateStageRequest request)
```
    Changes information about a Stage resource.
    
    Specified by:
    
    updateStage in interface AmazonApiGateway
    
    Parameters:
    
    updateStageRequest - Requests Amazon API Gateway to change information about a Stage resource.
    
    Returns:
    
    Result of the UpdateStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException
    
    NotFoundException
    
    ConflictException
    
    BadRequestException
    
    TooManyRequestsException
  - 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:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    BadRequestException
    
    NotFoundException
  - 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:
    
    UnauthorizedException
    
    TooManyRequestsException
    
    BadRequestException
    
    NotFoundException
    
    ConflictException
  - 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.

Did this page help you?

Class AmazonApiGatewayClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway

Constructor Detail

AmazonApiGatewayClient

AmazonApiGatewayClient

AmazonApiGatewayClient

AmazonApiGatewayClient

AmazonApiGatewayClient

AmazonApiGatewayClient

AmazonApiGatewayClient

Method Detail

builder

createApiKey

createAuthorizer

createBasePathMapping

createDeployment

createDocumentationPart

createDocumentationVersion

createDomainName

createModel

createRequestValidator

createResource

createRestApi

createStage

createUsagePlan

createUsagePlanKey

deleteApiKey

deleteAuthorizer

deleteBasePathMapping

deleteClientCertificate

deleteDeployment

deleteDocumentationPart

deleteDocumentationVersion

deleteDomainName

deleteGatewayResponse

deleteIntegration

deleteIntegrationResponse

deleteMethod

deleteMethodResponse

deleteModel

deleteRequestValidator

deleteResource

deleteRestApi

deleteStage

deleteUsagePlan

deleteUsagePlanKey

flushStageAuthorizersCache

flushStageCache

generateClientCertificate

getAccount

getApiKey

getApiKeys

getAuthorizer

getAuthorizers

getBasePathMapping

getBasePathMappings

getClientCertificate

getClientCertificates

getDeployment

getDeployments

getDocumentationPart

getDocumentationParts

getDocumentationVersion

getDocumentationVersions

getDomainName

getDomainNames

getExport

getGatewayResponse

getGatewayResponses

getIntegration

getIntegrationResponse

getMethod