AmazonApiGateway (AWS SDK for Java

All Known Subinterfaces:

AmazonApiGatewayAsync

All Known Implementing Classes:

AbstractAmazonApiGateway, AbstractAmazonApiGatewayAsync, AmazonApiGatewayAsyncClient, AmazonApiGatewayClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApiGateway
```
Interface for accessing Amazon API Gateway.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonApiGateway instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateApiKeyResult`	`createApiKey(CreateApiKeyRequest createApiKeyRequest)` Create an ApiKey resource.
`CreateAuthorizerResult`	`createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)` Adds a new Authorizer resource to an existing RestApi resource.
`CreateBasePathMappingResult`	`createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)` Creates a new BasePathMapping resource.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)` Creates a Deployment resource, which makes a specified RestApi callable over the internet.
`CreateDocumentationPartResult`	`createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)`
`CreateDocumentationVersionResult`	`createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)`
`CreateDomainNameResult`	`createDomainName(CreateDomainNameRequest createDomainNameRequest)` Creates a new domain name.
`CreateModelResult`	`createModel(CreateModelRequest createModelRequest)` Adds a new Model resource to an existing RestApi resource.
`CreateRequestValidatorResult`	`createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)` Creates a ReqeustValidator of a given RestApi.
`CreateResourceResult`	`createResource(CreateResourceRequest createResourceRequest)` Creates a Resource resource.
`CreateRestApiResult`	`createRestApi(CreateRestApiRequest createRestApiRequest)` Creates a new RestApi resource.
`CreateStageResult`	`createStage(CreateStageRequest createStageRequest)` Creates a new Stage resource that references a pre-existing Deployment for the API.
`CreateUsagePlanResult`	`createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)` Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
`CreateUsagePlanKeyResult`	`createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)` Creates a usage plan key for adding an existing API key to a usage plan.
`DeleteApiKeyResult`	`deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)` Deletes the ApiKey resource.
`DeleteAuthorizerResult`	`deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)` Deletes an existing Authorizer resource.
`DeleteBasePathMappingResult`	`deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)` Deletes the BasePathMapping resource.
`DeleteClientCertificateResult`	`deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)` Deletes the ClientCertificate resource.
`DeleteDeploymentResult`	`deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)` Deletes a Deployment resource.
`DeleteDocumentationPartResult`	`deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)`
`DeleteDocumentationVersionResult`	`deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)`
`DeleteDomainNameResult`	`deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)` Deletes the DomainName resource.
`DeleteGatewayResponseResult`	`deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)` 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 deleteIntegrationRequest)` Represents a delete integration.
`DeleteIntegrationResponseResult`	`deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)` Represents a delete integration response.
`DeleteMethodResult`	`deleteMethod(DeleteMethodRequest deleteMethodRequest)` Deletes an existing Method resource.
`DeleteMethodResponseResult`	`deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)` Deletes an existing MethodResponse resource.
`DeleteModelResult`	`deleteModel(DeleteModelRequest deleteModelRequest)` Deletes a model.
`DeleteRequestValidatorResult`	`deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)` Deletes a RequestValidator of a given RestApi.
`DeleteResourceResult`	`deleteResource(DeleteResourceRequest deleteResourceRequest)` Deletes a Resource resource.
`DeleteRestApiResult`	`deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)` Deletes the specified API.
`DeleteStageResult`	`deleteStage(DeleteStageRequest deleteStageRequest)` Deletes a Stage resource.
`DeleteUsagePlanResult`	`deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)` Deletes a usage plan of a given plan Id.
`DeleteUsagePlanKeyResult`	`deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)` Deletes a usage plan key and remove the underlying API key from the associated usage plan.
`FlushStageAuthorizersCacheResult`	`flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)` Flushes all authorizer cache entries on a stage.
`FlushStageCacheResult`	`flushStageCache(FlushStageCacheRequest flushStageCacheRequest)` Flushes a stage's cache.
`GenerateClientCertificateResult`	`generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)` Generates a ClientCertificate resource.
`GetAccountResult`	`getAccount(GetAccountRequest getAccountRequest)` Gets information about the current Account resource.
`GetApiKeyResult`	`getApiKey(GetApiKeyRequest getApiKeyRequest)` Gets information about the current ApiKey resource.
`GetApiKeysResult`	`getApiKeys(GetApiKeysRequest getApiKeysRequest)` Gets information about the current ApiKeys resource.
`GetAuthorizerResult`	`getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)` Describe an existing Authorizer resource.
`GetAuthorizersResult`	`getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)` Describe an existing Authorizers resource.
`GetBasePathMappingResult`	`getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)` Describe a BasePathMapping resource.
`GetBasePathMappingsResult`	`getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)` 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 getClientCertificateRequest)` Gets information about the current ClientCertificate resource.
`GetClientCertificatesResult`	`getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)` Gets a collection of ClientCertificate resources.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest getDeploymentRequest)` Gets information about a Deployment resource.
`GetDeploymentsResult`	`getDeployments(GetDeploymentsRequest getDeploymentsRequest)` Gets information about a Deployments collection.
`GetDocumentationPartResult`	`getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)`
`GetDocumentationPartsResult`	`getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)`
`GetDocumentationVersionResult`	`getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)`
`GetDocumentationVersionsResult`	`getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)`
`GetDomainNameResult`	`getDomainName(GetDomainNameRequest getDomainNameRequest)` Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
`GetDomainNamesResult`	`getDomainNames(GetDomainNamesRequest getDomainNamesRequest)` Represents a collection of DomainName resources.
`GetExportResult`	`getExport(GetExportRequest getExportRequest)` Exports a deployed version of a RestApi in a specified format.
`GetGatewayResponseResult`	`getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)` Gets a GatewayResponse of a specified response type on the given RestApi.
`GetGatewayResponsesResult`	`getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)` Gets the GatewayResponses collection on the given RestApi.
`GetIntegrationResult`	`getIntegration(GetIntegrationRequest getIntegrationRequest)` Represents a get integration.
`GetIntegrationResponseResult`	`getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)` Represents a get integration response.
`GetMethodResult`	`getMethod(GetMethodRequest getMethodRequest)` Describe an existing Method resource.
`GetMethodResponseResult`	`getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)` Describes a MethodResponse resource.
`GetModelResult`	`getModel(GetModelRequest getModelRequest)` Describes an existing model defined for a RestApi resource.
`GetModelsResult`	`getModels(GetModelsRequest getModelsRequest)` Describes existing Models defined for a RestApi resource.
`GetModelTemplateResult`	`getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)` Generates a sample mapping template that can be used to transform a payload into the structure of a model.
`GetRequestValidatorResult`	`getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)` Gets a RequestValidator of a given RestApi.
`GetRequestValidatorsResult`	`getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)` Gets the RequestValidators collection of a given RestApi.
`GetResourceResult`	`getResource(GetResourceRequest getResourceRequest)` Lists information about a resource.
`GetResourcesResult`	`getResources(GetResourcesRequest getResourcesRequest)` Lists information about a collection of Resource resources.
`GetRestApiResult`	`getRestApi(GetRestApiRequest getRestApiRequest)` Lists the RestApi resource in the collection.
`GetRestApisResult`	`getRestApis(GetRestApisRequest getRestApisRequest)` Lists the RestApis resources for your collection.
`GetSdkResult`	`getSdk(GetSdkRequest getSdkRequest)` Generates a client SDK for a RestApi and Stage.
`GetSdkTypeResult`	`getSdkType(GetSdkTypeRequest getSdkTypeRequest)`
`GetSdkTypesResult`	`getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)`
`GetStageResult`	`getStage(GetStageRequest getStageRequest)` Gets information about a Stage resource.
`GetStagesResult`	`getStages(GetStagesRequest getStagesRequest)` Gets information about one or more Stage resources.
`GetUsageResult`	`getUsage(GetUsageRequest getUsageRequest)` Gets the usage data of a usage plan in a specified time interval.
`GetUsagePlanResult`	`getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)` Gets a usage plan of a given plan identifier.
`GetUsagePlanKeyResult`	`getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)` Gets a usage plan key of a given key identifier.
`GetUsagePlanKeysResult`	`getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)` Gets all the usage plan keys representing the API keys added to a specified usage plan.
`GetUsagePlansResult`	`getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)` Gets all the usage plans of the caller's account.
`ImportApiKeysResult`	`importApiKeys(ImportApiKeysRequest importApiKeysRequest)` Import API keys from an external source, such as a CSV-formatted file.
`ImportDocumentationPartsResult`	`importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)`
`ImportRestApiResult`	`importRestApi(ImportRestApiRequest importRestApiRequest)` A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
`PutGatewayResponseResult`	`putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)` Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
`PutIntegrationResult`	`putIntegration(PutIntegrationRequest putIntegrationRequest)` Sets up a method's integration.
`PutIntegrationResponseResult`	`putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)` Represents a put integration.
`PutMethodResult`	`putMethod(PutMethodRequest putMethodRequest)` Add a method to an existing Resource resource.
`PutMethodResponseResult`	`putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)` Adds a MethodResponse to an existing Method resource.
`PutRestApiResult`	`putRestApi(PutRestApiRequest putRestApiRequest)` A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TestInvokeAuthorizerResult`	`testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)` Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
`TestInvokeMethodResult`	`testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)` Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
`UpdateAccountResult`	`updateAccount(UpdateAccountRequest updateAccountRequest)` Changes information about the current Account resource.
`UpdateApiKeyResult`	`updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)` Changes information about an ApiKey resource.
`UpdateAuthorizerResult`	`updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)` Updates an existing Authorizer resource.
`UpdateBasePathMappingResult`	`updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)` Changes information about the BasePathMapping resource.
`UpdateClientCertificateResult`	`updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)` Changes information about an ClientCertificate resource.
`UpdateDeploymentResult`	`updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)` Changes information about a Deployment resource.
`UpdateDocumentationPartResult`	`updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)`
`UpdateDocumentationVersionResult`	`updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)`
`UpdateDomainNameResult`	`updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)` Changes information about the DomainName resource.
`UpdateGatewayResponseResult`	`updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)` Updates a GatewayResponse of a specified response type on the given RestApi.
`UpdateIntegrationResult`	`updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)` Represents an update integration.
`UpdateIntegrationResponseResult`	`updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)` Represents an update integration response.
`UpdateMethodResult`	`updateMethod(UpdateMethodRequest updateMethodRequest)` Updates an existing Method resource.
`UpdateMethodResponseResult`	`updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)` Updates an existing MethodResponse resource.
`UpdateModelResult`	`updateModel(UpdateModelRequest updateModelRequest)` Changes information about a model.
`UpdateRequestValidatorResult`	`updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)` Updates a RequestValidator of a given RestApi.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest updateResourceRequest)` Changes information about a Resource resource.
`UpdateRestApiResult`	`updateRestApi(UpdateRestApiRequest updateRestApiRequest)` Changes information about the specified API.
`UpdateStageResult`	`updateStage(UpdateStageRequest updateStageRequest)` Changes information about a Stage resource.
`UpdateUsageResult`	`updateUsage(UpdateUsageRequest updateUsageRequest)` Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
`UpdateUsagePlanResult`	`updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)` Updates a usage plan of a given plan Id.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://apigateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createApiKey
```
CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
```
    Create an ApiKey resource.
    
    AWS CLI
    
    Parameters:
    
    createApiKeyRequest - Request to create an ApiKey resource.
    
    Returns:
    
    Result of the CreateApiKey operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - createAuthorizer
```
CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
```
    Adds a new Authorizer resource to an existing RestApi resource.
    
    AWS CLI
    
    Parameters:
    
    createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.
    
    Returns:
    
    Result of the CreateAuthorizer operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createBasePathMapping
```
CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
```
    Creates a new BasePathMapping resource.
    
    Parameters:
    
    createBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.
    
    Returns:
    
    Result of the CreateBasePathMapping operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createDeployment
```
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    Creates a Deployment resource, which makes a specified RestApi callable over the internet.
    
    Parameters:
    
    createDeploymentRequest - Requests Amazon API Gateway to create a Deployment resource.
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
  - createDocumentationPart
```
CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
```
    Parameters:
    
    createDocumentationPartRequest - Creates a new documentation part of a given API.
    
    Returns:
    
    Result of the CreateDocumentationPart operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createDocumentationVersion
```
CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
```
    Parameters:
    
    createDocumentationVersionRequest - Creates a new documentation version of a given API.
    
    Returns:
    
    Result of the CreateDocumentationVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createDomainName
```
CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
```
    Creates a new domain name.
    
    Parameters:
    
    createDomainNameRequest - A request to create a new domain name.
    
    Returns:
    
    Result of the CreateDomainName operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createModel
```
CreateModelResult createModel(CreateModelRequest createModelRequest)
```
    Adds a new Model resource to an existing RestApi resource.
    
    Parameters:
    
    createModelRequest - Request to add a new Model to an existing RestApi resource.
    
    Returns:
    
    Result of the CreateModel operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createRequestValidator
```
CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
```
    Creates a ReqeustValidator of a given RestApi.
    
    Parameters:
    
    createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.
    
    Returns:
    
    Result of the CreateRequestValidator operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createResource
```
CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
```
    Creates a Resource resource.
    
    Parameters:
    
    createResourceRequest - Requests Amazon API Gateway to create a Resource resource.
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createRestApi
```
CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
```
    Creates a new RestApi resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createStage
```
CreateStageResult createStage(CreateStageRequest createStageRequest)
```
    Creates a new Stage resource that references a pre-existing Deployment for the API.
    
    Parameters:
    
    createStageRequest - Requests Amazon API Gateway to create a Stage resource.
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - createUsagePlan
```
CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
```
    Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
    
    Parameters:
    
    createUsagePlanRequest - The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
    
    Returns:
    
    Result of the CreateUsagePlan operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - createUsagePlanKey
```
CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
```
    Creates a usage plan key for adding an existing API key to a usage plan.
    
    Parameters:
    
    createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.
    
    Returns:
    
    Result of the CreateUsagePlanKey operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteApiKey
```
DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
```
    Deletes the ApiKey resource.
    
    Parameters:
    
    deleteApiKeyRequest - A request to delete the ApiKey resource.
    
    Returns:
    
    Result of the DeleteApiKey operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteAuthorizer
```
DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
```
    Deletes an existing Authorizer resource.
    
    AWS CLI
    
    Parameters:
    
    deleteAuthorizerRequest - Request to delete an existing Authorizer resource.
    
    Returns:
    
    Result of the DeleteAuthorizer operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteBasePathMapping
```
DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
```
    Deletes the BasePathMapping resource.
    
    Parameters:
    
    deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.
    
    Returns:
    
    Result of the DeleteBasePathMapping operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteClientCertificate
```
DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
```
    Deletes the ClientCertificate resource.
    
    Parameters:
    
    deleteClientCertificateRequest - A request to delete the ClientCertificate resource.
    
    Returns:
    
    Result of the DeleteClientCertificate operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - deleteDeployment
```
DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
```
    Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
    
    Parameters:
    
    deleteDeploymentRequest - Requests Amazon API Gateway to delete a Deployment resource.
    
    Returns:
    
    Result of the DeleteDeployment operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteDocumentationPart
```
DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
```
    Parameters:
    
    deleteDocumentationPartRequest - Deletes an existing documentation part of an API.
    
    Returns:
    
    Result of the DeleteDocumentationPart operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
  - deleteDocumentationVersion
```
DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
```
    Parameters:
    
    deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.
    
    Returns:
    
    Result of the DeleteDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteDomainName
```
DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
```
    Deletes the DomainName resource.
    
    Parameters:
    
    deleteDomainNameRequest - A request to delete the DomainName resource.
    
    Returns:
    
    Result of the DeleteDomainName operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteGatewayResponse
```
DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
```
    Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteIntegration
```
DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
```
    Represents a delete integration.
    
    Parameters:
    
    deleteIntegrationRequest - Represents a delete integration request.
    
    Returns:
    
    Result of the DeleteIntegration operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteIntegrationResponse
```
DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
```
    Represents a delete integration response.
    
    Parameters:
    
    deleteIntegrationResponseRequest - Represents a delete integration response request.
    
    Returns:
    
    Result of the DeleteIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteMethod
```
DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)
```
    Deletes an existing Method resource.
    
    Parameters:
    
    deleteMethodRequest - Request to delete an existing Method resource.
    
    Returns:
    
    Result of the DeleteMethod operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteMethodResponse
```
DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
```
    Deletes an existing MethodResponse resource.
    
    Parameters:
    
    deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.
    
    Returns:
    
    Result of the DeleteMethodResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteModel
```
DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
```
    Deletes a model.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteRequestValidator
```
DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
```
    Deletes a RequestValidator of a given RestApi.
    
    Parameters:
    
    deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.
    
    Returns:
    
    Result of the DeleteRequestValidator operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - deleteResource
```
DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
```
    Deletes a Resource resource.
    
    Parameters:
    
    deleteResourceRequest - Request to delete a Resource.
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - deleteRestApi
```
DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
```
    Deletes the specified API.
    
    Parameters:
    
    deleteRestApiRequest - Request to delete the specified API from your collection.
    
    Returns:
    
    Result of the DeleteRestApi operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
  - deleteStage
```
DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
```
    Deletes a Stage resource.
    
    Parameters:
    
    deleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
  - deleteUsagePlan
```
DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
```
    Deletes a usage plan of a given plan Id.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - deleteUsagePlanKey
```
DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
```
    Deletes a usage plan key and remove the underlying API key from the associated usage plan.
    
    Parameters:
    
    deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
    
    Returns:
    
    Result of the DeleteUsagePlanKey operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - flushStageAuthorizersCache
```
FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
```
    Flushes all authorizer cache entries on a stage.
    
    Parameters:
    
    flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.
    
    Returns:
    
    Result of the FlushStageAuthorizersCache operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - flushStageCache
```
FlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
```
    Flushes a stage's cache.
    
    Parameters:
    
    flushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.
    
    Returns:
    
    Result of the FlushStageCache operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - generateClientCertificate
```
GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
```
    Generates a ClientCertificate resource.
    
    Parameters:
    
    generateClientCertificateRequest - A request to generate a ClientCertificate resource.
    
    Returns:
    
    Result of the GenerateClientCertificate operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
  - getAccount
```
GetAccountResult getAccount(GetAccountRequest getAccountRequest)
```
    Gets information about the current Account resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getApiKey
```
GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
```
    Gets information about the current ApiKey resource.
    
    Parameters:
    
    getApiKeyRequest - A request to get information about the current ApiKey resource.
    
    Returns:
    
    Result of the GetApiKey operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getApiKeys
```
GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
```
    Gets information about the current ApiKeys resource.
    
    Parameters:
    
    getApiKeysRequest - A request to get information about the current ApiKeys resource.
    
    Returns:
    
    Result of the GetApiKeys operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getAuthorizer
```
GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
```
    Describe an existing Authorizer resource.
    
    AWS CLI
    
    Parameters:
    
    getAuthorizerRequest - Request to describe an existing Authorizer resource.
    
    Returns:
    
    Result of the GetAuthorizer operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getAuthorizers
```
GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
```
    Describe an existing Authorizers resource.
    
    AWS CLI
    
    Parameters:
    
    getAuthorizersRequest - Request to describe an existing Authorizers resource.
    
    Returns:
    
    Result of the GetAuthorizers operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getBasePathMapping
```
GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
```
    Describe a BasePathMapping resource.
    
    Parameters:
    
    getBasePathMappingRequest - Request to describe a BasePathMapping resource.
    
    Returns:
    
    Result of the GetBasePathMapping operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getBasePathMappings
```
GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
```
    Represents a collection of BasePathMapping resources.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getClientCertificate
```
GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
```
    Gets information about the current ClientCertificate resource.
    
    Parameters:
    
    getClientCertificateRequest - A request to get information about the current ClientCertificate resource.
    
    Returns:
    
    Result of the GetClientCertificate operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getClientCertificates
```
GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
```
    Gets a collection of ClientCertificate resources.
    
    Parameters:
    
    getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.
    
    Returns:
    
    Result of the GetClientCertificates operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDeployment
```
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
```
    Gets information about a Deployment resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
  - getDeployments
```
GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
```
    Gets information about a Deployments collection.
    
    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 - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
  - getDocumentationPart
```
GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
```
    Parameters:
    
    getDocumentationPartRequest - Gets a specified documentation part of a given API.
    
    Returns:
    
    Result of the GetDocumentationPart operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDocumentationParts
```
GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
```
    Parameters:
    
    getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
    
    Returns:
    
    Result of the GetDocumentationParts operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDocumentationVersion
```
GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
```
    Parameters:
    
    getDocumentationVersionRequest - Gets a documentation snapshot of an API.
    
    Returns:
    
    Result of the GetDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDocumentationVersions
```
GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
```
    Parameters:
    
    getDocumentationVersionsRequest - Gets the documentation versions of an API.
    
    Returns:
    
    Result of the GetDocumentationVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDomainName
```
GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
```
    Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
    
    Parameters:
    
    getDomainNameRequest - Request to get the name of a DomainName resource.
    
    Returns:
    
    Result of the GetDomainName operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getDomainNames
```
GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
```
    Represents a collection of DomainName resources.
    
    Parameters:
    
    getDomainNamesRequest - Request to describe a collection of DomainName resources.
    
    Returns:
    
    Result of the GetDomainNames operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getExport
```
GetExportResult getExport(GetExportRequest getExportRequest)
```
    Exports a deployed version of a RestApi in a specified format.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getGatewayResponse
```
GetGatewayResponseResult getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
```
    Gets a GatewayResponse of a specified response type on the given RestApi.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getGatewayResponses
```
GetGatewayResponsesResult getGatewayResponses(GetGatewayResponsesRequest 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.
    
    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 - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getIntegration
```
GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
```
    Represents a get integration.
    
    Parameters:
    
    getIntegrationRequest - Represents a get integration request.
    
    Returns:
    
    Result of the GetIntegration operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getIntegrationResponse
```
GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
```
    Represents a get integration response.
    
    Parameters:
    
    getIntegrationResponseRequest - Represents a get integration response request.
    
    Returns:
    
    Result of the GetIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getMethod
```
GetMethodResult getMethod(GetMethodRequest getMethodRequest)
```
    Describe an existing Method resource.
    
    Parameters:
    
    getMethodRequest - Request to describe an existing Method resource.
    
    Returns:
    
    Result of the GetMethod operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getMethodResponse
```
GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
```
    Describes a MethodResponse resource.
    
    Parameters:
    
    getMethodResponseRequest - Request to describe a MethodResponse resource.
    
    Returns:
    
    Result of the GetMethodResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getModel
```
GetModelResult getModel(GetModelRequest getModelRequest)
```
    Describes an existing model defined for a RestApi resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getModelTemplate
```
GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
```
    Generates a sample mapping template that can be used to transform a payload into the structure of a model.
    
    Parameters:
    
    getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.
    
    Returns:
    
    Result of the GetModelTemplate operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getModels
```
GetModelsResult getModels(GetModelsRequest getModelsRequest)
```
    Describes existing Models defined for a RestApi resource.
    
    Parameters:
    
    getModelsRequest - Request to list existing Models defined for a RestApi resource.
    
    Returns:
    
    Result of the GetModels operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getRequestValidator
```
GetRequestValidatorResult getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
```
    Gets a RequestValidator of a given RestApi.
    
    Parameters:
    
    getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.
    
    Returns:
    
    Result of the GetRequestValidator operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getRequestValidators
```
GetRequestValidatorsResult getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
```
    Gets the RequestValidators collection of a given RestApi.
    
    Parameters:
    
    getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.
    
    Returns:
    
    Result of the GetRequestValidators operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getResource
```
GetResourceResult getResource(GetResourceRequest getResourceRequest)
```
    Lists information about a resource.
    
    Parameters:
    
    getResourceRequest - Request to list information about a resource.
    
    Returns:
    
    Result of the GetResource operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getResources
```
GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
```
    Lists information about a collection of Resource resources.
    
    Parameters:
    
    getResourcesRequest - Request to list information about a collection of resources.
    
    Returns:
    
    Result of the GetResources operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getRestApi
```
GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
```
    Lists the RestApi resource in the collection.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getRestApis
```
GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
```
    Lists the RestApis resources for your collection.
    
    Parameters:
    
    getRestApisRequest - The GET request to list existing RestApis defined for your collection.
    
    Returns:
    
    Result of the GetRestApis operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getSdk
```
GetSdkResult getSdk(GetSdkRequest getSdkRequest)
```
    Generates a client SDK for a RestApi and Stage.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getSdkType
```
GetSdkTypeResult getSdkType(GetSdkTypeRequest getSdkTypeRequest)
```
    Parameters:
    
    getSdkTypeRequest - Get an SdkType instance.
    
    Returns:
    
    Result of the GetSdkType operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getSdkTypes
```
GetSdkTypesResult getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
```
    Parameters:
    
    getSdkTypesRequest - Get the SdkTypes collection.
    
    Returns:
    
    Result of the GetSdkTypes operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getStage
```
GetStageResult getStage(GetStageRequest getStageRequest)
```
    Gets information about a Stage resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getStages
```
GetStagesResult getStages(GetStagesRequest getStagesRequest)
```
    Gets information about one or more Stage resources.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getUsage
```
GetUsageResult getUsage(GetUsageRequest getUsageRequest)
```
    Gets the usage data of a usage plan in a specified time interval.
    
    Parameters:
    
    getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.
    
    Returns:
    
    Result of the GetUsage operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getUsagePlan
```
GetUsagePlanResult getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
```
    Gets a usage plan of a given plan identifier.
    
    Parameters:
    
    getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.
    
    Returns:
    
    Result of the GetUsagePlan operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getUsagePlanKey
```
GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
```
    Gets a usage plan key of a given key identifier.
    
    Parameters:
    
    getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.
    
    Returns:
    
    Result of the GetUsagePlanKey operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getUsagePlanKeys
```
GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
```
    Gets all the usage plan keys representing the API keys added to a specified usage plan.
    
    Parameters:
    
    getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
    
    Returns:
    
    Result of the GetUsagePlanKeys operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - getUsagePlans
```
GetUsagePlansResult getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
```
    Gets all the usage plans of the caller's account.
    
    Parameters:
    
    getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.
    
    Returns:
    
    Result of the GetUsagePlans operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - importApiKeys
```
ImportApiKeysResult importApiKeys(ImportApiKeysRequest importApiKeysRequest)
```
    Import API keys from an external source, such as a CSV-formatted file.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - importDocumentationParts
```
ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
```
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - importRestApi
```
ImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)
```
    A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - putGatewayResponse
```
PutGatewayResponseResult putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
```
    Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
    
    Parameters:
    
    putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
    
    Returns:
    
    Result of the PutGatewayResponse operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - putIntegration
```
PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
```
    Sets up a method's integration.
    
    Parameters:
    
    putIntegrationRequest - Sets up a method's integration.
    
    Returns:
    
    Result of the PutIntegration operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - putIntegrationResponse
```
PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
```
    Represents a put integration.
    
    Parameters:
    
    putIntegrationResponseRequest - Represents a put integration response request.
    
    Returns:
    
    Result of the PutIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - putMethod
```
PutMethodResult putMethod(PutMethodRequest putMethodRequest)
```
    Add a method to an existing Resource resource.
    
    Parameters:
    
    putMethodRequest - Request to add a method to an existing Resource resource.
    
    Returns:
    
    Result of the PutMethod operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - putMethodResponse
```
PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
```
    Adds a MethodResponse to an existing Method resource.
    
    Parameters:
    
    putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.
    
    Returns:
    
    Result of the PutMethodResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - putRestApi
```
PutRestApiResult putRestApi(PutRestApiRequest putRestApiRequest)
```
    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.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - testInvokeAuthorizer
```
TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
```
    Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
    
    Enable custom authorizers
    
    Parameters:
    
    testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.
    
    Returns:
    
    Result of the TestInvokeAuthorizer operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - testInvokeMethod
```
TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
```
    Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
    
    Parameters:
    
    testInvokeMethodRequest - Make a request to simulate the execution of a Method.
    
    Returns:
    
    Result of the TestInvokeMethod operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateAccount
```
UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
```
    Changes information about the current Account resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateApiKey
```
UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
```
    Changes information about an ApiKey resource.
    
    Parameters:
    
    updateApiKeyRequest - A request to change information about an ApiKey resource.
    
    Returns:
    
    Result of the UpdateApiKey operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - updateAuthorizer
```
UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
```
    Updates an existing Authorizer resource.
    
    AWS CLI
    
    Parameters:
    
    updateAuthorizerRequest - Request to update an existing Authorizer resource.
    
    Returns:
    
    Result of the UpdateAuthorizer operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateBasePathMapping
```
UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
```
    Changes information about the BasePathMapping resource.
    
    Parameters:
    
    updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.
    
    Returns:
    
    Result of the UpdateBasePathMapping operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateClientCertificate
```
UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
```
    Changes information about an ClientCertificate resource.
    
    Parameters:
    
    updateClientCertificateRequest - A request to change information about an ClientCertificate resource.
    
    Returns:
    
    Result of the UpdateClientCertificate operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - updateDeployment
```
UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
```
    Changes information about a Deployment resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
  - updateDocumentationPart
```
UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
```
    Parameters:
    
    updateDocumentationPartRequest - Updates an existing documentation part of a given API.
    
    Returns:
    
    Result of the UpdateDocumentationPart operation returned by the service.
    
    Throws:
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateDocumentationVersion
```
UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
```
    Parameters:
    
    updateDocumentationVersionRequest - Updates an existing documentation version of an API.
    
    Returns:
    
    Result of the UpdateDocumentationVersion operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateDomainName
```
UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
```
    Changes information about the DomainName resource.
    
    Parameters:
    
    updateDomainNameRequest - A request to change information about the DomainName resource.
    
    Returns:
    
    Result of the UpdateDomainName operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateGatewayResponse
```
UpdateGatewayResponseResult updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
```
    Updates a GatewayResponse of a specified response type on the given RestApi.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateIntegration
```
UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
```
    Represents an update integration.
    
    Parameters:
    
    updateIntegrationRequest - Represents an update integration request.
    
    Returns:
    
    Result of the UpdateIntegration operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - updateIntegrationResponse
```
UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
```
    Represents an update integration response.
    
    Parameters:
    
    updateIntegrationResponseRequest - Represents an update integration response request.
    
    Returns:
    
    Result of the UpdateIntegrationResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateMethod
```
UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
```
    Updates an existing Method resource.
    
    Parameters:
    
    updateMethodRequest - Request to update an existing Method resource.
    
    Returns:
    
    Result of the UpdateMethod operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateMethodResponse
```
UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
```
    Updates an existing MethodResponse resource.
    
    Parameters:
    
    updateMethodResponseRequest - A request to update an existing MethodResponse resource.
    
    Returns:
    
    Result of the UpdateMethodResponse operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateModel
```
UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
```
    Changes information about a model.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateRequestValidator
```
UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
```
    Updates a RequestValidator of a given RestApi.
    
    Parameters:
    
    updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.
    
    Returns:
    
    Result of the UpdateRequestValidator operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateResource
```
UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
```
    Changes information about a Resource resource.
    
    Parameters:
    
    updateResourceRequest - Request to change information about a Resource resource.
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateRestApi
```
UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
```
    Changes information about the specified API.
    
    Parameters:
    
    updateRestApiRequest - Request to update an existing RestApi resource in your collection.
    
    Returns:
    
    Result of the UpdateRestApi operation returned by the service.
    
    Throws:
    
    UnauthorizedException - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateStage
```
UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
```
    Changes information about a Stage resource.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
  - updateUsage
```
UpdateUsageResult updateUsage(UpdateUsageRequest updateUsageRequest)
```
    Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
  - updateUsagePlan
```
UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
```
    Updates a usage plan of a given plan Id.
    
    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 - The request is denied because the caller has insufficient permissions.
    
    TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.
    
    BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
    
    NotFoundException - The requested resource is not found. Make sure that the request URI is correct.
    
    ConflictException - The request configuration has conflicts. For details, see the accompanying error message.
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonApiGateway

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

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

getMethodResponse

getModel

getModelTemplate

getModels

getRequestValidator

getRequestValidators

getResource

getResources

getRestApi

getRestApis

getSdk