APIGatewayClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable
```
@Generated("software.amazon.awssdk:codegen")
public interface APIGatewayClient
extends AutoCloseable
```
Service client for accessing null. This can be created using the static builder() method. 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 Description

static String SERVICE_NAME

Fields
Modifier and Type	Field	Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static APIGatewayClientBuilder`	`builder()`	Create a builder that can be used to configure and create a `APIGatewayClient`.
`static APIGatewayClient`	`create()`	Create a `APIGatewayClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CreateApiKeyResponse`	`createApiKey(CreateApiKeyRequest createApiKeyRequest)`	Create an ApiKey resource.
`default CreateAuthorizerResponse`	`createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)`	Adds a new Authorizer resource to an existing RestApi resource.
`default CreateBasePathMappingResponse`	`createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)`	Creates a new BasePathMapping resource.
`default CreateDeploymentResponse`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)`	Creates a Deployment resource, which makes a specified RestApi callable over the internet.
`default CreateDocumentationPartResponse`	`createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)`
`default CreateDocumentationVersionResponse`	`createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)`
`default CreateDomainNameResponse`	`createDomainName(CreateDomainNameRequest createDomainNameRequest)`	Creates a new domain name.
`default CreateModelResponse`	`createModel(CreateModelRequest createModelRequest)`	Adds a new Model resource to an existing RestApi resource.
`default CreateRequestValidatorResponse`	`createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)`	Creates a ReqeustValidator of a given RestApi.
`default CreateResourceResponse`	`createResource(CreateResourceRequest createResourceRequest)`	Creates a Resource resource.
`default CreateRestApiResponse`	`createRestApi(CreateRestApiRequest createRestApiRequest)`	Creates a new RestApi resource.
`default CreateStageResponse`	`createStage(CreateStageRequest createStageRequest)`	Creates a new Stage resource that references a pre-existing Deployment for the API.
`default CreateUsagePlanResponse`	`createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)`	Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
`default CreateUsagePlanKeyResponse`	`createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)`	Creates a usage plan key for adding an existing API key to a usage plan.
`default DeleteApiKeyResponse`	`deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)`	Deletes the ApiKey resource.
`default DeleteAuthorizerResponse`	`deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)`	Deletes an existing Authorizer resource.
`default DeleteBasePathMappingResponse`	`deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)`	Deletes the BasePathMapping resource.
`default DeleteClientCertificateResponse`	`deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)`	Deletes the ClientCertificate resource.
`default DeleteDeploymentResponse`	`deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)`	Deletes a Deployment resource.
`default DeleteDocumentationPartResponse`	`deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)`
`default DeleteDocumentationVersionResponse`	`deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)`
`default DeleteDomainNameResponse`	`deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)`	Deletes the DomainName resource.
`default DeleteIntegrationResponse`	`deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)`	Represents a delete integration.
`default DeleteIntegrationResponseResponse`	`deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)`	Represents a delete integration response.
`default DeleteMethodResponse`	`deleteMethod(DeleteMethodRequest deleteMethodRequest)`	Deletes an existing Method resource.
`default DeleteMethodResponseResponse`	`deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)`	Deletes an existing MethodResponse resource.
`default DeleteModelResponse`	`deleteModel(DeleteModelRequest deleteModelRequest)`	Deletes a model.
`default DeleteRequestValidatorResponse`	`deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)`	Deletes a RequestValidator of a given RestApi.
`default DeleteResourceResponse`	`deleteResource(DeleteResourceRequest deleteResourceRequest)`	Deletes a Resource resource.
`default DeleteRestApiResponse`	`deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)`	Deletes the specified API.
`default DeleteStageResponse`	`deleteStage(DeleteStageRequest deleteStageRequest)`	Deletes a Stage resource.
`default DeleteUsagePlanResponse`	`deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)`	Deletes a usage plan of a given plan Id.
`default DeleteUsagePlanKeyResponse`	`deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)`	Deletes a usage plan key and remove the underlying API key from the associated usage plan.
`default FlushStageAuthorizersCacheResponse`	`flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)`	Flushes all authorizer cache entries on a stage.
`default FlushStageCacheResponse`	`flushStageCache(FlushStageCacheRequest flushStageCacheRequest)`	Flushes a stage's cache.
`default GenerateClientCertificateResponse`	`generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)`	Generates a ClientCertificate resource.
`default GetAccountResponse`	`getAccount(GetAccountRequest getAccountRequest)`	Gets information about the current Account resource.
`default GetApiKeyResponse`	`getApiKey(GetApiKeyRequest getApiKeyRequest)`	Gets information about the current ApiKey resource.
`default GetApiKeysResponse`	`getApiKeys(GetApiKeysRequest getApiKeysRequest)`	Gets information about the current ApiKeys resource.
`default GetAuthorizerResponse`	`getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)`	Describe an existing Authorizer resource.
`default GetAuthorizersResponse`	`getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)`	Describe an existing Authorizers resource.
`default GetBasePathMappingResponse`	`getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)`	Describe a BasePathMapping resource.
`default GetBasePathMappingsResponse`	`getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)`	Represents a collection of BasePathMapping resources.
`default GetClientCertificateResponse`	`getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)`	Gets information about the current ClientCertificate resource.
`default GetClientCertificatesResponse`	`getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)`	Gets a collection of ClientCertificate resources.
`default GetDeploymentResponse`	`getDeployment(GetDeploymentRequest getDeploymentRequest)`	Gets information about a Deployment resource.
`default GetDeploymentsResponse`	`getDeployments(GetDeploymentsRequest getDeploymentsRequest)`	Gets information about a Deployments collection.
`default GetDocumentationPartResponse`	`getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)`
`default GetDocumentationPartsResponse`	`getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)`
`default GetDocumentationVersionResponse`	`getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)`
`default GetDocumentationVersionsResponse`	`getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)`
`default GetDomainNameResponse`	`getDomainName(GetDomainNameRequest getDomainNameRequest)`	Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
`default GetDomainNamesResponse`	`getDomainNames(GetDomainNamesRequest getDomainNamesRequest)`	Represents a collection of DomainName resources.
`default GetExportResponse`	`getExport(GetExportRequest getExportRequest)`	Exports a deployed version of a RestApi in a specified format.
`default GetIntegrationResponse`	`getIntegration(GetIntegrationRequest getIntegrationRequest)`	Represents a get integration.
`default GetIntegrationResponseResponse`	`getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)`	Represents a get integration response.
`default GetMethodResponse`	`getMethod(GetMethodRequest getMethodRequest)`	Describe an existing Method resource.
`default GetMethodResponseResponse`	`getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)`	Describes a MethodResponse resource.
`default GetModelResponse`	`getModel(GetModelRequest getModelRequest)`	Describes an existing model defined for a RestApi resource.
`default GetModelsResponse`	`getModels(GetModelsRequest getModelsRequest)`	Describes existing Models defined for a RestApi resource.
`default GetModelTemplateResponse`	`getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)`	Generates a sample mapping template that can be used to transform a payload into the structure of a model.
`default GetRequestValidatorResponse`	`getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)`	Gets a RequestValidator of a given RestApi.
`default GetRequestValidatorsResponse`	`getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)`	Gets the RequestValidators collection of a given RestApi.
`default GetResourceResponse`	`getResource(GetResourceRequest getResourceRequest)`	Lists information about a resource.
`default GetResourcesResponse`	`getResources(GetResourcesRequest getResourcesRequest)`	Lists information about a collection of Resource resources.
`default GetRestApiResponse`	`getRestApi(GetRestApiRequest getRestApiRequest)`	Lists the RestApi resource in the collection.
`default GetRestApisResponse`	`getRestApis(GetRestApisRequest getRestApisRequest)`	Lists the RestApis resources for your collection.
`default GetSdkResponse`	`getSdk(GetSdkRequest getSdkRequest)`	Generates a client SDK for a RestApi and Stage.
`default GetSdkTypeResponse`	`getSdkType(GetSdkTypeRequest getSdkTypeRequest)`
`default GetSdkTypesResponse`	`getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)`
`default GetStageResponse`	`getStage(GetStageRequest getStageRequest)`	Gets information about a Stage resource.
`default GetStagesResponse`	`getStages(GetStagesRequest getStagesRequest)`	Gets information about one or more Stage resources.
`default GetUsageResponse`	`getUsage(GetUsageRequest getUsageRequest)`	Gets the usage data of a usage plan in a specified time interval.
`default GetUsagePlanResponse`	`getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)`	Gets a usage plan of a given plan identifier.
`default GetUsagePlanKeyResponse`	`getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)`	Gets a usage plan key of a given key identifier.
`default GetUsagePlanKeysResponse`	`getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)`	Gets all the usage plan keys representing the API keys added to a specified usage plan.
`default GetUsagePlansResponse`	`getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)`	Gets all the usage plans of the caller's account.
`default ImportApiKeysResponse`	`importApiKeys(ImportApiKeysRequest importApiKeysRequest)`	Import API keys from an external source, such as a CSV-formatted file.
`default ImportDocumentationPartsResponse`	`importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)`
`default ImportRestApiResponse`	`importRestApi(ImportRestApiRequest importRestApiRequest)`	A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
`default PutIntegrationResponse`	`putIntegration(PutIntegrationRequest putIntegrationRequest)`	Represents a put integration.
`default PutIntegrationResponseResponse`	`putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)`	Represents a put integration.
`default PutMethodResponse`	`putMethod(PutMethodRequest putMethodRequest)`	Add a method to an existing Resource resource.
`default PutMethodResponseResponse`	`putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)`	Adds a MethodResponse to an existing Method resource.
`default PutRestApiResponse`	`putRestApi(PutRestApiRequest putRestApiRequest)`	A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions.
`static ServiceMetadata`	`serviceMetadata()`
`default TestInvokeAuthorizerResponse`	`testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)`	Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
`default TestInvokeMethodResponse`	`testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)`	Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
`default UpdateAccountResponse`	`updateAccount(UpdateAccountRequest updateAccountRequest)`	Changes information about the current Account resource.
`default UpdateApiKeyResponse`	`updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)`	Changes information about an ApiKey resource.
`default UpdateAuthorizerResponse`	`updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)`	Updates an existing Authorizer resource.
`default UpdateBasePathMappingResponse`	`updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)`	Changes information about the BasePathMapping resource.
`default UpdateClientCertificateResponse`	`updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)`	Changes information about an ClientCertificate resource.
`default UpdateDeploymentResponse`	`updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)`	Changes information about a Deployment resource.
`default UpdateDocumentationPartResponse`	`updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)`
`default UpdateDocumentationVersionResponse`	`updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)`
`default UpdateDomainNameResponse`	`updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)`	Changes information about the DomainName resource.
`default UpdateIntegrationResponse`	`updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)`	Represents an update integration.
`default UpdateIntegrationResponseResponse`	`updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)`	Represents an update integration response.
`default UpdateMethodResponse`	`updateMethod(UpdateMethodRequest updateMethodRequest)`	Updates an existing Method resource.
`default UpdateMethodResponseResponse`	`updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)`	Updates an existing MethodResponse resource.
`default UpdateModelResponse`	`updateModel(UpdateModelRequest updateModelRequest)`	Changes information about a model.
`default UpdateRequestValidatorResponse`	`updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)`	Updates a RequestValidator of a given RestApi.
`default UpdateResourceResponse`	`updateResource(UpdateResourceRequest updateResourceRequest)`	Changes information about a Resource resource.
`default UpdateRestApiResponse`	`updateRestApi(UpdateRestApiRequest updateRestApiRequest)`	Changes information about the specified API.
`default UpdateStageResponse`	`updateStage(UpdateStageRequest updateStageRequest)`	Changes information about a Stage resource.
`default UpdateUsageResponse`	`updateUsage(UpdateUsageRequest updateUsageRequest)`	Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
`default UpdateUsagePlanResponse`	`updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)`	Updates a usage plan of a given plan Id.

Methods inherited from interface java.lang.AutoCloseable
close

Field Detail
- SERVICE_NAME
```
static final String SERVICE_NAME
```
  See Also:
  
  Constant Field Values

Method Detail

create
```
static APIGatewayClient create()
```
Create a APIGatewayClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder
```
static APIGatewayClientBuilder builder()
```
Create a builder that can be used to configure and create a APIGatewayClient.

createApiKey

default CreateApiKeyResponse createApiKey(CreateApiKeyRequest createApiKeyRequest)
                                   throws UnauthorizedException,
                                          NotFoundException,
                                          TooManyRequestsException,
                                          LimitExceededException,
                                          BadRequestException,
                                          ConflictException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; NotFoundException; TooManyRequestsException; LimitExceededException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createAuthorizer

default CreateAuthorizerResponse createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  NotFoundException,
                                                  LimitExceededException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; UnauthorizedException; NotFoundException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createBasePathMapping

default CreateBasePathMappingResponse createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
                                                     throws UnauthorizedException,
                                                            ConflictException,
                                                            BadRequestException,
                                                            NotFoundException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            APIGatewayException

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; ConflictException; BadRequestException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createDeployment

default CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest)
                                           throws UnauthorizedException,
                                                  BadRequestException,
                                                  NotFoundException,
                                                  ConflictException,
                                                  LimitExceededException,
                                                  TooManyRequestsException,
                                                  ServiceUnavailableException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; BadRequestException; NotFoundException; ConflictException; LimitExceededException; TooManyRequestsException; ServiceUnavailableException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createDocumentationPart

default CreateDocumentationPartResponse createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
                                                         throws BadRequestException,
                                                                ConflictException,
                                                                UnauthorizedException,
                                                                NotFoundException,
                                                                LimitExceededException,
                                                                TooManyRequestsException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

Parameters:: createDocumentationPartRequest - Creates a new documentation part of a given API.
Returns:: Result of the CreateDocumentationPart operation returned by the service.
Throws:: BadRequestException; ConflictException; UnauthorizedException; NotFoundException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createDocumentationVersion

default CreateDocumentationVersionResponse createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
                                                               throws BadRequestException,
                                                                      ConflictException,
                                                                      UnauthorizedException,
                                                                      NotFoundException,
                                                                      LimitExceededException,
                                                                      TooManyRequestsException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      APIGatewayException

Parameters:: createDocumentationVersionRequest - Creates a new documentation version of a given API.
Returns:: Result of the CreateDocumentationVersion operation returned by the service.
Throws:: BadRequestException; ConflictException; UnauthorizedException; NotFoundException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createDomainName

default CreateDomainNameResponse createDomainName(CreateDomainNameRequest createDomainNameRequest)
                                           throws UnauthorizedException,
                                                  BadRequestException,
                                                  ConflictException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createModel

default CreateModelResponse createModel(CreateModelRequest createModelRequest)
                                 throws BadRequestException,
                                        UnauthorizedException,
                                        NotFoundException,
                                        ConflictException,
                                        LimitExceededException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; UnauthorizedException; NotFoundException; ConflictException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createRequestValidator

default CreateRequestValidatorResponse createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
                                                       throws BadRequestException,
                                                              UnauthorizedException,
                                                              NotFoundException,
                                                              LimitExceededException,
                                                              TooManyRequestsException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              APIGatewayException

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; UnauthorizedException; NotFoundException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createResource

default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest)
                                       throws UnauthorizedException,
                                              NotFoundException,
                                              ConflictException,
                                              LimitExceededException,
                                              BadRequestException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

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; NotFoundException; ConflictException; LimitExceededException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createRestApi

default CreateRestApiResponse createRestApi(CreateRestApiRequest createRestApiRequest)
                                     throws UnauthorizedException,
                                            LimitExceededException,
                                            BadRequestException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; LimitExceededException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createStage

default CreateStageResponse createStage(CreateStageRequest createStageRequest)
                                 throws UnauthorizedException,
                                        BadRequestException,
                                        NotFoundException,
                                        ConflictException,
                                        LimitExceededException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; BadRequestException; NotFoundException; ConflictException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createUsagePlan

default CreateUsagePlanResponse createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
                                         throws BadRequestException,
                                                UnauthorizedException,
                                                TooManyRequestsException,
                                                LimitExceededException,
                                                ConflictException,
                                                NotFoundException,
                                                SdkBaseException,
                                                SdkClientException,
                                                APIGatewayException

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; UnauthorizedException; TooManyRequestsException; LimitExceededException; ConflictException; NotFoundException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createUsagePlanKey

default CreateUsagePlanKeyResponse createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
                                               throws BadRequestException,
                                                      ConflictException,
                                                      UnauthorizedException,
                                                      NotFoundException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      APIGatewayException

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; ConflictException; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteApiKey

default DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
                                   throws UnauthorizedException,
                                          NotFoundException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteAuthorizer

default DeleteAuthorizerResponse deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  TooManyRequestsException,
                                                  BadRequestException,
                                                  ConflictException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteBasePathMapping

default DeleteBasePathMappingResponse deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
                                                     throws UnauthorizedException,
                                                            NotFoundException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteClientCertificate

default DeleteClientCertificateResponse deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
                                                         throws UnauthorizedException,
                                                                TooManyRequestsException,
                                                                BadRequestException,
                                                                NotFoundException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

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; TooManyRequestsException; BadRequestException; NotFoundException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteDeployment

default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  BadRequestException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteDocumentationPart

default DeleteDocumentationPartResponse deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
                                                         throws UnauthorizedException,
                                                                NotFoundException,
                                                                TooManyRequestsException,
                                                                ConflictException,
                                                                BadRequestException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

Parameters:: deleteDocumentationPartRequest - Deletes an existing documentation part of an API.
Returns:: Result of the DeleteDocumentationPart operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; ConflictException; BadRequestException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteDocumentationVersion

default DeleteDocumentationVersionResponse deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
                                                               throws UnauthorizedException,
                                                                      NotFoundException,
                                                                      BadRequestException,
                                                                      ConflictException,
                                                                      TooManyRequestsException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      APIGatewayException

Parameters:: deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.
Returns:: Result of the DeleteDocumentationVersion operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteDomainName

default DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteIntegration

default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
                                             throws UnauthorizedException,
                                                    NotFoundException,
                                                    TooManyRequestsException,
                                                    ConflictException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    APIGatewayException

Represents a delete integration.

Parameters:: deleteIntegrationRequest - Represents a delete integration request.
Returns:: Result of the DeleteIntegration operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteIntegrationResponse

default DeleteIntegrationResponseResponse deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
                                                             throws UnauthorizedException,
                                                                    NotFoundException,
                                                                    TooManyRequestsException,
                                                                    BadRequestException,
                                                                    ConflictException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteMethod

default DeleteMethodResponse deleteMethod(DeleteMethodRequest deleteMethodRequest)
                                   throws UnauthorizedException,
                                          NotFoundException,
                                          TooManyRequestsException,
                                          ConflictException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; NotFoundException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteMethodResponse

default DeleteMethodResponseResponse deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
                                                   throws UnauthorizedException,
                                                          NotFoundException,
                                                          TooManyRequestsException,
                                                          BadRequestException,
                                                          ConflictException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteModel

default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest)
                                 throws UnauthorizedException,
                                        NotFoundException,
                                        TooManyRequestsException,
                                        BadRequestException,
                                        ConflictException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteRequestValidator

default DeleteRequestValidatorResponse deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
                                                       throws UnauthorizedException,
                                                              NotFoundException,
                                                              TooManyRequestsException,
                                                              BadRequestException,
                                                              ConflictException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteResource

default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest)
                                       throws UnauthorizedException,
                                              NotFoundException,
                                              BadRequestException,
                                              ConflictException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

Deletes a Resource resource.

Parameters:: deleteResourceRequest - Request to delete a Resource.
Returns:: Result of the DeleteResource operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteRestApi

default DeleteRestApiResponse deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            TooManyRequestsException,
                                            BadRequestException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteStage

default DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest)
                                 throws UnauthorizedException,
                                        NotFoundException,
                                        TooManyRequestsException,
                                        BadRequestException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; NotFoundException; TooManyRequestsException; BadRequestException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteUsagePlan

default DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
                                         throws UnauthorizedException,
                                                TooManyRequestsException,
                                                BadRequestException,
                                                NotFoundException,
                                                SdkBaseException,
                                                SdkClientException,
                                                APIGatewayException

Deletes a usage plan of a given plan Id.

Parameters:: deleteUsagePlanRequest - The DELETE request to delete a uasge plan of a given plan Id.
Returns:: Result of the DeleteUsagePlan operation returned by the service.
Throws:: UnauthorizedException; TooManyRequestsException; BadRequestException; NotFoundException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteUsagePlanKey

default DeleteUsagePlanKeyResponse deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
                                               throws BadRequestException,
                                                      ConflictException,
                                                      UnauthorizedException,
                                                      NotFoundException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      APIGatewayException

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; ConflictException; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

flushStageAuthorizersCache

default FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
                                                               throws UnauthorizedException,
                                                                      NotFoundException,
                                                                      BadRequestException,
                                                                      TooManyRequestsException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

flushStageCache

default FlushStageCacheResponse flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
                                         throws UnauthorizedException,
                                                NotFoundException,
                                                BadRequestException,
                                                TooManyRequestsException,
                                                SdkBaseException,
                                                SdkClientException,
                                                APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

generateClientCertificate

default GenerateClientCertificateResponse generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
                                                             throws UnauthorizedException,
                                                                    TooManyRequestsException,
                                                                    LimitExceededException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    APIGatewayException

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; TooManyRequestsException; LimitExceededException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getAccount
```
default GetAccountResponse getAccount(GetAccountRequest getAccountRequest)
                               throws UnauthorizedException,
                                      NotFoundException,
                                      TooManyRequestsException,
                                      SdkBaseException,
                                      SdkClientException,
                                      APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getApiKey
```
default GetApiKeyResponse getApiKey(GetApiKeyRequest getApiKeyRequest)
                             throws UnauthorizedException,
                                    NotFoundException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getApiKeys
```
default GetApiKeysResponse getApiKeys(GetApiKeysRequest getApiKeysRequest)
                               throws BadRequestException,
                                      UnauthorizedException,
                                      TooManyRequestsException,
                                      SdkBaseException,
                                      SdkClientException,
                                      APIGatewayException
```
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

UnauthorizedException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getAuthorizer

default GetAuthorizerResponse getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getAuthorizers

default GetAuthorizersResponse getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
                                       throws BadRequestException,
                                              UnauthorizedException,
                                              NotFoundException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getBasePathMapping

default GetBasePathMappingResponse getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
                                               throws UnauthorizedException,
                                                      NotFoundException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      APIGatewayException

Describe a BasePathMapping resource.

Parameters:: getBasePathMappingRequest - Request to describe a BasePathMapping resource.
Returns:: Result of the GetBasePathMapping operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getBasePathMappings

default GetBasePathMappingsResponse getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
                                                 throws UnauthorizedException,
                                                        NotFoundException,
                                                        TooManyRequestsException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getClientCertificate

default GetClientCertificateResponse getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
                                                   throws UnauthorizedException,
                                                          NotFoundException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getClientCertificates

default GetClientCertificatesResponse getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            APIGatewayException

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; UnauthorizedException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDeployment

default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            TooManyRequestsException,
                                            ServiceUnavailableException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; TooManyRequestsException; ServiceUnavailableException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDeployments

default GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest)
                                       throws BadRequestException,
                                              UnauthorizedException,
                                              TooManyRequestsException,
                                              ServiceUnavailableException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

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; UnauthorizedException; TooManyRequestsException; ServiceUnavailableException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDocumentationPart

default GetDocumentationPartResponse getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
                                                   throws UnauthorizedException,
                                                          NotFoundException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

Parameters:: getDocumentationPartRequest - Gets a specified documentation part of a given API.
Returns:: Result of the GetDocumentationPart operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDocumentationParts

default GetDocumentationPartsResponse getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
                                                     throws BadRequestException,
                                                            UnauthorizedException,
                                                            NotFoundException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            APIGatewayException

Parameters:: getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
Returns:: Result of the GetDocumentationParts operation returned by the service.
Throws:: BadRequestException; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDocumentationVersion

default GetDocumentationVersionResponse getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
                                                         throws UnauthorizedException,
                                                                NotFoundException,
                                                                TooManyRequestsException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

Parameters:: getDocumentationVersionRequest - Gets a documentation snapshot of an API.
Returns:: Result of the GetDocumentationVersion operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDocumentationVersions

default GetDocumentationVersionsResponse getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
                                                           throws BadRequestException,
                                                                  UnauthorizedException,
                                                                  NotFoundException,
                                                                  TooManyRequestsException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  APIGatewayException

Parameters:: getDocumentationVersionsRequest - Gets the documentation versions of an API.
Returns:: Result of the GetDocumentationVersions operation returned by the service.
Throws:: BadRequestException; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDomainName

default GetDomainNameResponse getDomainName(GetDomainNameRequest getDomainNameRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            ServiceUnavailableException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; ServiceUnavailableException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getDomainNames

default GetDomainNamesResponse getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
                                       throws BadRequestException,
                                              UnauthorizedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

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; UnauthorizedException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getExport

default GetExportResponse getExport(GetExportRequest getExportRequest)
                             throws UnauthorizedException,
                                    NotFoundException,
                                    BadRequestException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getIntegration

default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest)
                                       throws UnauthorizedException,
                                              NotFoundException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

Represents a get integration.

Parameters:: getIntegrationRequest - Represents a get integration request.
Returns:: Result of the GetIntegration operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getIntegrationResponse

default GetIntegrationResponseResponse getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
                                                       throws UnauthorizedException,
                                                              NotFoundException,
                                                              TooManyRequestsException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getMethod
```
default GetMethodResponse getMethod(GetMethodRequest getMethodRequest)
                             throws UnauthorizedException,
                                    NotFoundException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getMethodResponse

default GetMethodResponseResponse getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
                                             throws UnauthorizedException,
                                                    NotFoundException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    APIGatewayException

Describes a MethodResponse resource.

Parameters:: getMethodResponseRequest - Request to describe a MethodResponse resource.
Returns:: Result of the GetMethodResponse operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getModel
```
default GetModelResponse getModel(GetModelRequest getModelRequest)
                           throws UnauthorizedException,
                                  NotFoundException,
                                  TooManyRequestsException,
                                  SdkBaseException,
                                  SdkClientException,
                                  APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getModelTemplate

default GetModelTemplateResponse getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  BadRequestException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getModels

default GetModelsResponse getModels(GetModelsRequest getModelsRequest)
                             throws BadRequestException,
                                    UnauthorizedException,
                                    NotFoundException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getRequestValidator

default GetRequestValidatorResponse getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
                                                 throws UnauthorizedException,
                                                        NotFoundException,
                                                        TooManyRequestsException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getRequestValidators

default GetRequestValidatorsResponse getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
                                                   throws BadRequestException,
                                                          UnauthorizedException,
                                                          NotFoundException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getResource

default GetResourceResponse getResource(GetResourceRequest getResourceRequest)
                                 throws UnauthorizedException,
                                        NotFoundException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getResources

default GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest)
                                   throws BadRequestException,
                                          UnauthorizedException,
                                          NotFoundException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getRestApi
```
default GetRestApiResponse getRestApi(GetRestApiRequest getRestApiRequest)
                               throws UnauthorizedException,
                                      NotFoundException,
                                      TooManyRequestsException,
                                      SdkBaseException,
                                      SdkClientException,
                                      APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getRestApis
```
default GetRestApisResponse getRestApis(GetRestApisRequest getRestApisRequest)
                                 throws BadRequestException,
                                        UnauthorizedException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException
```
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

UnauthorizedException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSdk
```
default GetSdkResponse getSdk(GetSdkRequest getSdkRequest)
                       throws UnauthorizedException,
                              NotFoundException,
                              BadRequestException,
                              TooManyRequestsException,
                              SdkBaseException,
                              SdkClientException,
                              APIGatewayException
```
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

NotFoundException

BadRequestException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSdkType

default GetSdkTypeResponse getSdkType(GetSdkTypeRequest getSdkTypeRequest)
                               throws UnauthorizedException,
                                      NotFoundException,
                                      TooManyRequestsException,
                                      SdkBaseException,
                                      SdkClientException,
                                      APIGatewayException

Parameters:: getSdkTypeRequest - Get an SdkType instance.
Returns:: Result of the GetSdkType operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSdkTypes
```
default GetSdkTypesResponse getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
                                 throws UnauthorizedException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException
```
Parameters:

getSdkTypesRequest - Get the SdkTypes collection.

Returns:

Result of the GetSdkTypes operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getStage
```
default GetStageResponse getStage(GetStageRequest getStageRequest)
                           throws UnauthorizedException,
                                  NotFoundException,
                                  TooManyRequestsException,
                                  SdkBaseException,
                                  SdkClientException,
                                  APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getStages
```
default GetStagesResponse getStages(GetStagesRequest getStagesRequest)
                             throws UnauthorizedException,
                                    NotFoundException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException
```
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

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getUsage
```
default GetUsageResponse getUsage(GetUsageRequest getUsageRequest)
                           throws BadRequestException,
                                  UnauthorizedException,
                                  NotFoundException,
                                  TooManyRequestsException,
                                  SdkBaseException,
                                  SdkClientException,
                                  APIGatewayException
```
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

UnauthorizedException

NotFoundException

TooManyRequestsException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getUsagePlan

default GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
                                   throws BadRequestException,
                                          UnauthorizedException,
                                          NotFoundException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getUsagePlanKey

default GetUsagePlanKeyResponse getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
                                         throws BadRequestException,
                                                UnauthorizedException,
                                                NotFoundException,
                                                TooManyRequestsException,
                                                SdkBaseException,
                                                SdkClientException,
                                                APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getUsagePlanKeys

default GetUsagePlanKeysResponse getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  NotFoundException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getUsagePlans

default GetUsagePlansResponse getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
                                     throws BadRequestException,
                                            UnauthorizedException,
                                            TooManyRequestsException,
                                            ConflictException,
                                            NotFoundException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; UnauthorizedException; TooManyRequestsException; ConflictException; NotFoundException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

importApiKeys

default ImportApiKeysResponse importApiKeys(ImportApiKeysRequest importApiKeysRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            TooManyRequestsException,
                                            LimitExceededException,
                                            BadRequestException,
                                            ConflictException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; TooManyRequestsException; LimitExceededException; BadRequestException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

importDocumentationParts

default ImportDocumentationPartsResponse importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
                                                           throws UnauthorizedException,
                                                                  NotFoundException,
                                                                  BadRequestException,
                                                                  LimitExceededException,
                                                                  TooManyRequestsException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  APIGatewayException

Parameters:: importDocumentationPartsRequest - Import documentation parts from an external (e.g., Swagger) definition file.
Returns:: Result of the ImportDocumentationParts operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; BadRequestException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

importRestApi

default ImportRestApiResponse importRestApi(ImportRestApiRequest importRestApiRequest)
                                     throws UnauthorizedException,
                                            LimitExceededException,
                                            BadRequestException,
                                            TooManyRequestsException,
                                            ConflictException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; LimitExceededException; BadRequestException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putIntegration

default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest)
                                       throws UnauthorizedException,
                                              BadRequestException,
                                              ConflictException,
                                              NotFoundException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

Represents a put integration.

Parameters:: putIntegrationRequest - Represents a put integration request.
Returns:: Result of the PutIntegration operation returned by the service.
Throws:: UnauthorizedException; BadRequestException; ConflictException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putIntegrationResponse

default PutIntegrationResponseResponse putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
                                                       throws UnauthorizedException,
                                                              NotFoundException,
                                                              LimitExceededException,
                                                              BadRequestException,
                                                              TooManyRequestsException,
                                                              ConflictException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              APIGatewayException

Represents a put integration.

Parameters:: putIntegrationResponseRequest - Represents a put integration response request.
Returns:: Result of the PutIntegrationResponse operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; LimitExceededException; BadRequestException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putMethod

default PutMethodResponse putMethod(PutMethodRequest putMethodRequest)
                             throws BadRequestException,
                                    UnauthorizedException,
                                    NotFoundException,
                                    ConflictException,
                                    LimitExceededException,
                                    TooManyRequestsException,
                                    SdkBaseException,
                                    SdkClientException,
                                    APIGatewayException

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; UnauthorizedException; NotFoundException; ConflictException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putMethodResponse

default PutMethodResponseResponse putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
                                             throws UnauthorizedException,
                                                    NotFoundException,
                                                    ConflictException,
                                                    LimitExceededException,
                                                    BadRequestException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    APIGatewayException

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; NotFoundException; ConflictException; LimitExceededException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putRestApi
```
default PutRestApiResponse putRestApi(PutRestApiRequest putRestApiRequest)
                               throws UnauthorizedException,
                                      LimitExceededException,
                                      NotFoundException,
                                      BadRequestException,
                                      TooManyRequestsException,
                                      ConflictException,
                                      SdkBaseException,
                                      SdkClientException,
                                      APIGatewayException
```
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

LimitExceededException

NotFoundException

BadRequestException

TooManyRequestsException

ConflictException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

testInvokeAuthorizer

default TestInvokeAuthorizerResponse testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
                                                   throws BadRequestException,
                                                          UnauthorizedException,
                                                          NotFoundException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

testInvokeMethod

default TestInvokeMethodResponse testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
                                           throws BadRequestException,
                                                  UnauthorizedException,
                                                  NotFoundException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; UnauthorizedException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateAccount

default UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest)
                                     throws UnauthorizedException,
                                            BadRequestException,
                                            NotFoundException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; BadRequestException; NotFoundException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateApiKey

default UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
                                   throws UnauthorizedException,
                                          NotFoundException,
                                          BadRequestException,
                                          TooManyRequestsException,
                                          ConflictException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateAuthorizer

default UpdateAuthorizerResponse updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  BadRequestException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateBasePathMapping

default UpdateBasePathMappingResponse updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
                                                     throws UnauthorizedException,
                                                            NotFoundException,
                                                            ConflictException,
                                                            BadRequestException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            APIGatewayException

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; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateClientCertificate

default UpdateClientCertificateResponse updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
                                                         throws UnauthorizedException,
                                                                TooManyRequestsException,
                                                                BadRequestException,
                                                                NotFoundException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

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; TooManyRequestsException; BadRequestException; NotFoundException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateDeployment

default UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  BadRequestException,
                                                  TooManyRequestsException,
                                                  ServiceUnavailableException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; ServiceUnavailableException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateDocumentationPart

default UpdateDocumentationPartResponse updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
                                                         throws BadRequestException,
                                                                UnauthorizedException,
                                                                NotFoundException,
                                                                ConflictException,
                                                                LimitExceededException,
                                                                TooManyRequestsException,
                                                                SdkBaseException,
                                                                SdkClientException,
                                                                APIGatewayException

Parameters:: updateDocumentationPartRequest - Updates an existing documentation part of a given API.
Returns:: Result of the UpdateDocumentationPart operation returned by the service.
Throws:: BadRequestException; UnauthorizedException; NotFoundException; ConflictException; LimitExceededException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateDocumentationVersion

default UpdateDocumentationVersionResponse updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
                                                               throws UnauthorizedException,
                                                                      NotFoundException,
                                                                      ConflictException,
                                                                      BadRequestException,
                                                                      TooManyRequestsException,
                                                                      SdkBaseException,
                                                                      SdkClientException,
                                                                      APIGatewayException

Parameters:: updateDocumentationVersionRequest - Updates an existing documentation version of an API.
Returns:: Result of the UpdateDocumentationVersion operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateDomainName

default UpdateDomainNameResponse updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
                                           throws UnauthorizedException,
                                                  NotFoundException,
                                                  BadRequestException,
                                                  ConflictException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  APIGatewayException

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; NotFoundException; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateIntegration

default UpdateIntegrationResponse updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
                                             throws UnauthorizedException,
                                                    NotFoundException,
                                                    BadRequestException,
                                                    TooManyRequestsException,
                                                    ConflictException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    APIGatewayException

Represents an update integration.

Parameters:: updateIntegrationRequest - Represents an update integration request.
Returns:: Result of the UpdateIntegration operation returned by the service.
Throws:: UnauthorizedException; NotFoundException; BadRequestException; TooManyRequestsException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateIntegrationResponse

default UpdateIntegrationResponseResponse updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
                                                             throws UnauthorizedException,
                                                                    NotFoundException,
                                                                    ConflictException,
                                                                    BadRequestException,
                                                                    TooManyRequestsException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    APIGatewayException

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; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateMethod

default UpdateMethodResponse updateMethod(UpdateMethodRequest updateMethodRequest)
                                   throws UnauthorizedException,
                                          NotFoundException,
                                          BadRequestException,
                                          ConflictException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          APIGatewayException

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; NotFoundException; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateMethodResponse

default UpdateMethodResponseResponse updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
                                                   throws UnauthorizedException,
                                                          NotFoundException,
                                                          ConflictException,
                                                          LimitExceededException,
                                                          BadRequestException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          APIGatewayException

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; NotFoundException; ConflictException; LimitExceededException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateModel

default UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest)
                                 throws UnauthorizedException,
                                        NotFoundException,
                                        BadRequestException,
                                        ConflictException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; NotFoundException; BadRequestException; ConflictException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateRequestValidator

default UpdateRequestValidatorResponse updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
                                                       throws UnauthorizedException,
                                                              NotFoundException,
                                                              BadRequestException,
                                                              TooManyRequestsException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              APIGatewayException

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; NotFoundException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateResource

default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest)
                                       throws UnauthorizedException,
                                              NotFoundException,
                                              ConflictException,
                                              BadRequestException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              APIGatewayException

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; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateRestApi

default UpdateRestApiResponse updateRestApi(UpdateRestApiRequest updateRestApiRequest)
                                     throws UnauthorizedException,
                                            NotFoundException,
                                            ConflictException,
                                            BadRequestException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            APIGatewayException

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; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateStage

default UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest)
                                 throws UnauthorizedException,
                                        NotFoundException,
                                        ConflictException,
                                        BadRequestException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException

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; NotFoundException; ConflictException; BadRequestException; TooManyRequestsException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateUsage
```
default UpdateUsageResponse updateUsage(UpdateUsageRequest updateUsageRequest)
                                 throws UnauthorizedException,
                                        TooManyRequestsException,
                                        BadRequestException,
                                        NotFoundException,
                                        SdkBaseException,
                                        SdkClientException,
                                        APIGatewayException
```
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.

Parameters:

updateUsageRequest - The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified API key.

Returns:

Result of the UpdateUsage operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateUsagePlan

default UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
                                         throws UnauthorizedException,
                                                TooManyRequestsException,
                                                BadRequestException,
                                                NotFoundException,
                                                ConflictException,
                                                SdkBaseException,
                                                SdkClientException,
                                                APIGatewayException

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; TooManyRequestsException; BadRequestException; NotFoundException; ConflictException; SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.; SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc); APIGatewayException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

serviceMetadata

static ServiceMetadata serviceMetadata()

Interface APIGatewayClient

Field Summary

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE_NAME

Method Detail

create

builder

createApiKey

createAuthorizer

createBasePathMapping

createDeployment

createDocumentationPart

createDocumentationVersion

createDomainName

createModel

createRequestValidator

createResource

createRestApi

createStage

createUsagePlan

createUsagePlanKey

deleteApiKey

deleteAuthorizer

deleteBasePathMapping

deleteClientCertificate

deleteDeployment

deleteDocumentationPart

deleteDocumentationVersion

deleteDomainName

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

getIntegration

getIntegrationResponse

getMethod

getMethodResponse

getModel

getModelTemplate

getModels

getRequestValidator

getRequestValidators

getResource

getResources

getRestApi

getRestApis

getSdk

getSdkType

getSdkTypes

getStage