@Generated(value="software.amazon.awssdk:codegen") public interface APIGatewayClient extends SdkClient, SdkAutoCloseable
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest)
Create an ApiKey resource.
|
default CreateApiKeyResponse |
createApiKey(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
|
default CreateAuthorizerResponse |
createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
|
default CreateAuthorizerResponse |
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
|
default CreateBasePathMappingResponse |
createBasePathMapping(Consumer<CreateBasePathMappingRequest.Builder> createBasePathMappingRequest)
Creates a new BasePathMapping resource.
|
default CreateBasePathMappingResponse |
createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
|
default CreateDeploymentResponse |
createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
default CreateDeploymentResponse |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
default CreateDocumentationPartResponse |
createDocumentationPart(Consumer<CreateDocumentationPartRequest.Builder> createDocumentationPartRequest)
Invokes the CreateDocumentationPart operation.
|
default CreateDocumentationPartResponse |
createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
Invokes the CreateDocumentationPart operation.
|
default CreateDocumentationVersionResponse |
createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest)
Invokes the CreateDocumentationVersion operation.
|
default CreateDocumentationVersionResponse |
createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
Invokes the CreateDocumentationVersion operation.
|
default CreateDomainNameResponse |
createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest)
Creates a new domain name.
|
default CreateDomainNameResponse |
createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
|
default CreateModelResponse |
createModel(Consumer<CreateModelRequest.Builder> createModelRequest)
|
default CreateModelResponse |
createModel(CreateModelRequest createModelRequest)
|
default CreateRequestValidatorResponse |
createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest)
Creates a ReqeustValidator of a given RestApi.
|
default CreateRequestValidatorResponse |
createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
Creates a ReqeustValidator of a given RestApi.
|
default CreateResourceResponse |
createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest)
Creates a Resource resource.
|
default CreateResourceResponse |
createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
|
default CreateRestApiResponse |
createRestApi(Consumer<CreateRestApiRequest.Builder> createRestApiRequest)
Creates a new RestApi resource.
|
default CreateRestApiResponse |
createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
|
default CreateStageResponse |
createStage(Consumer<CreateStageRequest.Builder> createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
default CreateStageResponse |
createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
default CreateUsagePlanResponse |
createUsagePlan(Consumer<CreateUsagePlanRequest.Builder> createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
payload.
|
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(Consumer<CreateUsagePlanKeyRequest.Builder> createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
|
default CreateUsagePlanKeyResponse |
createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
|
default DeleteApiKeyResponse |
deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest)
Deletes the ApiKey resource.
|
default DeleteApiKeyResponse |
deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
|
default DeleteAuthorizerResponse |
deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
|
default DeleteAuthorizerResponse |
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
|
default DeleteBasePathMappingResponse |
deleteBasePathMapping(Consumer<DeleteBasePathMappingRequest.Builder> deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
|
default DeleteBasePathMappingResponse |
deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
|
default DeleteClientCertificateResponse |
deleteClientCertificate(Consumer<DeleteClientCertificateRequest.Builder> deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
|
default DeleteClientCertificateResponse |
deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
|
default DeleteDeploymentResponse |
deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)
Deletes a Deployment resource.
|
default DeleteDeploymentResponse |
deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource.
|
default DeleteDocumentationPartResponse |
deleteDocumentationPart(Consumer<DeleteDocumentationPartRequest.Builder> deleteDocumentationPartRequest)
Invokes the DeleteDocumentationPart operation.
|
default DeleteDocumentationPartResponse |
deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
Invokes the DeleteDocumentationPart operation.
|
default DeleteDocumentationVersionResponse |
deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest)
Invokes the DeleteDocumentationVersion operation.
|
default DeleteDocumentationVersionResponse |
deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
Invokes the DeleteDocumentationVersion operation.
|
default DeleteDomainNameResponse |
deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest)
Deletes the DomainName resource.
|
default DeleteDomainNameResponse |
deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
|
default DeleteGatewayResponseResponse |
deleteGatewayResponse(Consumer<DeleteGatewayResponseRequest.Builder> deleteGatewayResponseRequest)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and
resets it with the default settings.
|
default DeleteGatewayResponseResponse |
deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and
resets it with the default settings.
|
default DeleteIntegrationResponse |
deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)
Represents a delete integration.
|
default DeleteIntegrationResponse |
deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
|
default DeleteIntegrationResponseResponse |
deleteIntegrationResponse(Consumer<DeleteIntegrationResponseRequest.Builder> deleteIntegrationResponseRequest)
Represents a delete integration response.
|
default DeleteIntegrationResponseResponse |
deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
|
default DeleteMethodResponse |
deleteMethod(Consumer<DeleteMethodRequest.Builder> deleteMethodRequest)
Deletes an existing Method resource.
|
default DeleteMethodResponse |
deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
|
default DeleteMethodResponseResponse |
deleteMethodResponse(Consumer<DeleteMethodResponseRequest.Builder> deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
|
default DeleteMethodResponseResponse |
deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
|
default DeleteModelResponse |
deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)
Deletes a model.
|
default DeleteModelResponse |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
default DeleteRequestValidatorResponse |
deleteRequestValidator(Consumer<DeleteRequestValidatorRequest.Builder> deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
|
default DeleteRequestValidatorResponse |
deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
|
default DeleteResourceResponse |
deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest)
Deletes a Resource resource.
|
default DeleteResourceResponse |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
|
default DeleteRestApiResponse |
deleteRestApi(Consumer<DeleteRestApiRequest.Builder> deleteRestApiRequest)
Deletes the specified API.
|
default DeleteRestApiResponse |
deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
|
default DeleteStageResponse |
deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
Deletes a Stage resource.
|
default DeleteStageResponse |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
|
default DeleteUsagePlanResponse |
deleteUsagePlan(Consumer<DeleteUsagePlanRequest.Builder> deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
|
default DeleteUsagePlanResponse |
deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
|
default DeleteUsagePlanKeyResponse |
deleteUsagePlanKey(Consumer<DeleteUsagePlanKeyRequest.Builder> deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
default DeleteUsagePlanKeyResponse |
deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
default FlushStageAuthorizersCacheResponse |
flushStageAuthorizersCache(Consumer<FlushStageAuthorizersCacheRequest.Builder> flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
|
default FlushStageAuthorizersCacheResponse |
flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
|
default FlushStageCacheResponse |
flushStageCache(Consumer<FlushStageCacheRequest.Builder> flushStageCacheRequest)
Flushes a stage's cache.
|
default FlushStageCacheResponse |
flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
|
default GenerateClientCertificateResponse |
generateClientCertificate(Consumer<GenerateClientCertificateRequest.Builder> generateClientCertificateRequest)
Generates a ClientCertificate resource.
|
default GenerateClientCertificateResponse |
generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
|
default GetAccountResponse |
getAccount()
Gets information about the current Account resource.
|
default GetAccountResponse |
getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)
Gets information about the current Account resource.
|
default GetAccountResponse |
getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
|
default GetApiKeyResponse |
getApiKey(Consumer<GetApiKeyRequest.Builder> getApiKeyRequest)
Gets information about the current ApiKey resource.
|
default GetApiKeyResponse |
getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
|
default GetApiKeysResponse |
getApiKeys()
Gets information about the current ApiKeys resource.
|
default GetApiKeysResponse |
getApiKeys(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
Gets information about the current ApiKeys resource.
|
default GetApiKeysResponse |
getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
|
default GetAuthorizerResponse |
getAuthorizer(Consumer<GetAuthorizerRequest.Builder> getAuthorizerRequest)
Describe an existing Authorizer resource.
|
default GetAuthorizerResponse |
getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
|
default GetAuthorizersResponse |
getAuthorizers(Consumer<GetAuthorizersRequest.Builder> getAuthorizersRequest)
Describe an existing Authorizers resource.
|
default GetAuthorizersResponse |
getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
|
default GetBasePathMappingResponse |
getBasePathMapping(Consumer<GetBasePathMappingRequest.Builder> getBasePathMappingRequest)
Describe a BasePathMapping resource.
|
default GetBasePathMappingResponse |
getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
|
default GetBasePathMappingsResponse |
getBasePathMappings(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
|
default GetBasePathMappingsResponse |
getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
|
default GetClientCertificateResponse |
getClientCertificate(Consumer<GetClientCertificateRequest.Builder> getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
|
default GetClientCertificateResponse |
getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
|
default GetClientCertificatesResponse |
getClientCertificates()
Gets a collection of ClientCertificate resources.
|
default GetClientCertificatesResponse |
getClientCertificates(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
|
default GetClientCertificatesResponse |
getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
|
default GetDeploymentResponse |
getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
Gets information about a Deployment resource.
|
default GetDeploymentResponse |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
|
default GetDeploymentsResponse |
getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)
Gets information about a Deployments collection.
|
default GetDeploymentsResponse |
getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
|
default GetDocumentationPartResponse |
getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest)
Invokes the GetDocumentationPart operation.
|
default GetDocumentationPartResponse |
getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
Invokes the GetDocumentationPart operation.
|
default GetDocumentationPartsResponse |
getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest)
Invokes the GetDocumentationParts operation.
|
default GetDocumentationPartsResponse |
getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
Invokes the GetDocumentationParts operation.
|
default GetDocumentationVersionResponse |
getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest)
Invokes the GetDocumentationVersion operation.
|
default GetDocumentationVersionResponse |
getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
Invokes the GetDocumentationVersion operation.
|
default GetDocumentationVersionsResponse |
getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest)
Invokes the GetDocumentationVersions operation.
|
default GetDocumentationVersionsResponse |
getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
Invokes the GetDocumentationVersions operation.
|
default GetDomainNameResponse |
getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
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()
Represents a collection of DomainName resources.
|
default GetDomainNamesResponse |
getDomainNames(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
Represents a collection of DomainName resources.
|
default GetDomainNamesResponse |
getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
|
default GetExportResponse |
getExport(Consumer<GetExportRequest.Builder> getExportRequest)
Exports a deployed version of a RestApi in a specified format.
|
default GetExportResponse |
getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
|
default GetGatewayResponseResponse |
getGatewayResponse(Consumer<GetGatewayResponseRequest.Builder> getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
|
default GetGatewayResponseResponse |
getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
|
default GetGatewayResponsesResponse |
getGatewayResponses(Consumer<GetGatewayResponsesRequest.Builder> getGatewayResponsesRequest)
Gets the GatewayResponses collection on the given RestApi.
|
default GetGatewayResponsesResponse |
getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)
Gets the GatewayResponses collection on the given RestApi.
|
default GetIntegrationResponse |
getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)
Represents a get integration.
|
default GetIntegrationResponse |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
|
default GetIntegrationResponseResponse |
getIntegrationResponse(Consumer<GetIntegrationResponseRequest.Builder> getIntegrationResponseRequest)
Represents a get integration response.
|
default GetIntegrationResponseResponse |
getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
|
default GetMethodResponse |
getMethod(Consumer<GetMethodRequest.Builder> getMethodRequest)
Describe an existing Method resource.
|
default GetMethodResponse |
getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
|
default GetMethodResponseResponse |
getMethodResponse(Consumer<GetMethodResponseRequest.Builder> getMethodResponseRequest)
Describes a MethodResponse resource.
|
default GetMethodResponseResponse |
getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
|
default GetModelResponse |
getModel(Consumer<GetModelRequest.Builder> getModelRequest)
Describes an existing model defined for a RestApi resource.
|
default GetModelResponse |
getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
|
default GetModelsResponse |
getModels(Consumer<GetModelsRequest.Builder> getModelsRequest)
|
default GetModelsResponse |
getModels(GetModelsRequest getModelsRequest)
|
default GetModelTemplateResponse |
getModelTemplate(Consumer<GetModelTemplateRequest.Builder> getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
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(Consumer<GetRequestValidatorRequest.Builder> getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
|
default GetRequestValidatorResponse |
getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
|
default GetRequestValidatorsResponse |
getRequestValidators(Consumer<GetRequestValidatorsRequest.Builder> getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
|
default GetRequestValidatorsResponse |
getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
|
default GetResourceResponse |
getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)
Lists information about a resource.
|
default GetResourceResponse |
getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
|
default GetResourcesResponse |
getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Lists information about a collection of Resource resources.
|
default GetResourcesResponse |
getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
|
default GetRestApiResponse |
getRestApi(Consumer<GetRestApiRequest.Builder> getRestApiRequest)
Lists the RestApi resource in the collection.
|
default GetRestApiResponse |
getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
|
default GetRestApisResponse |
getRestApis()
Lists the RestApis resources for your collection.
|
default GetRestApisResponse |
getRestApis(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
Lists the RestApis resources for your collection.
|
default GetRestApisResponse |
getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
|
default GetSdkResponse |
getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest)
|
default GetSdkResponse |
getSdk(GetSdkRequest getSdkRequest)
|
default GetSdkTypeResponse |
getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest)
Invokes the GetSdkType operation.
|
default GetSdkTypeResponse |
getSdkType(GetSdkTypeRequest getSdkTypeRequest)
Invokes the GetSdkType operation.
|
default GetSdkTypesResponse |
getSdkTypes()
Invokes the GetSdkTypes operation.
|
default GetSdkTypesResponse |
getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest)
Invokes the GetSdkTypes operation.
|
default GetSdkTypesResponse |
getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
Invokes the GetSdkTypes operation.
|
default GetStageResponse |
getStage(Consumer<GetStageRequest.Builder> getStageRequest)
Gets information about a Stage resource.
|
default GetStageResponse |
getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
|
default GetStagesResponse |
getStages(Consumer<GetStagesRequest.Builder> getStagesRequest)
Gets information about one or more Stage resources.
|
default GetStagesResponse |
getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
|
default GetUsageResponse |
getUsage(Consumer<GetUsageRequest.Builder> getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
|
default GetUsageResponse |
getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
|
default GetUsagePlanResponse |
getUsagePlan(Consumer<GetUsagePlanRequest.Builder> getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
|
default GetUsagePlanResponse |
getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
|
default GetUsagePlanKeyResponse |
getUsagePlanKey(Consumer<GetUsagePlanKeyRequest.Builder> getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
|
default GetUsagePlanKeyResponse |
getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
|
default GetUsagePlanKeysResponse |
getUsagePlanKeys(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
default GetUsagePlanKeysResponse |
getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
default GetUsagePlansResponse |
getUsagePlans()
Gets all the usage plans of the caller's account.
|
default GetUsagePlansResponse |
getUsagePlans(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
default GetUsagePlansResponse |
getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
default ImportApiKeysResponse |
importApiKeys(Consumer<ImportApiKeysRequest.Builder> importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
|
default ImportApiKeysResponse |
importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
|
default ImportDocumentationPartsResponse |
importDocumentationParts(Consumer<ImportDocumentationPartsRequest.Builder> importDocumentationPartsRequest)
Invokes the ImportDocumentationParts operation.
|
default ImportDocumentationPartsResponse |
importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
Invokes the ImportDocumentationParts operation.
|
default ImportRestApiResponse |
importRestApi(Consumer<ImportRestApiRequest.Builder> importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
|
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 PutGatewayResponseResponse |
putGatewayResponse(Consumer<PutGatewayResponseRequest.Builder> putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given
RestApi.
|
default PutGatewayResponseResponse |
putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given
RestApi.
|
default PutIntegrationResponse |
putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)
Sets up a method's integration.
|
default PutIntegrationResponse |
putIntegration(PutIntegrationRequest putIntegrationRequest)
Sets up a method's integration.
|
default PutIntegrationResponseResponse |
putIntegrationResponse(Consumer<PutIntegrationResponseRequest.Builder> putIntegrationResponseRequest)
Represents a put integration.
|
default PutIntegrationResponseResponse |
putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
|
default PutMethodResponse |
putMethod(Consumer<PutMethodRequest.Builder> putMethodRequest)
Add a method to an existing Resource resource.
|
default PutMethodResponse |
putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
|
default PutMethodResponseResponse |
putMethodResponse(Consumer<PutMethodResponseRequest.Builder> putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
|
default PutMethodResponseResponse |
putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
|
default PutRestApiResponse |
putRestApi(Consumer<PutRestApiRequest.Builder> putRestApiRequest)
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API
definitions.
|
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(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming
request body.
|
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(Consumer<TestInvokeMethodRequest.Builder> testInvokeMethodRequest)
|
default TestInvokeMethodResponse |
testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
|
default UpdateAccountResponse |
updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
Changes information about the current Account resource.
|
default UpdateAccountResponse |
updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
|
default UpdateApiKeyResponse |
updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest)
Changes information about an ApiKey resource.
|
default UpdateApiKeyResponse |
updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
|
default UpdateAuthorizerResponse |
updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest)
Updates an existing Authorizer resource.
|
default UpdateAuthorizerResponse |
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
|
default UpdateBasePathMappingResponse |
updateBasePathMapping(Consumer<UpdateBasePathMappingRequest.Builder> updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
|
default UpdateBasePathMappingResponse |
updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
|
default UpdateClientCertificateResponse |
updateClientCertificate(Consumer<UpdateClientCertificateRequest.Builder> updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
|
default UpdateClientCertificateResponse |
updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
|
default UpdateDeploymentResponse |
updateDeployment(Consumer<UpdateDeploymentRequest.Builder> updateDeploymentRequest)
Changes information about a Deployment resource.
|
default UpdateDeploymentResponse |
updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
|
default UpdateDocumentationPartResponse |
updateDocumentationPart(Consumer<UpdateDocumentationPartRequest.Builder> updateDocumentationPartRequest)
Invokes the UpdateDocumentationPart operation.
|
default UpdateDocumentationPartResponse |
updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
Invokes the UpdateDocumentationPart operation.
|
default UpdateDocumentationVersionResponse |
updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest)
Invokes the UpdateDocumentationVersion operation.
|
default UpdateDocumentationVersionResponse |
updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
Invokes the UpdateDocumentationVersion operation.
|
default UpdateDomainNameResponse |
updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest)
Changes information about the DomainName resource.
|
default UpdateDomainNameResponse |
updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
|
default UpdateGatewayResponseResponse |
updateGatewayResponse(Consumer<UpdateGatewayResponseRequest.Builder> updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
|
default UpdateGatewayResponseResponse |
updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
|
default UpdateIntegrationResponse |
updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest)
Represents an update integration.
|
default UpdateIntegrationResponse |
updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
|
default UpdateIntegrationResponseResponse |
updateIntegrationResponse(Consumer<UpdateIntegrationResponseRequest.Builder> updateIntegrationResponseRequest)
Represents an update integration response.
|
default UpdateIntegrationResponseResponse |
updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
|
default UpdateMethodResponse |
updateMethod(Consumer<UpdateMethodRequest.Builder> updateMethodRequest)
Updates an existing Method resource.
|
default UpdateMethodResponse |
updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
|
default UpdateMethodResponseResponse |
updateMethodResponse(Consumer<UpdateMethodResponseRequest.Builder> updateMethodResponseRequest)
Updates an existing MethodResponse resource.
|
default UpdateMethodResponseResponse |
updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
|
default UpdateModelResponse |
updateModel(Consumer<UpdateModelRequest.Builder> updateModelRequest)
Changes information about a model.
|
default UpdateModelResponse |
updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
|
default UpdateRequestValidatorResponse |
updateRequestValidator(Consumer<UpdateRequestValidatorRequest.Builder> updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
|
default UpdateRequestValidatorResponse |
updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
|
default UpdateResourceResponse |
updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
Changes information about a Resource resource.
|
default UpdateResourceResponse |
updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
|
default UpdateRestApiResponse |
updateRestApi(Consumer<UpdateRestApiRequest.Builder> updateRestApiRequest)
Changes information about the specified API.
|
default UpdateRestApiResponse |
updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
|
default UpdateStageResponse |
updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
Changes information about a Stage resource.
|
default UpdateStageResponse |
updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
|
default UpdateUsageResponse |
updateUsage(Consumer<UpdateUsageRequest.Builder> updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
|
default UpdateUsageResponse |
updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
|
default UpdateUsagePlanResponse |
updateUsagePlan(Consumer<UpdateUsagePlanRequest.Builder> updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
|
default UpdateUsagePlanResponse |
updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
|
serviceNameclosestatic final String SERVICE_NAME
static APIGatewayClient create()
APIGatewayClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static APIGatewayClientBuilder builder()
APIGatewayClient.default CreateApiKeyResponse createApiKey(CreateApiKeyRequest createApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
createApiKeyRequest - Request to create an ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateApiKeyResponse createApiKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Create an ApiKey resource.
This is a convenience which creates an instance of the CreateApiKeyRequest.Builder avoiding the need to
create one manually via CreateApiKeyRequest.builder()
createApiKeyRequest - A Consumer that will call methods on CreateApiKeyRequest.Builder to create a request.
Request to create an ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAuthorizerResponse createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAuthorizerResponse createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Adds a new Authorizer resource to an existing RestApi resource.
This is a convenience which creates an instance of the CreateAuthorizerRequest.Builder avoiding the need
to create one manually via CreateAuthorizerRequest.builder()
createAuthorizerRequest - A Consumer that will call methods on CreateAuthorizerRequest.Builder to create a request.
Request to add a new Authorizer to an existing RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBasePathMappingResponse createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest) throws UnauthorizedException, ConflictException, BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new BasePathMapping resource.
createBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBasePathMappingResponse createBasePathMapping(Consumer<CreateBasePathMappingRequest.Builder> createBasePathMappingRequest) throws UnauthorizedException, ConflictException, BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new BasePathMapping resource.
This is a convenience which creates an instance of the CreateBasePathMappingRequest.Builder avoiding the
need to create one manually via CreateBasePathMappingRequest.builder()
createBasePathMappingRequest - A Consumer that will call methods on CreateBasePathMappingRequest.Builder to create a
request. Requests Amazon API Gateway to create a new BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(CreateDeploymentRequest createDeploymentRequest) throws UnauthorizedException, BadRequestException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeploymentRequest - Requests Amazon API Gateway to create a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) throws UnauthorizedException, BadRequestException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
This is a convenience which creates an instance of the CreateDeploymentRequest.Builder avoiding the need
to create one manually via CreateDeploymentRequest.builder()
createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.
Requests Amazon API Gateway to create a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDocumentationPartResponse createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
createDocumentationPartRequest - Creates a new documentation part of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDocumentationPartResponse createDocumentationPart(Consumer<CreateDocumentationPartRequest.Builder> createDocumentationPartRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the CreateDocumentationPartRequest.Builder avoiding
the need to create one manually via CreateDocumentationPartRequest.builder()
createDocumentationPartRequest - A Consumer that will call methods on CreateDocumentationPartRequest.Builder to create a
request. Creates a new documentation part of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDocumentationVersionResponse createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
createDocumentationVersionRequest - Creates a new documentation version of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDocumentationVersionResponse createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the CreateDocumentationVersionRequest.Builder avoiding
the need to create one manually via CreateDocumentationVersionRequest.builder()
createDocumentationVersionRequest - A Consumer that will call methods on CreateDocumentationVersionRequest.Builder to create a
request. Creates a new documentation version of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainNameResponse createDomainName(CreateDomainNameRequest createDomainNameRequest) throws UnauthorizedException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new domain name.
createDomainNameRequest - A request to create a new domain name.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainNameResponse createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest) throws UnauthorizedException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new domain name.
This is a convenience which creates an instance of the CreateDomainNameRequest.Builder avoiding the need
to create one manually via CreateDomainNameRequest.builder()
createDomainNameRequest - A Consumer that will call methods on CreateDomainNameRequest.Builder to create a request.
A request to create a new domain name.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateModelResponse createModel(CreateModelRequest createModelRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
createModelRequest - Request to add a new Model to an existing RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateModelResponse createModel(Consumer<CreateModelRequest.Builder> createModelRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Adds a new Model resource to an existing RestApi resource.
This is a convenience which creates an instance of the CreateModelRequest.Builder avoiding the need to
create one manually via CreateModelRequest.builder()
createModelRequest - A Consumer that will call methods on CreateModelRequest.Builder to create a request.
Request to add a new Model to an existing RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRequestValidatorResponse createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a ReqeustValidator of a given RestApi.
createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRequestValidatorResponse createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a ReqeustValidator of a given RestApi.
This is a convenience which creates an instance of the CreateRequestValidatorRequest.Builder avoiding the
need to create one manually via CreateRequestValidatorRequest.builder()
createRequestValidatorRequest - A Consumer that will call methods on CreateRequestValidatorRequest.Builder to create a
request. Creates a RequestValidator of a given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a Resource resource.
createResourceRequest - Requests Amazon API Gateway to create a Resource resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateResourceResponse createResource(Consumer<CreateResourceRequest.Builder> createResourceRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a Resource resource.
This is a convenience which creates an instance of the CreateResourceRequest.Builder avoiding the need to
create one manually via CreateResourceRequest.builder()
createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request.
Requests Amazon API Gateway to create a Resource resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRestApiResponse createRestApi(CreateRestApiRequest createRestApiRequest) throws UnauthorizedException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new RestApi resource.
createRestApiRequest - The POST Request to add a new RestApi resource to your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRestApiResponse createRestApi(Consumer<CreateRestApiRequest.Builder> createRestApiRequest) throws UnauthorizedException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new RestApi resource.
This is a convenience which creates an instance of the CreateRestApiRequest.Builder avoiding the need to
create one manually via CreateRestApiRequest.builder()
createRestApiRequest - A Consumer that will call methods on CreateRestApiRequest.Builder to create a request. The
POST Request to add a new RestApi resource to your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStageResponse createStage(CreateStageRequest createStageRequest) throws UnauthorizedException, BadRequestException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStageRequest - Requests Amazon API Gateway to create a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateStageResponse createStage(Consumer<CreateStageRequest.Builder> createStageRequest) throws UnauthorizedException, BadRequestException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a new Stage resource that references a pre-existing Deployment for the API.
This is a convenience which creates an instance of the CreateStageRequest.Builder avoiding the need to
create one manually via CreateStageRequest.builder()
createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request.
Requests Amazon API Gateway to create a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsagePlanResponse createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, LimitExceededException, ConflictException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
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.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsagePlanResponse createUsagePlan(Consumer<CreateUsagePlanRequest.Builder> createUsagePlanRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, LimitExceededException, ConflictException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
This is a convenience which creates an instance of the CreateUsagePlanRequest.Builder avoiding the need
to create one manually via CreateUsagePlanRequest.builder()
createUsagePlanRequest - A Consumer that will call methods on CreateUsagePlanRequest.Builder to create a request.
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.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsagePlanKeyResponse createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateUsagePlanKeyResponse createUsagePlanKey(Consumer<CreateUsagePlanKeyRequest.Builder> createUsagePlanKeyRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a usage plan key for adding an existing API key to a usage plan.
This is a convenience which creates an instance of the CreateUsagePlanKeyRequest.Builder avoiding the
need to create one manually via CreateUsagePlanKeyRequest.builder()
createUsagePlanKeyRequest - A Consumer that will call methods on CreateUsagePlanKeyRequest.Builder to create a
request. The POST request to create a usage plan key for adding an existing API key to a usage plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the ApiKey resource.
deleteApiKeyRequest - A request to delete the ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteApiKeyResponse deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the ApiKey resource.
This is a convenience which creates an instance of the DeleteApiKeyRequest.Builder avoiding the need to
create one manually via DeleteApiKeyRequest.builder()
deleteApiKeyRequest - A Consumer that will call methods on DeleteApiKeyRequest.Builder to create a request. A
request to delete the ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAuthorizerResponse deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing Authorizer resource.
deleteAuthorizerRequest - Request to delete an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAuthorizerResponse deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing Authorizer resource.
This is a convenience which creates an instance of the DeleteAuthorizerRequest.Builder avoiding the need
to create one manually via DeleteAuthorizerRequest.builder()
deleteAuthorizerRequest - A Consumer that will call methods on DeleteAuthorizerRequest.Builder to create a request.
Request to delete an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBasePathMappingResponse deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the BasePathMapping resource.
deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBasePathMappingResponse deleteBasePathMapping(Consumer<DeleteBasePathMappingRequest.Builder> deleteBasePathMappingRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the BasePathMapping resource.
This is a convenience which creates an instance of the DeleteBasePathMappingRequest.Builder avoiding the
need to create one manually via DeleteBasePathMappingRequest.builder()
deleteBasePathMappingRequest - A Consumer that will call methods on DeleteBasePathMappingRequest.Builder to create a
request. A request to delete the BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteClientCertificateResponse deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the ClientCertificate resource.
deleteClientCertificateRequest - A request to delete the ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteClientCertificateResponse deleteClientCertificate(Consumer<DeleteClientCertificateRequest.Builder> deleteClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the ClientCertificate resource.
This is a convenience which creates an instance of the DeleteClientCertificateRequest.Builder avoiding
the need to create one manually via DeleteClientCertificateRequest.builder()
deleteClientCertificateRequest - A Consumer that will call methods on DeleteClientCertificateRequest.Builder to create a
request. A request to delete the ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeploymentRequest - Requests Amazon API Gateway to delete a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDeploymentResponse deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
This is a convenience which creates an instance of the DeleteDeploymentRequest.Builder avoiding the need
to create one manually via DeleteDeploymentRequest.builder()
deleteDeploymentRequest - A Consumer that will call methods on DeleteDeploymentRequest.Builder to create a request.
Requests Amazon API Gateway to delete a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDocumentationPartResponse deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
deleteDocumentationPartRequest - Deletes an existing documentation part of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDocumentationPartResponse deleteDocumentationPart(Consumer<DeleteDocumentationPartRequest.Builder> deleteDocumentationPartRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the DeleteDocumentationPartRequest.Builder avoiding
the need to create one manually via DeleteDocumentationPartRequest.builder()
deleteDocumentationPartRequest - A Consumer that will call methods on DeleteDocumentationPartRequest.Builder to create a
request. Deletes an existing documentation part of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDocumentationVersionResponse deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDocumentationVersionResponse deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the DeleteDocumentationVersionRequest.Builder avoiding
the need to create one manually via DeleteDocumentationVersionRequest.builder()
deleteDocumentationVersionRequest - A Consumer that will call methods on DeleteDocumentationVersionRequest.Builder to create a
request. Deletes an existing documentation version of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the DomainName resource.
deleteDomainNameRequest - A request to delete the DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainNameResponse deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the DomainName resource.
This is a convenience which creates an instance of the DeleteDomainNameRequest.Builder avoiding the need
to create one manually via DeleteDomainNameRequest.builder()
deleteDomainNameRequest - A Consumer that will call methods on DeleteDomainNameRequest.Builder to create a request.
A request to delete the DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponseResponse deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
deleteGatewayResponseRequest - Clears any customization of a GatewayResponse of a specified response type on the given
RestApi and resets it with the default settings.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGatewayResponseResponse deleteGatewayResponse(Consumer<DeleteGatewayResponseRequest.Builder> deleteGatewayResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
This is a convenience which creates an instance of the DeleteGatewayResponseRequest.Builder avoiding the
need to create one manually via DeleteGatewayResponseRequest.builder()
deleteGatewayResponseRequest - A Consumer that will call methods on DeleteGatewayResponseRequest.Builder to create a
request. Clears any customization of a GatewayResponse of a specified response type on the given
RestApi and resets it with the default settings.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a delete integration.
deleteIntegrationRequest - Represents a delete integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a delete integration.
This is a convenience which creates an instance of the DeleteIntegrationRequest.Builder avoiding the need
to create one manually via DeleteIntegrationRequest.builder()
deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request.
Represents a delete integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIntegrationResponseResponse deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a delete integration response.
deleteIntegrationResponseRequest - Represents a delete integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteIntegrationResponseResponse deleteIntegrationResponse(Consumer<DeleteIntegrationResponseRequest.Builder> deleteIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a delete integration response.
This is a convenience which creates an instance of the DeleteIntegrationResponseRequest.Builder avoiding
the need to create one manually via DeleteIntegrationResponseRequest.builder()
deleteIntegrationResponseRequest - A Consumer that will call methods on DeleteIntegrationResponseRequest.Builder to create a
request. Represents a delete integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMethodResponse deleteMethod(DeleteMethodRequest deleteMethodRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing Method resource.
deleteMethodRequest - Request to delete an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMethodResponse deleteMethod(Consumer<DeleteMethodRequest.Builder> deleteMethodRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing Method resource.
This is a convenience which creates an instance of the DeleteMethodRequest.Builder avoiding the need to
create one manually via DeleteMethodRequest.builder()
deleteMethodRequest - A Consumer that will call methods on DeleteMethodRequest.Builder to create a request.
Request to delete an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMethodResponseResponse deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing MethodResponse resource.
deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMethodResponseResponse deleteMethodResponse(Consumer<DeleteMethodResponseRequest.Builder> deleteMethodResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes an existing MethodResponse resource.
This is a convenience which creates an instance of the DeleteMethodResponseRequest.Builder avoiding the
need to create one manually via DeleteMethodResponseRequest.builder()
deleteMethodResponseRequest - A Consumer that will call methods on DeleteMethodResponseRequest.Builder to create a
request. A request to delete an existing MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a model.
deleteModelRequest - Request to delete an existing model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteModelResponse deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a model.
This is a convenience which creates an instance of the DeleteModelRequest.Builder avoiding the need to
create one manually via DeleteModelRequest.builder()
deleteModelRequest - A Consumer that will call methods on DeleteModelRequest.Builder to create a request.
Request to delete an existing model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRequestValidatorResponse deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a RequestValidator of a given RestApi.
deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRequestValidatorResponse deleteRequestValidator(Consumer<DeleteRequestValidatorRequest.Builder> deleteRequestValidatorRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the DeleteRequestValidatorRequest.Builder avoiding the
need to create one manually via DeleteRequestValidatorRequest.builder()
deleteRequestValidatorRequest - A Consumer that will call methods on DeleteRequestValidatorRequest.Builder to create a
request. Deletes a specified RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Resource resource.
deleteResourceRequest - Request to delete a Resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceResponse deleteResource(Consumer<DeleteResourceRequest.Builder> deleteResourceRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Resource resource.
This is a convenience which creates an instance of the DeleteResourceRequest.Builder avoiding the need to
create one manually via DeleteResourceRequest.builder()
deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request.
Request to delete a Resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRestApiResponse deleteRestApi(DeleteRestApiRequest deleteRestApiRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the specified API.
deleteRestApiRequest - Request to delete the specified API from your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRestApiResponse deleteRestApi(Consumer<DeleteRestApiRequest.Builder> deleteRestApiRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
Deletes the specified API.
This is a convenience which creates an instance of the DeleteRestApiRequest.Builder avoiding the need to
create one manually via DeleteRestApiRequest.builder()
deleteRestApiRequest - A Consumer that will call methods on DeleteRestApiRequest.Builder to create a request.
Request to delete the specified API from your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Stage resource.
deleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteStageResponse deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a Stage resource.
This is a convenience which creates an instance of the DeleteStageRequest.Builder avoiding the need to
create one manually via DeleteStageRequest.builder()
deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request.
Requests Amazon API Gateway to delete a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a usage plan of a given plan Id.
deleteUsagePlanRequest - The DELETE request to delete a usage plan of a given plan Id.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsagePlanResponse deleteUsagePlan(Consumer<DeleteUsagePlanRequest.Builder> deleteUsagePlanRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a usage plan of a given plan Id.
This is a convenience which creates an instance of the DeleteUsagePlanRequest.Builder avoiding the need
to create one manually via DeleteUsagePlanRequest.builder()
deleteUsagePlanRequest - A Consumer that will call methods on DeleteUsagePlanRequest.Builder to create a request.
The DELETE request to delete a usage plan of a given plan Id.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsagePlanKeyResponse deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteUsagePlanKeyResponse deleteUsagePlanKey(Consumer<DeleteUsagePlanKeyRequest.Builder> deleteUsagePlanKeyRequest) throws BadRequestException, ConflictException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
This is a convenience which creates an instance of the DeleteUsagePlanKeyRequest.Builder avoiding the
need to create one manually via DeleteUsagePlanKeyRequest.builder()
deleteUsagePlanKeyRequest - A Consumer that will call methods on DeleteUsagePlanKeyRequest.Builder to create a
request. The DELETE request to delete a usage plan key and remove the underlying API key from the
associated usage plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(Consumer<FlushStageAuthorizersCacheRequest.Builder> flushStageAuthorizersCacheRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Flushes all authorizer cache entries on a stage.
This is a convenience which creates an instance of the FlushStageAuthorizersCacheRequest.Builder avoiding
the need to create one manually via FlushStageAuthorizersCacheRequest.builder()
flushStageAuthorizersCacheRequest - A Consumer that will call methods on FlushStageAuthorizersCacheRequest.Builder to create a
request. Request to flush authorizer cache entries on a specified stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FlushStageCacheResponse flushStageCache(FlushStageCacheRequest flushStageCacheRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Flushes a stage's cache.
flushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FlushStageCacheResponse flushStageCache(Consumer<FlushStageCacheRequest.Builder> flushStageCacheRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Flushes a stage's cache.
This is a convenience which creates an instance of the FlushStageCacheRequest.Builder avoiding the need
to create one manually via FlushStageCacheRequest.builder()
flushStageCacheRequest - A Consumer that will call methods on FlushStageCacheRequest.Builder to create a request.
Requests Amazon API Gateway to flush a stage's cache.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateClientCertificateResponse generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, LimitExceededException, AwsServiceException, SdkClientException, APIGatewayException
Generates a ClientCertificate resource.
generateClientCertificateRequest - A request to generate a ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GenerateClientCertificateResponse generateClientCertificate(Consumer<GenerateClientCertificateRequest.Builder> generateClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, LimitExceededException, AwsServiceException, SdkClientException, APIGatewayException
Generates a ClientCertificate resource.
This is a convenience which creates an instance of the GenerateClientCertificateRequest.Builder avoiding
the need to create one manually via GenerateClientCertificateRequest.builder()
generateClientCertificateRequest - A Consumer that will call methods on GenerateClientCertificateRequest.Builder to create a
request. A request to generate a ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount() throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current Account resource.
UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetAccount(GetAccountRequest)default GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current Account resource.
getAccountRequest - Requests Amazon API Gateway to get information about the current Account resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccountResponse getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current Account resource.
This is a convenience which creates an instance of the GetAccountRequest.Builder avoiding the need to
create one manually via GetAccountRequest.builder()
getAccountRequest - A Consumer that will call methods on GetAccountRequest.Builder to create a request.
Requests Amazon API Gateway to get information about the current Account resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetApiKeyResponse getApiKey(GetApiKeyRequest getApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ApiKey resource.
getApiKeyRequest - A request to get information about the current ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetApiKeyResponse getApiKey(Consumer<GetApiKeyRequest.Builder> getApiKeyRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ApiKey resource.
This is a convenience which creates an instance of the GetApiKeyRequest.Builder avoiding the need to
create one manually via GetApiKeyRequest.builder()
getApiKeyRequest - A Consumer that will call methods on GetApiKeyRequest.Builder to create a request. A
request to get information about the current ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetApiKeysResponse getApiKeys() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ApiKeys resource.
BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetApiKeys(GetApiKeysRequest)default GetApiKeysResponse getApiKeys(GetApiKeysRequest getApiKeysRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ApiKeys resource.
getApiKeysRequest - A request to get information about the current ApiKeys resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetApiKeysResponse getApiKeys(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ApiKeys resource.
This is a convenience which creates an instance of the GetApiKeysRequest.Builder avoiding the need to
create one manually via GetApiKeysRequest.builder()
getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A
request to get information about the current ApiKeys resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizerResponse getAuthorizer(GetAuthorizerRequest getAuthorizerRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Authorizer resource.
getAuthorizerRequest - Request to describe an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizerResponse getAuthorizer(Consumer<GetAuthorizerRequest.Builder> getAuthorizerRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Authorizer resource.
This is a convenience which creates an instance of the GetAuthorizerRequest.Builder avoiding the need to
create one manually via GetAuthorizerRequest.builder()
getAuthorizerRequest - A Consumer that will call methods on GetAuthorizerRequest.Builder to create a request.
Request to describe an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizersResponse getAuthorizers(GetAuthorizersRequest getAuthorizersRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Authorizers resource.
getAuthorizersRequest - Request to describe an existing Authorizers resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizersResponse getAuthorizers(Consumer<GetAuthorizersRequest.Builder> getAuthorizersRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Authorizers resource.
This is a convenience which creates an instance of the GetAuthorizersRequest.Builder avoiding the need to
create one manually via GetAuthorizersRequest.builder()
getAuthorizersRequest - A Consumer that will call methods on GetAuthorizersRequest.Builder to create a request.
Request to describe an existing Authorizers resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBasePathMappingResponse getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe a BasePathMapping resource.
getBasePathMappingRequest - Request to describe a BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBasePathMappingResponse getBasePathMapping(Consumer<GetBasePathMappingRequest.Builder> getBasePathMappingRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe a BasePathMapping resource.
This is a convenience which creates an instance of the GetBasePathMappingRequest.Builder avoiding the
need to create one manually via GetBasePathMappingRequest.builder()
getBasePathMappingRequest - A Consumer that will call methods on GetBasePathMappingRequest.Builder to create a
request. Request to describe a BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBasePathMappingsResponse getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a collection of BasePathMapping resources.
getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBasePathMappingsResponse getBasePathMappings(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a collection of BasePathMapping resources.
This is a convenience which creates an instance of the GetBasePathMappingsRequest.Builder avoiding the
need to create one manually via GetBasePathMappingsRequest.builder()
getBasePathMappingsRequest - A Consumer that will call methods on GetBasePathMappingsRequest.Builder to create a
request. A request to get information about a collection of BasePathMapping resources.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetClientCertificateResponse getClientCertificate(GetClientCertificateRequest getClientCertificateRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ClientCertificate resource.
getClientCertificateRequest - A request to get information about the current ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetClientCertificateResponse getClientCertificate(Consumer<GetClientCertificateRequest.Builder> getClientCertificateRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about the current ClientCertificate resource.
This is a convenience which creates an instance of the GetClientCertificateRequest.Builder avoiding the
need to create one manually via GetClientCertificateRequest.builder()
getClientCertificateRequest - A Consumer that will call methods on GetClientCertificateRequest.Builder to create a
request. A request to get information about the current ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetClientCertificatesResponse getClientCertificates() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a collection of ClientCertificate resources.
BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetClientCertificates(GetClientCertificatesRequest)default GetClientCertificatesResponse getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a collection of ClientCertificate resources.
getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetClientCertificatesResponse getClientCertificates(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a collection of ClientCertificate resources.
This is a convenience which creates an instance of the GetClientCertificatesRequest.Builder avoiding the
need to create one manually via GetClientCertificatesRequest.builder()
getClientCertificatesRequest - A Consumer that will call methods on GetClientCertificatesRequest.Builder to create a
request. A request to get information about a collection of ClientCertificate resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Deployment resource.
getDeploymentRequest - Requests Amazon API Gateway to get information about a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Deployment resource.
This is a convenience which creates an instance of the GetDeploymentRequest.Builder avoiding the need to
create one manually via GetDeploymentRequest.builder()
getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request.
Requests Amazon API Gateway to get information about a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Deployments collection.
getDeploymentsRequest - Requests Amazon API Gateway to get information about a Deployments collection.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDeploymentsResponse getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Deployments collection.
This is a convenience which creates an instance of the GetDeploymentsRequest.Builder avoiding the need to
create one manually via GetDeploymentsRequest.builder()
getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request.
Requests Amazon API Gateway to get information about a Deployments collection.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationPartResponse getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getDocumentationPartRequest - Gets a specified documentation part of a given API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationPartResponse getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetDocumentationPartRequest.Builder avoiding the
need to create one manually via GetDocumentationPartRequest.builder()
getDocumentationPartRequest - A Consumer that will call methods on GetDocumentationPartRequest.Builder to create a
request. Gets a specified documentation part of a given API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationPartsResponse getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationPartsResponse getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetDocumentationPartsRequest.Builder avoiding the
need to create one manually via GetDocumentationPartsRequest.builder()
getDocumentationPartsRequest - A Consumer that will call methods on GetDocumentationPartsRequest.Builder to create a
request. Gets the documentation parts of an API. The result may be filtered by the type, name, or path of
API entities (targets).BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationVersionResponse getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getDocumentationVersionRequest - Gets a documentation snapshot of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationVersionResponse getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetDocumentationVersionRequest.Builder avoiding
the need to create one manually via GetDocumentationVersionRequest.builder()
getDocumentationVersionRequest - A Consumer that will call methods on GetDocumentationVersionRequest.Builder to create a
request. Gets a documentation snapshot of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationVersionsResponse getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getDocumentationVersionsRequest - Gets the documentation versions of an API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDocumentationVersionsResponse getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetDocumentationVersionsRequest.Builder avoiding
the need to create one manually via GetDocumentationVersionsRequest.builder()
getDocumentationVersionsRequest - A Consumer that will call methods on GetDocumentationVersionsRequest.Builder to create a
request. Gets the documentation versions of an API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainNameResponse getDomainName(GetDomainNameRequest getDomainNameRequest) throws UnauthorizedException, NotFoundException, ServiceUnavailableException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainNameRequest - Request to get the name of a DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainNameResponse getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest) throws UnauthorizedException, NotFoundException, ServiceUnavailableException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
This is a convenience which creates an instance of the GetDomainNameRequest.Builder avoiding the need to
create one manually via GetDomainNameRequest.builder()
getDomainNameRequest - A Consumer that will call methods on GetDomainNameRequest.Builder to create a request.
Request to get the name of a DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainNamesResponse getDomainNames() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a collection of DomainName resources.
BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetDomainNames(GetDomainNamesRequest)default GetDomainNamesResponse getDomainNames(GetDomainNamesRequest getDomainNamesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a collection of DomainName resources.
getDomainNamesRequest - Request to describe a collection of DomainName resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainNamesResponse getDomainNames(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a collection of DomainName resources.
This is a convenience which creates an instance of the GetDomainNamesRequest.Builder avoiding the need to
create one manually via GetDomainNamesRequest.builder()
getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request.
Request to describe a collection of DomainName resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExportResponse getExport(GetExportRequest getExportRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Exports a deployed version of a RestApi in a specified format.
getExportRequest - Request a new export of a RestApi for a particular Stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExportResponse getExport(Consumer<GetExportRequest.Builder> getExportRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Exports a deployed version of a RestApi in a specified format.
This is a convenience which creates an instance of the GetExportRequest.Builder avoiding the need to
create one manually via GetExportRequest.builder()
getExportRequest - A Consumer that will call methods on GetExportRequest.Builder to create a request. Request
a new export of a RestApi for a particular Stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGatewayResponseResponse getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a GatewayResponse of a specified response type on the given RestApi.
getGatewayResponseRequest - Gets a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGatewayResponseResponse getGatewayResponse(Consumer<GetGatewayResponseRequest.Builder> getGatewayResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a GatewayResponse of a specified response type on the given RestApi.
This is a convenience which creates an instance of the GetGatewayResponseRequest.Builder avoiding the
need to create one manually via GetGatewayResponseRequest.builder()
getGatewayResponseRequest - A Consumer that will call methods on GetGatewayResponseRequest.Builder to create a
request. Gets a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGatewayResponsesResponse getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
getGatewayResponsesRequest - Gets the GatewayResponses collection on the given RestApi. If an API developer has not added
any definitions for gateway responses, the result will be the Amazon API Gateway-generated default
GatewayResponses collection for the supported response types.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetGatewayResponsesResponse getGatewayResponses(Consumer<GetGatewayResponsesRequest.Builder> getGatewayResponsesRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
This is a convenience which creates an instance of the GetGatewayResponsesRequest.Builder avoiding the
need to create one manually via GetGatewayResponsesRequest.builder()
getGatewayResponsesRequest - A Consumer that will call methods on GetGatewayResponsesRequest.Builder to create a
request. Gets the GatewayResponses collection on the given RestApi. If an API developer has
not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated
default GatewayResponses collection for the supported response types.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a get integration.
getIntegrationRequest - Represents a get integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetIntegrationResponse getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a get integration.
This is a convenience which creates an instance of the GetIntegrationRequest.Builder avoiding the need to
create one manually via GetIntegrationRequest.builder()
getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request.
Represents a get integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetIntegrationResponseResponse getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a get integration response.
getIntegrationResponseRequest - Represents a get integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetIntegrationResponseResponse getIntegrationResponse(Consumer<GetIntegrationResponseRequest.Builder> getIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents a get integration response.
This is a convenience which creates an instance of the GetIntegrationResponseRequest.Builder avoiding the
need to create one manually via GetIntegrationResponseRequest.builder()
getIntegrationResponseRequest - A Consumer that will call methods on GetIntegrationResponseRequest.Builder to create a
request. Represents a get integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMethodResponse getMethod(GetMethodRequest getMethodRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Method resource.
getMethodRequest - Request to describe an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMethodResponse getMethod(Consumer<GetMethodRequest.Builder> getMethodRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describe an existing Method resource.
This is a convenience which creates an instance of the GetMethodRequest.Builder avoiding the need to
create one manually via GetMethodRequest.builder()
getMethodRequest - A Consumer that will call methods on GetMethodRequest.Builder to create a request. Request
to describe an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMethodResponseResponse getMethodResponse(GetMethodResponseRequest getMethodResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describes a MethodResponse resource.
getMethodResponseRequest - Request to describe a MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetMethodResponseResponse getMethodResponse(Consumer<GetMethodResponseRequest.Builder> getMethodResponseRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describes a MethodResponse resource.
This is a convenience which creates an instance of the GetMethodResponseRequest.Builder avoiding the need
to create one manually via GetMethodResponseRequest.builder()
getMethodResponseRequest - A Consumer that will call methods on GetMethodResponseRequest.Builder to create a request.
Request to describe a MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelResponse getModel(GetModelRequest getModelRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describes an existing model defined for a RestApi resource.
getModelRequest - Request to list information about a model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelResponse getModel(Consumer<GetModelRequest.Builder> getModelRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describes an existing model defined for a RestApi resource.
This is a convenience which creates an instance of the GetModelRequest.Builder avoiding the need to
create one manually via GetModelRequest.builder()
getModelRequest - A Consumer that will call methods on GetModelRequest.Builder to create a request. Request
to list information about a model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelTemplateResponse getModelTemplate(GetModelTemplateRequest getModelTemplateRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelTemplateResponse getModelTemplate(Consumer<GetModelTemplateRequest.Builder> getModelTemplateRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
This is a convenience which creates an instance of the GetModelTemplateRequest.Builder avoiding the need
to create one manually via GetModelTemplateRequest.builder()
getModelTemplateRequest - A Consumer that will call methods on GetModelTemplateRequest.Builder to create a request.
Request to generate a sample mapping template used to transform the payload.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelsResponse getModels(GetModelsRequest getModelsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getModelsRequest - Request to list existing Models defined for a RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetModelsResponse getModels(Consumer<GetModelsRequest.Builder> getModelsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Describes existing Models defined for a RestApi resource.
This is a convenience which creates an instance of the GetModelsRequest.Builder avoiding the need to
create one manually via GetModelsRequest.builder()
getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request
to list existing Models defined for a RestApi resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRequestValidatorResponse getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a RequestValidator of a given RestApi.
getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRequestValidatorResponse getRequestValidator(Consumer<GetRequestValidatorRequest.Builder> getRequestValidatorRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the GetRequestValidatorRequest.Builder avoiding the
need to create one manually via GetRequestValidatorRequest.builder()
getRequestValidatorRequest - A Consumer that will call methods on GetRequestValidatorRequest.Builder to create a
request. Gets a RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRequestValidatorsResponse getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the RequestValidators collection of a given RestApi.
getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRequestValidatorsResponse getRequestValidators(Consumer<GetRequestValidatorsRequest.Builder> getRequestValidatorsRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the RequestValidators collection of a given RestApi.
This is a convenience which creates an instance of the GetRequestValidatorsRequest.Builder avoiding the
need to create one manually via GetRequestValidatorsRequest.builder()
getRequestValidatorsRequest - A Consumer that will call methods on GetRequestValidatorsRequest.Builder to create a
request. Gets the RequestValidators collection of a given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourceResponse getResource(GetResourceRequest getResourceRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists information about a resource.
getResourceRequest - Request to list information about a resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourceResponse getResource(Consumer<GetResourceRequest.Builder> getResourceRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists information about a resource.
This is a convenience which creates an instance of the GetResourceRequest.Builder avoiding the need to
create one manually via GetResourceRequest.builder()
getResourceRequest - A Consumer that will call methods on GetResourceRequest.Builder to create a request.
Request to list information about a resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists information about a collection of Resource resources.
getResourcesRequest - Request to list information about a collection of resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetResourcesResponse getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists information about a collection of Resource resources.
This is a convenience which creates an instance of the GetResourcesRequest.Builder avoiding the need to
create one manually via GetResourcesRequest.builder()
getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request.
Request to list information about a collection of resources.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRestApiResponse getRestApi(GetRestApiRequest getRestApiRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists the RestApi resource in the collection.
getRestApiRequest - The GET request to list an existing RestApi defined for your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRestApiResponse getRestApi(Consumer<GetRestApiRequest.Builder> getRestApiRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists the RestApi resource in the collection.
This is a convenience which creates an instance of the GetRestApiRequest.Builder avoiding the need to
create one manually via GetRestApiRequest.builder()
getRestApiRequest - A Consumer that will call methods on GetRestApiRequest.Builder to create a request. The
GET request to list an existing RestApi defined for your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRestApisResponse getRestApis() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists the RestApis resources for your collection.
BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRestApis(GetRestApisRequest)default GetRestApisResponse getRestApis(GetRestApisRequest getRestApisRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists the RestApis resources for your collection.
getRestApisRequest - The GET request to list existing RestApis defined for your collection.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRestApisResponse getRestApis(Consumer<GetRestApisRequest.Builder> getRestApisRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Lists the RestApis resources for your collection.
This is a convenience which creates an instance of the GetRestApisRequest.Builder avoiding the need to
create one manually via GetRestApisRequest.builder()
getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The
GET request to list existing RestApis defined for your collection.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkResponse getSdk(GetSdkRequest getSdkRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getSdkRequest - Request a new generated client SDK for a RestApi and Stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkResponse getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Generates a client SDK for a RestApi and Stage.
This is a convenience which creates an instance of the GetSdkRequest.Builder avoiding the need to create
one manually via GetSdkRequest.builder()
getSdkRequest - A Consumer that will call methods on GetSdkRequest.Builder to create a request. Request a
new generated client SDK for a RestApi and Stage.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkTypeResponse getSdkType(GetSdkTypeRequest getSdkTypeRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getSdkTypeRequest - Get an SdkType instance.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkTypeResponse getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetSdkTypeRequest.Builder avoiding the need to
create one manually via GetSdkTypeRequest.builder()
getSdkTypeRequest - A Consumer that will call methods on GetSdkTypeRequest.Builder to create a request. Get an
SdkType instance.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkTypesResponse getSdkTypes() throws UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetSdkTypes(GetSdkTypesRequest)default GetSdkTypesResponse getSdkTypes(GetSdkTypesRequest getSdkTypesRequest) throws UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
getSdkTypesRequest - Get the SdkTypes collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetSdkTypesResponse getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest) throws UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the GetSdkTypesRequest.Builder avoiding the need to
create one manually via GetSdkTypesRequest.builder()
getSdkTypesRequest - A Consumer that will call methods on GetSdkTypesRequest.Builder to create a request. Get
the SdkTypes collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStageResponse getStage(GetStageRequest getStageRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Stage resource.
getStageRequest - Requests Amazon API Gateway to get information about a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStageResponse getStage(Consumer<GetStageRequest.Builder> getStageRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about a Stage resource.
This is a convenience which creates an instance of the GetStageRequest.Builder avoiding the need to
create one manually via GetStageRequest.builder()
getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request. Requests
Amazon API Gateway to get information about a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStagesResponse getStages(GetStagesRequest getStagesRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about one or more Stage resources.
getStagesRequest - Requests Amazon API Gateway to get information about one or more Stage resources.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStagesResponse getStages(Consumer<GetStagesRequest.Builder> getStagesRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets information about one or more Stage resources.
This is a convenience which creates an instance of the GetStagesRequest.Builder avoiding the need to
create one manually via GetStagesRequest.builder()
getStagesRequest - A Consumer that will call methods on GetStagesRequest.Builder to create a request.
Requests Amazon API Gateway to get information about one or more Stage resources.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsageResponse getUsage(GetUsageRequest getUsageRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the usage data of a usage plan in a specified time interval.
getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsageResponse getUsage(Consumer<GetUsageRequest.Builder> getUsageRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets the usage data of a usage plan in a specified time interval.
This is a convenience which creates an instance of the GetUsageRequest.Builder avoiding the need to
create one manually via GetUsageRequest.builder()
getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET
request to get the usage data of a usage plan in a specified time interval.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest getUsagePlanRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a usage plan of a given plan identifier.
getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanResponse getUsagePlan(Consumer<GetUsagePlanRequest.Builder> getUsagePlanRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a usage plan of a given plan identifier.
This is a convenience which creates an instance of the GetUsagePlanRequest.Builder avoiding the need to
create one manually via GetUsagePlanRequest.builder()
getUsagePlanRequest - A Consumer that will call methods on GetUsagePlanRequest.Builder to create a request. The
GET request to get a usage plan of a given plan identifier.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanKeyResponse getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a usage plan key of a given key identifier.
getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanKeyResponse getUsagePlanKey(Consumer<GetUsagePlanKeyRequest.Builder> getUsagePlanKeyRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets a usage plan key of a given key identifier.
This is a convenience which creates an instance of the GetUsagePlanKeyRequest.Builder avoiding the need
to create one manually via GetUsagePlanKeyRequest.builder()
getUsagePlanKeyRequest - A Consumer that will call methods on GetUsagePlanKeyRequest.Builder to create a request.
The GET request to get a usage plan key of a given key identifier.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanKeysResponse getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlanKeysResponse getUsagePlanKeys(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Gets all the usage plan keys representing the API keys added to a specified usage plan.
This is a convenience which creates an instance of the GetUsagePlanKeysRequest.Builder avoiding the need
to create one manually via GetUsagePlanKeysRequest.builder()
getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request.
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlansResponse getUsagePlans() throws BadRequestException, UnauthorizedException, TooManyRequestsException, ConflictException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Gets all the usage plans of the caller's account.
BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetUsagePlans(GetUsagePlansRequest)default GetUsagePlansResponse getUsagePlans(GetUsagePlansRequest getUsagePlansRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, ConflictException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Gets all the usage plans of the caller's account.
getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUsagePlansResponse getUsagePlans(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, ConflictException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Gets all the usage plans of the caller's account.
This is a convenience which creates an instance of the GetUsagePlansRequest.Builder avoiding the need to
create one manually via GetUsagePlansRequest.builder()
getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The
GET request to get all the usage plans of the caller's account.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportApiKeysResponse importApiKeys(ImportApiKeysRequest importApiKeysRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Import API keys from an external source, such as a CSV-formatted file.
importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportApiKeysResponse importApiKeys(Consumer<ImportApiKeysRequest.Builder> importApiKeysRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Import API keys from an external source, such as a CSV-formatted file.
This is a convenience which creates an instance of the ImportApiKeysRequest.Builder avoiding the need to
create one manually via ImportApiKeysRequest.builder()
importApiKeysRequest - A Consumer that will call methods on ImportApiKeysRequest.Builder to create a request. The
POST request to import API keys from an external source, such as a CSV-formatted file.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportDocumentationPartsResponse importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest) throws UnauthorizedException, NotFoundException, BadRequestException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
importDocumentationPartsRequest - Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportDocumentationPartsResponse importDocumentationParts(Consumer<ImportDocumentationPartsRequest.Builder> importDocumentationPartsRequest) throws UnauthorizedException, NotFoundException, BadRequestException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the ImportDocumentationPartsRequest.Builder avoiding
the need to create one manually via ImportDocumentationPartsRequest.builder()
importDocumentationPartsRequest - A Consumer that will call methods on ImportDocumentationPartsRequest.Builder to create a
request. Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportRestApiResponse importRestApi(ImportRestApiRequest importRestApiRequest) throws UnauthorizedException, LimitExceededException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
importRestApiRequest - A POST request to import an API to Amazon API Gateway using an input of an API definition file.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportRestApiResponse importRestApi(Consumer<ImportRestApiRequest.Builder> importRestApiRequest) throws UnauthorizedException, LimitExceededException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
This is a convenience which creates an instance of the ImportRestApiRequest.Builder avoiding the need to
create one manually via ImportRestApiRequest.builder()
importRestApiRequest - A Consumer that will call methods on ImportRestApiRequest.Builder to create a request. A
POST request to import an API to Amazon API Gateway using an input of an API definition file.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutGatewayResponseResponse putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the
given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutGatewayResponseResponse putGatewayResponse(Consumer<PutGatewayResponseRequest.Builder> putGatewayResponseRequest) throws BadRequestException, UnauthorizedException, NotFoundException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
This is a convenience which creates an instance of the PutGatewayResponseRequest.Builder avoiding the
need to create one manually via PutGatewayResponseRequest.builder()
putGatewayResponseRequest - A Consumer that will call methods on PutGatewayResponseRequest.Builder to create a
request. Creates a customization of a GatewayResponse of a specified response type and status code
on the given RestApi.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest) throws UnauthorizedException, BadRequestException, ConflictException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Sets up a method's integration.
putIntegrationRequest - Sets up a method's integration.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutIntegrationResponse putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest) throws UnauthorizedException, BadRequestException, ConflictException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Sets up a method's integration.
This is a convenience which creates an instance of the PutIntegrationRequest.Builder avoiding the need to
create one manually via PutIntegrationRequest.builder()
putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request.
Sets up a method's integration.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutIntegrationResponseResponse putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, LimitExceededException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a put integration.
putIntegrationResponseRequest - Represents a put integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutIntegrationResponseResponse putIntegrationResponse(Consumer<PutIntegrationResponseRequest.Builder> putIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, LimitExceededException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents a put integration.
This is a convenience which creates an instance of the PutIntegrationResponseRequest.Builder avoiding the
need to create one manually via PutIntegrationResponseRequest.builder()
putIntegrationResponseRequest - A Consumer that will call methods on PutIntegrationResponseRequest.Builder to create a
request. Represents a put integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMethodResponse putMethod(PutMethodRequest putMethodRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Add a method to an existing Resource resource.
putMethodRequest - Request to add a method to an existing Resource resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMethodResponse putMethod(Consumer<PutMethodRequest.Builder> putMethodRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Add a method to an existing Resource resource.
This is a convenience which creates an instance of the PutMethodRequest.Builder avoiding the need to
create one manually via PutMethodRequest.builder()
putMethodRequest - A Consumer that will call methods on PutMethodRequest.Builder to create a request. Request
to add a method to an existing Resource resource.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMethodResponseResponse putMethodResponse(PutMethodResponseRequest putMethodResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Adds a MethodResponse to an existing Method resource.
putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutMethodResponseResponse putMethodResponse(Consumer<PutMethodResponseRequest.Builder> putMethodResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Adds a MethodResponse to an existing Method resource.
This is a convenience which creates an instance of the PutMethodResponseRequest.Builder avoiding the need
to create one manually via PutMethodResponseRequest.builder()
putMethodResponseRequest - A Consumer that will call methods on PutMethodResponseRequest.Builder to create a request.
Request to add a MethodResponse to an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRestApiResponse putRestApi(PutRestApiRequest putRestApiRequest) throws UnauthorizedException, LimitExceededException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, 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.
putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRestApiResponse putRestApi(Consumer<PutRestApiRequest.Builder> putRestApiRequest) throws UnauthorizedException, LimitExceededException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, 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.
This is a convenience which creates an instance of the PutRestApiRequest.Builder avoiding the need to
create one manually via PutRestApiRequest.builder()
putRestApiRequest - A Consumer that will call methods on PutRestApiRequest.Builder to create a request. A PUT
request to update an existing API, with external API definitions specified as the request body.UnauthorizedException - The request is denied because the caller has insufficient permissions.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestInvokeAuthorizerResponse testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestInvokeAuthorizerResponse testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
This is a convenience which creates an instance of the TestInvokeAuthorizerRequest.Builder avoiding the
need to create one manually via TestInvokeAuthorizerRequest.builder()
testInvokeAuthorizerRequest - A Consumer that will call methods on TestInvokeAuthorizerRequest.Builder to create a
request. Make a request to simulate the execution of an Authorizer.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestInvokeMethodResponse testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethodRequest - Make a request to simulate the execution of a Method.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestInvokeMethodResponse testInvokeMethod(Consumer<TestInvokeMethodRequest.Builder> testInvokeMethodRequest) throws BadRequestException, UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
This is a convenience which creates an instance of the TestInvokeMethodRequest.Builder avoiding the need
to create one manually via TestInvokeMethodRequest.builder()
testInvokeMethodRequest - A Consumer that will call methods on TestInvokeMethodRequest.Builder to create a request.
Make a request to simulate the execution of a Method.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest) throws UnauthorizedException, BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the current Account resource.
updateAccountRequest - Requests Amazon API Gateway to change information about the current Account resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAccountResponse updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest) throws UnauthorizedException, BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the current Account resource.
This is a convenience which creates an instance of the UpdateAccountRequest.Builder avoiding the need to
create one manually via UpdateAccountRequest.builder()
updateAccountRequest - A Consumer that will call methods on UpdateAccountRequest.Builder to create a request.
Requests Amazon API Gateway to change information about the current Account resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest updateApiKeyRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about an ApiKey resource.
updateApiKeyRequest - A request to change information about an ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateApiKeyResponse updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about an ApiKey resource.
This is a convenience which creates an instance of the UpdateApiKeyRequest.Builder avoiding the need to
create one manually via UpdateApiKeyRequest.builder()
updateApiKeyRequest - A Consumer that will call methods on UpdateApiKeyRequest.Builder to create a request. A
request to change information about an ApiKey resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAuthorizerResponse updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing Authorizer resource.
updateAuthorizerRequest - Request to update an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateAuthorizerResponse updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing Authorizer resource.
This is a convenience which creates an instance of the UpdateAuthorizerRequest.Builder avoiding the need
to create one manually via UpdateAuthorizerRequest.builder()
updateAuthorizerRequest - A Consumer that will call methods on UpdateAuthorizerRequest.Builder to create a request.
Request to update an existing Authorizer resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBasePathMappingResponse updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the BasePathMapping resource.
updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBasePathMappingResponse updateBasePathMapping(Consumer<UpdateBasePathMappingRequest.Builder> updateBasePathMappingRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the BasePathMapping resource.
This is a convenience which creates an instance of the UpdateBasePathMappingRequest.Builder avoiding the
need to create one manually via UpdateBasePathMappingRequest.builder()
updateBasePathMappingRequest - A Consumer that will call methods on UpdateBasePathMappingRequest.Builder to create a
request. A request to change information about the BasePathMapping resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateClientCertificateResponse updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about an ClientCertificate resource.
updateClientCertificateRequest - A request to change information about an ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateClientCertificateResponse updateClientCertificate(Consumer<UpdateClientCertificateRequest.Builder> updateClientCertificateRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about an ClientCertificate resource.
This is a convenience which creates an instance of the UpdateClientCertificateRequest.Builder avoiding
the need to create one manually via UpdateClientCertificateRequest.builder()
updateClientCertificateRequest - A Consumer that will call methods on UpdateClientCertificateRequest.Builder to create a
request. A request to change information about an ClientCertificate resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest updateDeploymentRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Deployment resource.
updateDeploymentRequest - Requests Amazon API Gateway to change information about a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDeploymentResponse updateDeployment(Consumer<UpdateDeploymentRequest.Builder> updateDeploymentRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Deployment resource.
This is a convenience which creates an instance of the UpdateDeploymentRequest.Builder avoiding the need
to create one manually via UpdateDeploymentRequest.builder()
updateDeploymentRequest - A Consumer that will call methods on UpdateDeploymentRequest.Builder to create a request.
Requests Amazon API Gateway to change information about a Deployment resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException - The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDocumentationPartResponse updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
updateDocumentationPartRequest - Updates an existing documentation part of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDocumentationPartResponse updateDocumentationPart(Consumer<UpdateDocumentationPartRequest.Builder> updateDocumentationPartRequest) throws BadRequestException, UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the UpdateDocumentationPartRequest.Builder avoiding
the need to create one manually via UpdateDocumentationPartRequest.builder()
updateDocumentationPartRequest - A Consumer that will call methods on UpdateDocumentationPartRequest.Builder to create a
request. Updates an existing documentation part of a given API.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDocumentationVersionResponse updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
updateDocumentationVersionRequest - Updates an existing documentation version of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDocumentationVersionResponse updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
This is a convenience which creates an instance of the UpdateDocumentationVersionRequest.Builder avoiding
the need to create one manually via UpdateDocumentationVersionRequest.builder()
updateDocumentationVersionRequest - A Consumer that will call methods on UpdateDocumentationVersionRequest.Builder to create a
request. Updates an existing documentation version of an API.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDomainNameResponse updateDomainName(UpdateDomainNameRequest updateDomainNameRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the DomainName resource.
updateDomainNameRequest - A request to change information about the DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDomainNameResponse updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the DomainName resource.
This is a convenience which creates an instance of the UpdateDomainNameRequest.Builder avoiding the need
to create one manually via UpdateDomainNameRequest.builder()
updateDomainNameRequest - A Consumer that will call methods on UpdateDomainNameRequest.Builder to create a request.
A request to change information about the DomainName resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayResponseResponse updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates a GatewayResponse of a specified response type on the given RestApi.
updateGatewayResponseRequest - Updates a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateGatewayResponseResponse updateGatewayResponse(Consumer<UpdateGatewayResponseRequest.Builder> updateGatewayResponseRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates a GatewayResponse of a specified response type on the given RestApi.
This is a convenience which creates an instance of the UpdateGatewayResponseRequest.Builder avoiding the
need to create one manually via UpdateGatewayResponseRequest.builder()
updateGatewayResponseRequest - A Consumer that will call methods on UpdateGatewayResponseRequest.Builder to create a
request. Updates a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIntegrationResponse updateIntegration(UpdateIntegrationRequest updateIntegrationRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents an update integration.
updateIntegrationRequest - Represents an update integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIntegrationResponse updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Represents an update integration.
This is a convenience which creates an instance of the UpdateIntegrationRequest.Builder avoiding the need
to create one manually via UpdateIntegrationRequest.builder()
updateIntegrationRequest - A Consumer that will call methods on UpdateIntegrationRequest.Builder to create a request.
Represents an update integration request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIntegrationResponseResponse updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents an update integration response.
updateIntegrationResponseRequest - Represents an update integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateIntegrationResponseResponse updateIntegrationResponse(Consumer<UpdateIntegrationResponseRequest.Builder> updateIntegrationResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Represents an update integration response.
This is a convenience which creates an instance of the UpdateIntegrationResponseRequest.Builder avoiding
the need to create one manually via UpdateIntegrationResponseRequest.builder()
updateIntegrationResponseRequest - A Consumer that will call methods on UpdateIntegrationResponseRequest.Builder to create a
request. Represents an update integration response request.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMethodResponse updateMethod(UpdateMethodRequest updateMethodRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing Method resource.
updateMethodRequest - Request to update an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMethodResponse updateMethod(Consumer<UpdateMethodRequest.Builder> updateMethodRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing Method resource.
This is a convenience which creates an instance of the UpdateMethodRequest.Builder avoiding the need to
create one manually via UpdateMethodRequest.builder()
updateMethodRequest - A Consumer that will call methods on UpdateMethodRequest.Builder to create a request.
Request to update an existing Method resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMethodResponseResponse updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing MethodResponse resource.
updateMethodResponseRequest - A request to update an existing MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateMethodResponseResponse updateMethodResponse(Consumer<UpdateMethodResponseRequest.Builder> updateMethodResponseRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates an existing MethodResponse resource.
This is a convenience which creates an instance of the UpdateMethodResponseRequest.Builder avoiding the
need to create one manually via UpdateMethodResponseRequest.builder()
updateMethodResponseRequest - A Consumer that will call methods on UpdateMethodResponseRequest.Builder to create a
request. A request to update an existing MethodResponse resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException - The request exceeded the rate limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a model.
updateModelRequest - Request to update an existing model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateModelResponse updateModel(Consumer<UpdateModelRequest.Builder> updateModelRequest) throws UnauthorizedException, NotFoundException, BadRequestException, ConflictException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a model.
This is a convenience which creates an instance of the UpdateModelRequest.Builder avoiding the need to
create one manually via UpdateModelRequest.builder()
updateModelRequest - A Consumer that will call methods on UpdateModelRequest.Builder to create a request.
Request to update an existing model in an existing RestApi resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRequestValidatorResponse updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates a RequestValidator of a given RestApi.
updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRequestValidatorResponse updateRequestValidator(Consumer<UpdateRequestValidatorRequest.Builder> updateRequestValidatorRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Updates a RequestValidator of a given RestApi.
This is a convenience which creates an instance of the UpdateRequestValidatorRequest.Builder avoiding the
need to create one manually via UpdateRequestValidatorRequest.builder()
updateRequestValidatorRequest - A Consumer that will call methods on UpdateRequestValidatorRequest.Builder to create a
request. Updates a RequestValidator of a given RestApi.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Resource resource.
updateResourceRequest - Request to change information about a Resource resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Resource resource.
This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to
create one manually via UpdateResourceRequest.builder()
updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request.
Request to change information about a Resource resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRestApiResponse updateRestApi(UpdateRestApiRequest updateRestApiRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the specified API.
updateRestApiRequest - Request to update an existing RestApi resource in your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRestApiResponse updateRestApi(Consumer<UpdateRestApiRequest.Builder> updateRestApiRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about the specified API.
This is a convenience which creates an instance of the UpdateRestApiRequest.Builder avoiding the need to
create one manually via UpdateRestApiRequest.builder()
updateRestApiRequest - A Consumer that will call methods on UpdateRestApiRequest.Builder to create a request.
Request to update an existing RestApi resource in your collection.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Stage resource.
updateStageRequest - Requests Amazon API Gateway to change information about a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateStageResponse updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest) throws UnauthorizedException, NotFoundException, ConflictException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, APIGatewayException
Changes information about a Stage resource.
This is a convenience which creates an instance of the UpdateStageRequest.Builder avoiding the need to
create one manually via UpdateStageRequest.builder()
updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request.
Requests Amazon API Gateway to change information about a Stage resource.UnauthorizedException - The request is denied because the caller has insufficient permissions.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUsageResponse updateUsage(UpdateUsageRequest updateUsageRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
updateUsageRequest - The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
specified API key.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUsageResponse updateUsage(Consumer<UpdateUsageRequest.Builder> updateUsageRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, AwsServiceException, SdkClientException, APIGatewayException
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
This is a convenience which creates an instance of the UpdateUsageRequest.Builder avoiding the need to
create one manually via UpdateUsageRequest.builder()
updateUsageRequest - A Consumer that will call methods on UpdateUsageRequest.Builder to create a request. The
PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
specified API key.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Updates a usage plan of a given plan Id.
updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateUsagePlanResponse updateUsagePlan(Consumer<UpdateUsagePlanRequest.Builder> updateUsagePlanRequest) throws UnauthorizedException, TooManyRequestsException, BadRequestException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, APIGatewayException
Updates a usage plan of a given plan Id.
This is a convenience which creates an instance of the UpdateUsagePlanRequest.Builder avoiding the need
to create one manually via UpdateUsagePlanRequest.builder()
updateUsagePlanRequest - A Consumer that will call methods on UpdateUsagePlanRequest.Builder to create a request.
The PATCH request to update a usage plan of a given plan Id.UnauthorizedException - The request is denied because the caller has insufficient permissions.TooManyRequestsException - The request has reached its throttling limit. Retry after the specified time period.BadRequestException - The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException - The requested resource is not found. Make sure that the request URI is correct.ConflictException - The request configuration has conflicts. For details, see the accompanying error message.SdkException - 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.