@Generated(value="software.amazon.awssdk:codegen") public interface ApiGatewayClient extends SdkClient
builder()
method.
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on 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()
Create an ApiKey resource.
|
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 CreateVpcLinkResponse |
createVpcLink(Consumer<CreateVpcLinkRequest.Builder> createVpcLinkRequest)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
takes 2-4 minutes to complete and become operational.
|
default CreateVpcLinkResponse |
createVpcLink(CreateVpcLinkRequest createVpcLinkRequest)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
takes 2-4 minutes to complete and become operational.
|
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 DeleteVpcLinkResponse |
deleteVpcLink(Consumer<DeleteVpcLinkRequest.Builder> deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
|
default DeleteVpcLinkResponse |
deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
|
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()
Generates a ClientCertificate resource.
|
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 GetApiKeysIterable |
getApiKeysPaginator()
Gets information about the current ApiKeys resource.
|
default GetApiKeysIterable |
getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
Gets information about the current ApiKeys resource.
|
default GetApiKeysIterable |
getApiKeysPaginator(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 GetBasePathMappingsIterable |
getBasePathMappingsPaginator(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
|
default GetBasePathMappingsIterable |
getBasePathMappingsPaginator(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 GetClientCertificatesIterable |
getClientCertificatesPaginator()
Gets a collection of ClientCertificate resources.
|
default GetClientCertificatesIterable |
getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
|
default GetClientCertificatesIterable |
getClientCertificatesPaginator(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 GetDeploymentsIterable |
getDeploymentsPaginator(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)
Gets information about a Deployments collection.
|
default GetDeploymentsIterable |
getDeploymentsPaginator(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 GetDomainNamesIterable |
getDomainNamesPaginator()
Represents a collection of DomainName resources.
|
default GetDomainNamesIterable |
getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
Represents a collection of DomainName resources.
|
default GetDomainNamesIterable |
getDomainNamesPaginator(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)
Get the integration settings.
|
default GetIntegrationResponse |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Get the integration settings.
|
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 GetModelsIterable |
getModelsPaginator(Consumer<GetModelsRequest.Builder> getModelsRequest)
|
default GetModelsIterable |
getModelsPaginator(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 GetResourcesIterable |
getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Lists information about a collection of Resource resources.
|
default GetResourcesIterable |
getResourcesPaginator(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 GetRestApisIterable |
getRestApisPaginator()
Lists the RestApis resources for your collection.
|
default GetRestApisIterable |
getRestApisPaginator(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
Lists the RestApis resources for your collection.
|
default GetRestApisIterable |
getRestApisPaginator(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 GetTagsResponse |
getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Gets the Tags collection for a given resource.
|
default GetTagsResponse |
getTags(GetTagsRequest getTagsRequest)
Gets the Tags collection for a given resource.
|
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 GetUsageIterable |
getUsagePaginator(Consumer<GetUsageRequest.Builder> getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
|
default GetUsageIterable |
getUsagePaginator(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 GetUsagePlanKeysIterable |
getUsagePlanKeysPaginator(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
default GetUsagePlanKeysIterable |
getUsagePlanKeysPaginator(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 GetUsagePlansIterable |
getUsagePlansPaginator()
Gets all the usage plans of the caller's account.
|
default GetUsagePlansIterable |
getUsagePlansPaginator(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
default GetUsagePlansIterable |
getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
default GetVpcLinkResponse |
getVpcLink(Consumer<GetVpcLinkRequest.Builder> getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
|
default GetVpcLinkResponse |
getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
|
default GetVpcLinksResponse |
getVpcLinks()
Gets the VpcLinks collection under the caller's account in a selected region.
|
default GetVpcLinksResponse |
getVpcLinks(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
|
default GetVpcLinksResponse |
getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
|
default GetVpcLinksIterable |
getVpcLinksPaginator()
Gets the VpcLinks collection under the caller's account in a selected region.
|
default GetVpcLinksIterable |
getVpcLinksPaginator(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
|
default GetVpcLinksIterable |
getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
|
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 API Gateway control service for creating a new API from an external API definition file.
|
default ImportRestApiResponse |
importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the 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 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 API Gateway control service for updating an existing API with an input of external API
definitions.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates a tag on a given resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates a tag on a given resource.
|
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 UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from a given resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a given resource.
|
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.
|
default UpdateVpcLinkResponse |
updateVpcLink(Consumer<UpdateVpcLinkRequest.Builder> updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
|
default UpdateVpcLinkResponse |
updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
|
serviceName
close
static 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() throws UnauthorizedException, NotFoundException, TooManyRequestsException, LimitExceededException, BadRequestException, ConflictException, AwsServiceException, SdkClientException, ApiGatewayException
UnauthorizedException
- The 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.AwsServiceException
createApiKey(CreateApiKeyRequest)
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default CreateBasePathMappingResponse createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest) throws UnauthorizedException, ConflictException, BadRequestException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Creates a new BasePathMapping resource.
createBasePathMappingRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default 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 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default CreateResourceResponse createResource(CreateResourceRequest createResourceRequest) throws UnauthorizedException, NotFoundException, ConflictException, LimitExceededException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Creates a Resource resource.
createResourceRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default CreateVpcLinkResponse createVpcLink(CreateVpcLinkRequest createVpcLinkRequest) throws UnauthorizedException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
createVpcLinkRequest
- Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.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.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.AwsServiceException
default CreateVpcLinkResponse createVpcLink(Consumer<CreateVpcLinkRequest.Builder> createVpcLinkRequest) throws UnauthorizedException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
This is a convenience which creates an instance of the CreateVpcLinkRequest.Builder
avoiding the need to
create one manually via CreateVpcLinkRequest.builder()
createVpcLinkRequest
- A Consumer
that will call methods on CreateVpcLinkRequest.Builder
to create a request.
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.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.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, 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.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.AwsServiceException
default DeleteDomainNameResponse deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, 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.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, ApiGatewayException
Deletes a Stage resource.
deleteStageRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default DeleteVpcLinkResponse deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, ApiGatewayException
Deletes an existing VpcLink of a specified identifier.
deleteVpcLinkRequest
- Deletes an existing VpcLink of a specified identifier.UnauthorizedException
- The 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.AwsServiceException
default DeleteVpcLinkResponse deleteVpcLink(Consumer<DeleteVpcLinkRequest.Builder> deleteVpcLinkRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, BadRequestException, AwsServiceException, SdkClientException, ApiGatewayException
Deletes an existing VpcLink of a specified identifier.
This is a convenience which creates an instance of the DeleteVpcLinkRequest.Builder
avoiding the need to
create one manually via DeleteVpcLinkRequest.builder()
deleteVpcLinkRequest
- A Consumer
that will call methods on DeleteVpcLinkRequest.Builder
to create a request.
Deletes an existing VpcLink of a specified identifier.UnauthorizedException
- The 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default FlushStageCacheResponse flushStageCache(FlushStageCacheRequest flushStageCacheRequest) throws UnauthorizedException, NotFoundException, BadRequestException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Flushes a stage's cache.
flushStageCacheRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default GenerateClientCertificateResponse generateClientCertificate() throws UnauthorizedException, TooManyRequestsException, LimitExceededException, AwsServiceException, SdkClientException, ApiGatewayException
Generates 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.AwsServiceException
generateClientCertificate(GenerateClientCertificateRequest)
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
getAccount(GetAccountRequest)
default GetAccountResponse getAccount(GetAccountRequest getAccountRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about the current Account resource.
getAccountRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
getApiKeys(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.AwsServiceException
default 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.AwsServiceException
default GetApiKeysIterable getApiKeysPaginator() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about the current ApiKeys resource.
This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation.
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.AwsServiceException
getApiKeysPaginator(GetApiKeysRequest)
default GetApiKeysIterable getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about the current ApiKeys resource.
This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation.
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.AwsServiceException
default GetApiKeysIterable getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about the current ApiKeys resource.
This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetApiKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetApiKeysIterable responses = client.getApiKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default GetBasePathMappingsIterable getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Represents a collection of BasePathMapping resources.
This is a variant of
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client .getBasePathMappingsPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation.
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.AwsServiceException
default GetBasePathMappingsIterable getBasePathMappingsPaginator(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Represents a collection of BasePathMapping resources.
This is a variant of
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client .getBasePathMappingsPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetBasePathMappingsIterable responses = client.getBasePathMappingsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
getClientCertificates(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.AwsServiceException
default 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.AwsServiceException
default GetClientCertificatesIterable getClientCertificatesPaginator() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets a collection of ClientCertificate resources.
This is a variant of
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client .getClientCertificatesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
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.AwsServiceException
getClientCertificatesPaginator(GetClientCertificatesRequest)
default GetClientCertificatesIterable getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets a collection of ClientCertificate resources.
This is a variant of
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client .getClientCertificatesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
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.AwsServiceException
default GetClientCertificatesIterable getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Gets a collection of ClientCertificate resources.
This is a variant of
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client .getClientCertificatesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetClientCertificatesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetClientCertificatesIterable responses = client.getClientCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation.
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.AwsServiceException
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws UnauthorizedException, NotFoundException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about a Deployment resource.
getDeploymentRequest
- Requests 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.AwsServiceException
default 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 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.AwsServiceException
default GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about a Deployments collection.
getDeploymentsRequest
- Requests 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.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.AwsServiceException
default GetDeploymentsResponse getDeployments(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest) throws BadRequestException, NotFoundException, 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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.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.AwsServiceException
default GetDeploymentsIterable getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about a Deployments collection.
This is a variant of
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client .getDeploymentsPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation.
getDeploymentsRequest
- Requests 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.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.AwsServiceException
default GetDeploymentsIterable getDeploymentsPaginator(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest) throws BadRequestException, NotFoundException, UnauthorizedException, TooManyRequestsException, ServiceUnavailableException, AwsServiceException, SdkClientException, ApiGatewayException
Gets information about a Deployments collection.
This is a variant of
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client .getDeploymentsPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetDeploymentsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetDeploymentsIterable responses = client.getDeploymentsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation.
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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
getDomainNames(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.AwsServiceException
default 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.AwsServiceException
default GetDomainNamesIterable getDomainNamesPaginator() throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Represents a collection of DomainName resources.
This is a variant of
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client .getDomainNamesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation.
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.AwsServiceException
getDomainNamesPaginator(GetDomainNamesRequest)
default GetDomainNamesIterable getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Represents a collection of DomainName resources.
This is a variant of
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client .getDomainNamesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation.
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.AwsServiceException
default GetDomainNamesIterable getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest) throws BadRequestException, UnauthorizedException, TooManyRequestsException, AwsServiceException, SdkClientException, ApiGatewayException
Represents a collection of DomainName resources.
This is a variant of
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client .getDomainNamesPaginator(request); for (software.amazon.awssdk.services.apigateway.model.GetDomainNamesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.apigateway.paginators.GetDomainNamesIterable responses = client.getDomainNamesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation.
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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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.AwsServiceException
default 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 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 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.