Interface ApiGatewayClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ApiGatewayClient
extends AwsClient

Service client for accessing Amazon API Gateway. This can be created using the static builder() method. Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ApiGatewayClientBuilder	builder()	Create a builder that can be used to configure and create a ApiGatewayClient.
static ApiGatewayClient	create()	Create a ApiGatewayClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApiKeyResponse	createApiKey()	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)	Creates a documentation part.
default CreateDocumentationPartResponse	createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)	Creates a documentation part.
default CreateDocumentationVersionResponse	createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest)	Creates a documentation version
default CreateDocumentationVersionResponse	createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)	Creates a documentation version
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)	Adds a new Model resource to an existing RestApi resource.
default CreateModelResponse	createModel(CreateModelRequest createModelRequest)	Adds a new Model resource to an existing RestApi resource.
default CreateRequestValidatorResponse	createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest)	Creates a RequestValidator of a given RestApi.
default CreateRequestValidatorResponse	createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)	Creates a RequestValidator 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)	Deletes a documentation part
default DeleteDocumentationPartResponse	deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)	Deletes a documentation part
default DeleteDocumentationVersionResponse	deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest)	Deletes a documentation version.
default DeleteDocumentationVersionResponse	deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)	Deletes a documentation version.
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()	This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
default GetApiKeysIterable	getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)	This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
default GetApiKeysIterable	getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest)	This is a variant of getApiKeys(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest) operation.
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)	This is a variant of getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) operation.
default GetBasePathMappingsIterable	getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest)	This is a variant of getBasePathMappings(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest) operation.
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()	This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.
default GetClientCertificatesIterable	getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)	This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.
default GetClientCertificatesIterable	getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest)	This is a variant of getClientCertificates(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest) operation.
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)	This is a variant of getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.
default GetDeploymentsIterable	getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest)	This is a variant of getDeployments(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest) operation.
default GetDocumentationPartResponse	getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest)	Gets a documentation part.
default GetDocumentationPartResponse	getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)	Gets a documentation part.
default GetDocumentationPartsResponse	getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest)	Gets documentation parts.
default GetDocumentationPartsResponse	getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)	Gets documentation parts.
default GetDocumentationVersionResponse	getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest)	Gets a documentation version.
default GetDocumentationVersionResponse	getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)	Gets a documentation version.
default GetDocumentationVersionsResponse	getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest)	Gets documentation versions.
default GetDocumentationVersionsResponse	getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)	Gets documentation versions.
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()	This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
default GetDomainNamesIterable	getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)	This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
default GetDomainNamesIterable	getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest)	This is a variant of getDomainNames(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest) operation.
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)	Describes existing Models defined for a RestApi resource.
default GetModelsResponse	getModels(GetModelsRequest getModelsRequest)	Describes existing Models defined for a RestApi resource.
default GetModelsIterable	getModelsPaginator(Consumer<GetModelsRequest.Builder> getModelsRequest)	This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.
default GetModelsIterable	getModelsPaginator(GetModelsRequest getModelsRequest)	This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.
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)	This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.
default GetResourcesIterable	getResourcesPaginator(GetResourcesRequest getResourcesRequest)	This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.
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()	This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
default GetRestApisIterable	getRestApisPaginator(Consumer<GetRestApisRequest.Builder> getRestApisRequest)	This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
default GetRestApisIterable	getRestApisPaginator(GetRestApisRequest getRestApisRequest)	This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.
default GetSdkResponse	getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest)	Generates a client SDK for a RestApi and Stage.
default GetSdkResponse	getSdk(GetSdkRequest getSdkRequest)	Generates a client SDK for a RestApi and Stage.
default GetSdkTypeResponse	getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest)	Gets an SDK type.
default GetSdkTypeResponse	getSdkType(GetSdkTypeRequest getSdkTypeRequest)	Gets an SDK type.
default GetSdkTypesResponse	getSdkTypes()	Gets SDK types
default GetSdkTypesResponse	getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest)	Gets SDK types
default GetSdkTypesResponse	getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)	Gets SDK types
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)	This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.
default GetUsageIterable	getUsagePaginator(GetUsageRequest getUsageRequest)	This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.
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)	This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.
default GetUsagePlanKeysIterable	getUsagePlanKeysPaginator(GetUsagePlanKeysRequest getUsagePlanKeysRequest)	This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.
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()	This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
default GetUsagePlansIterable	getUsagePlansPaginator(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)	This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
default GetUsagePlansIterable	getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest)	This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.
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()	This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
default GetVpcLinksIterable	getVpcLinksPaginator(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)	This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
default GetVpcLinksIterable	getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest)	This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.
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)	Imports documentation parts
default ImportDocumentationPartsResponse	importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)	Imports documentation parts
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.
default ApiGatewayServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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)	Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
default TestInvokeMethodResponse	testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)	Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
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)	Updates a documentation part.
default UpdateDocumentationPartResponse	updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)	Updates a documentation part.
default UpdateDocumentationVersionResponse	updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest)	Updates a documentation version.
default UpdateDocumentationVersionResponse	updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)	Updates a documentation version.
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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createApiKey

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

Create an ApiKey resource.

Parameters:

createApiKeyRequest - Request to create an ApiKey resource.

Returns:

Result of the CreateApiKey operation returned by the service.

createApiKey

default CreateApiKeyResponse createApiKey(Consumer<CreateApiKeyRequest.Builder> createApiKeyRequest)
                                   throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

createApiKeyRequest - A Consumer that will call methods on CreateApiKeyRequest.Builder to create a request. Request to create an ApiKey resource.

Returns:

Result of the CreateApiKey operation returned by the service.

createApiKey

default CreateApiKeyResponse createApiKey()
                                   throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Create an ApiKey resource.

Returns:

Result of the CreateApiKey operation returned by the service.

See Also:

• createApiKey(CreateApiKeyRequest)

createAuthorizer

default CreateAuthorizerResponse createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Adds a new Authorizer resource to an existing RestApi resource.

Parameters:

createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.

Returns:

Result of the CreateAuthorizer operation returned by the service.

createAuthorizer

default CreateAuthorizerResponse createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the CreateAuthorizer operation returned by the service.

createBasePathMapping

default CreateBasePathMappingResponse createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a new BasePathMapping resource.

Parameters:

createBasePathMappingRequest - Requests API Gateway to create a new BasePathMapping resource.

Returns:

Result of the CreateBasePathMapping operation returned by the service.

createBasePathMapping

default CreateBasePathMappingResponse createBasePathMapping(Consumer<CreateBasePathMappingRequest.Builder> createBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

createBasePathMappingRequest - A Consumer that will call methods on CreateBasePathMappingRequest.Builder to create a request. Requests API Gateway to create a new BasePathMapping resource.

Returns:

Result of the CreateBasePathMapping operation returned by the service.

createDeployment

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

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Parameters:

createDeploymentRequest - Requests API Gateway to create a Deployment resource.

Returns:

Result of the CreateDeployment operation returned by the service.

createDeployment

default CreateDeploymentResponse createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request. Requests API Gateway to create a Deployment resource.

Returns:

Result of the CreateDeployment operation returned by the service.

createDocumentationPart

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

Creates a documentation part.

Parameters:

createDocumentationPartRequest - Creates a new documentation part of a given API.

Returns:

Result of the CreateDocumentationPart operation returned by the service.

createDocumentationPart

default CreateDocumentationPartResponse createDocumentationPart(Consumer<CreateDocumentationPartRequest.Builder> createDocumentationPartRequest)
                                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a documentation part.

This is a convenience which creates an instance of the CreateDocumentationPartRequest.Builder avoiding the need to create one manually via CreateDocumentationPartRequest.builder()

Parameters:

createDocumentationPartRequest - A Consumer that will call methods on CreateDocumentationPartRequest.Builder to create a request. Creates a new documentation part of a given API.

Returns:

Result of the CreateDocumentationPart operation returned by the service.

createDocumentationVersion

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

Creates a documentation version

Parameters:

createDocumentationVersionRequest - Creates a new documentation version of a given API.

Returns:

Result of the CreateDocumentationVersion operation returned by the service.

createDocumentationVersion

default CreateDocumentationVersionResponse createDocumentationVersion(Consumer<CreateDocumentationVersionRequest.Builder> createDocumentationVersionRequest)
                                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a documentation version

This is a convenience which creates an instance of the CreateDocumentationVersionRequest.Builder avoiding the need to create one manually via CreateDocumentationVersionRequest.builder()

Parameters:

createDocumentationVersionRequest - A Consumer that will call methods on CreateDocumentationVersionRequest.Builder to create a request. Creates a new documentation version of a given API.

Returns:

Result of the CreateDocumentationVersion operation returned by the service.

createDomainName

default CreateDomainNameResponse createDomainName(CreateDomainNameRequest createDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a new domain name.

Parameters:

createDomainNameRequest - A request to create a new domain name.

Returns:

Result of the CreateDomainName operation returned by the service.

createDomainName

default CreateDomainNameResponse createDomainName(Consumer<CreateDomainNameRequest.Builder> createDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
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()

Parameters:

createDomainNameRequest - A Consumer that will call methods on CreateDomainNameRequest.Builder to create a request. A request to create a new domain name.

Returns:

Result of the CreateDomainName operation returned by the service.

createModel

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

Adds a new Model resource to an existing RestApi resource.

Parameters:

createModelRequest - Request to add a new Model to an existing RestApi resource.

Returns:

Result of the CreateModel operation returned by the service.

createModel

default CreateModelResponse createModel(Consumer<CreateModelRequest.Builder> createModelRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the CreateModel operation returned by the service.

createRequestValidator

default CreateRequestValidatorResponse createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a RequestValidator of a given RestApi.

Parameters:

createRequestValidatorRequest - Creates a RequestValidator of a given RestApi.

Returns:

Result of the CreateRequestValidator operation returned by the service.

createRequestValidator

default CreateRequestValidatorResponse createRequestValidator(Consumer<CreateRequestValidatorRequest.Builder> createRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a RequestValidator 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()

Parameters:

createRequestValidatorRequest - A Consumer that will call methods on CreateRequestValidatorRequest.Builder to create a request. Creates a RequestValidator of a given RestApi.

Returns:

Result of the CreateRequestValidator operation returned by the service.

createResource

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

Creates a Resource resource.

Parameters:

createResourceRequest - Requests API Gateway to create a Resource resource.

Returns:

Result of the CreateResource operation returned by the service.

createResource

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()

Parameters:

createResourceRequest - A Consumer that will call methods on CreateResourceRequest.Builder to create a request. Requests API Gateway to create a Resource resource.

Returns:

Result of the CreateResource operation returned by the service.

createRestApi

default CreateRestApiResponse createRestApi(CreateRestApiRequest createRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a new RestApi resource.

Parameters:

createRestApiRequest - The POST Request to add a new RestApi resource to your collection.

Returns:

Result of the CreateRestApi operation returned by the service.

createRestApi

default CreateRestApiResponse createRestApi(Consumer<CreateRestApiRequest.Builder> createRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the CreateRestApi operation returned by the service.

createStage

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.

Parameters:

createStageRequest - Requests API Gateway to create a Stage resource.

Returns:

Result of the CreateStage operation returned by the service.

createStage

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()

Parameters:

createStageRequest - A Consumer that will call methods on CreateStageRequest.Builder to create a request. Requests API Gateway to create a Stage resource.

Returns:

Result of the CreateStage operation returned by the service.

createUsagePlan

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

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Parameters:

createUsagePlanRequest - The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

Returns:

Result of the CreateUsagePlan operation returned by the service.

createUsagePlan

default CreateUsagePlanResponse createUsagePlan(Consumer<CreateUsagePlanRequest.Builder> createUsagePlanRequest)
                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

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.

Returns:

Result of the CreateUsagePlan operation returned by the service.

createUsagePlanKey

default CreateUsagePlanKeyResponse createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a usage plan key for adding an existing API key to a usage plan.

Parameters:

createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.

Returns:

Result of the CreateUsagePlanKey operation returned by the service.

createUsagePlanKey

default CreateUsagePlanKeyResponse createUsagePlanKey(Consumer<CreateUsagePlanKeyRequest.Builder> createUsagePlanKeyRequest)
                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the CreateUsagePlanKey operation returned by the service.

createVpcLink

default CreateVpcLinkResponse createVpcLink(CreateVpcLinkRequest createVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
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.

Parameters:

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.

Returns:

Result of the CreateVpcLink operation returned by the service.

createVpcLink

default CreateVpcLinkResponse createVpcLink(Consumer<CreateVpcLinkRequest.Builder> createVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the CreateVpcLink operation returned by the service.

deleteApiKey

default DeleteApiKeyResponse deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
                                   throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the ApiKey resource.

Parameters:

deleteApiKeyRequest - A request to delete the ApiKey resource.

Returns:

Result of the DeleteApiKey operation returned by the service.

deleteApiKey

default DeleteApiKeyResponse deleteApiKey(Consumer<DeleteApiKeyRequest.Builder> deleteApiKeyRequest)
                                   throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

deleteApiKeyRequest - A Consumer that will call methods on DeleteApiKeyRequest.Builder to create a request. A request to delete the ApiKey resource.

Returns:

Result of the DeleteApiKey operation returned by the service.

deleteAuthorizer

default DeleteAuthorizerResponse deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes an existing Authorizer resource.

Parameters:

deleteAuthorizerRequest - Request to delete an existing Authorizer resource.

Returns:

Result of the DeleteAuthorizer operation returned by the service.

deleteAuthorizer

default DeleteAuthorizerResponse deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteAuthorizerRequest - A Consumer that will call methods on DeleteAuthorizerRequest.Builder to create a request. Request to delete an existing Authorizer resource.

Returns:

Result of the DeleteAuthorizer operation returned by the service.

deleteBasePathMapping

default DeleteBasePathMappingResponse deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the BasePathMapping resource.

Parameters:

deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.

Returns:

Result of the DeleteBasePathMapping operation returned by the service.

deleteBasePathMapping

default DeleteBasePathMappingResponse deleteBasePathMapping(Consumer<DeleteBasePathMappingRequest.Builder> deleteBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

deleteBasePathMappingRequest - A Consumer that will call methods on DeleteBasePathMappingRequest.Builder to create a request. A request to delete the BasePathMapping resource.

Returns:

Result of the DeleteBasePathMapping operation returned by the service.

deleteClientCertificate

default DeleteClientCertificateResponse deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
                                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the ClientCertificate resource.

Parameters:

deleteClientCertificateRequest - A request to delete the ClientCertificate resource.

Returns:

Result of the DeleteClientCertificate operation returned by the service.

deleteClientCertificate

default DeleteClientCertificateResponse deleteClientCertificate(Consumer<DeleteClientCertificateRequest.Builder> deleteClientCertificateRequest)
                                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteClientCertificateRequest - A Consumer that will call methods on DeleteClientCertificateRequest.Builder to create a request. A request to delete the ClientCertificate resource.

Returns:

Result of the DeleteClientCertificate operation returned by the service.

deleteDeployment

default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Parameters:

deleteDeploymentRequest - Requests API Gateway to delete a Deployment resource.

Returns:

Result of the DeleteDeployment operation returned by the service.

deleteDeployment

default DeleteDeploymentResponse deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

deleteDeploymentRequest - A Consumer that will call methods on DeleteDeploymentRequest.Builder to create a request. Requests API Gateway to delete a Deployment resource.

Returns:

Result of the DeleteDeployment operation returned by the service.

deleteDocumentationPart

default DeleteDocumentationPartResponse deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
                                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a documentation part

Parameters:

deleteDocumentationPartRequest - Deletes an existing documentation part of an API.

Returns:

Result of the DeleteDocumentationPart operation returned by the service.

deleteDocumentationPart

default DeleteDocumentationPartResponse deleteDocumentationPart(Consumer<DeleteDocumentationPartRequest.Builder> deleteDocumentationPartRequest)
                                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a documentation part

This is a convenience which creates an instance of the DeleteDocumentationPartRequest.Builder avoiding the need to create one manually via DeleteDocumentationPartRequest.builder()

Parameters:

deleteDocumentationPartRequest - A Consumer that will call methods on DeleteDocumentationPartRequest.Builder to create a request. Deletes an existing documentation part of an API.

Returns:

Result of the DeleteDocumentationPart operation returned by the service.

deleteDocumentationVersion

default DeleteDocumentationVersionResponse deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
                                                               throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a documentation version.

Parameters:

deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.

Returns:

Result of the DeleteDocumentationVersion operation returned by the service.

deleteDocumentationVersion

default DeleteDocumentationVersionResponse deleteDocumentationVersion(Consumer<DeleteDocumentationVersionRequest.Builder> deleteDocumentationVersionRequest)
                                                               throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a documentation version.

This is a convenience which creates an instance of the DeleteDocumentationVersionRequest.Builder avoiding the need to create one manually via DeleteDocumentationVersionRequest.builder()

Parameters:

deleteDocumentationVersionRequest - A Consumer that will call methods on DeleteDocumentationVersionRequest.Builder to create a request. Deletes an existing documentation version of an API.

Returns:

Result of the DeleteDocumentationVersion operation returned by the service.

deleteDomainName

default DeleteDomainNameResponse deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the DomainName resource.

Parameters:

deleteDomainNameRequest - A request to delete the DomainName resource.

Returns:

Result of the DeleteDomainName operation returned by the service.

deleteDomainName

default DeleteDomainNameResponse deleteDomainName(Consumer<DeleteDomainNameRequest.Builder> deleteDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the DomainName resource.

This is a convenience which creates an instance of the DeleteDomainNameRequest.Builder avoiding the need to create one manually via DeleteDomainNameRequest.builder()

Parameters:

deleteDomainNameRequest - A Consumer that will call methods on DeleteDomainNameRequest.Builder to create a request. A request to delete the DomainName resource.

Returns:

Result of the DeleteDomainName operation returned by the service.

deleteGatewayResponse

default DeleteGatewayResponseResponse deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
                                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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.

Parameters:

deleteGatewayResponseRequest - Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Returns:

Result of the DeleteGatewayResponse operation returned by the service.

deleteGatewayResponse

default DeleteGatewayResponseResponse deleteGatewayResponse(Consumer<DeleteGatewayResponseRequest.Builder> deleteGatewayResponseRequest)
                                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

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.

Returns:

Result of the DeleteGatewayResponse operation returned by the service.

deleteIntegration

default DeleteIntegrationResponse deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a delete integration.

Parameters:

deleteIntegrationRequest - Represents a delete integration request.

Returns:

Result of the DeleteIntegration operation returned by the service.

deleteIntegration

default DeleteIntegrationResponse deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest)
                                             throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteIntegrationRequest - A Consumer that will call methods on DeleteIntegrationRequest.Builder to create a request. Represents a delete integration request.

Returns:

Result of the DeleteIntegration operation returned by the service.

deleteIntegrationResponse

default DeleteIntegrationResponseResponse deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
                                                             throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a delete integration response.

Parameters:

deleteIntegrationResponseRequest - Represents a delete integration response request.

Returns:

Result of the DeleteIntegrationResponse operation returned by the service.

deleteIntegrationResponse

default DeleteIntegrationResponseResponse deleteIntegrationResponse(Consumer<DeleteIntegrationResponseRequest.Builder> deleteIntegrationResponseRequest)
                                                             throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteIntegrationResponseRequest - A Consumer that will call methods on DeleteIntegrationResponseRequest.Builder to create a request. Represents a delete integration response request.

Returns:

Result of the DeleteIntegrationResponse operation returned by the service.

deleteMethod

default DeleteMethodResponse deleteMethod(DeleteMethodRequest deleteMethodRequest)
                                   throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
ConflictException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes an existing Method resource.

Parameters:

deleteMethodRequest - Request to delete an existing Method resource.

Returns:

Result of the DeleteMethod operation returned by the service.

deleteMethod

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()

Parameters:

deleteMethodRequest - A Consumer that will call methods on DeleteMethodRequest.Builder to create a request. Request to delete an existing Method resource.

Returns:

Result of the DeleteMethod operation returned by the service.

deleteMethodResponse

default DeleteMethodResponseResponse deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
                                                   throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
BadRequestException,
ConflictException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes an existing MethodResponse resource.

Parameters:

deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.

Returns:

Result of the DeleteMethodResponse operation returned by the service.

deleteMethodResponse

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()

Parameters:

deleteMethodResponseRequest - A Consumer that will call methods on DeleteMethodResponseRequest.Builder to create a request. A request to delete an existing MethodResponse resource.

Returns:

Result of the DeleteMethodResponse operation returned by the service.

deleteModel

default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest)
                                 throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a model.

Parameters:

deleteModelRequest - Request to delete an existing model in an existing RestApi resource.

Returns:

Result of the DeleteModel operation returned by the service.

deleteModel

default DeleteModelResponse deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)
                                 throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

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.

Returns:

Result of the DeleteModel operation returned by the service.

deleteRequestValidator

default DeleteRequestValidatorResponse deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a RequestValidator of a given RestApi.

Parameters:

deleteRequestValidatorRequest - Deletes a specified RequestValidator of a given RestApi.

Returns:

Result of the DeleteRequestValidator operation returned by the service.

deleteRequestValidator

default DeleteRequestValidatorResponse deleteRequestValidator(Consumer<DeleteRequestValidatorRequest.Builder> deleteRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteRequestValidatorRequest - A Consumer that will call methods on DeleteRequestValidatorRequest.Builder to create a request. Deletes a specified RequestValidator of a given RestApi.

Returns:

Result of the DeleteRequestValidator operation returned by the service.

deleteResource

default DeleteResourceResponse deleteResource(DeleteResourceRequest deleteResourceRequest)
                                       throws UnauthorizedException,
NotFoundException,
BadRequestException,
ConflictException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a Resource resource.

Parameters:

deleteResourceRequest - Request to delete a Resource.

Returns:

Result of the DeleteResource operation returned by the service.

deleteResource

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()

Parameters:

deleteResourceRequest - A Consumer that will call methods on DeleteResourceRequest.Builder to create a request. Request to delete a Resource.

Returns:

Result of the DeleteResource operation returned by the service.

deleteRestApi

default DeleteRestApiResponse deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes the specified API.

Parameters:

deleteRestApiRequest - Request to delete the specified API from your collection.

Returns:

Result of the DeleteRestApi operation returned by the service.

deleteRestApi

default DeleteRestApiResponse deleteRestApi(Consumer<DeleteRestApiRequest.Builder> deleteRestApiRequest)
                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteRestApiRequest - A Consumer that will call methods on DeleteRestApiRequest.Builder to create a request. Request to delete the specified API from your collection.

Returns:

Result of the DeleteRestApi operation returned by the service.

deleteStage

default DeleteStageResponse deleteStage(DeleteStageRequest deleteStageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a Stage resource.

Parameters:

deleteStageRequest - Requests API Gateway to delete a Stage resource.

Returns:

Result of the DeleteStage operation returned by the service.

deleteStage

default DeleteStageResponse deleteStage(Consumer<DeleteStageRequest.Builder> deleteStageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteStageRequest - A Consumer that will call methods on DeleteStageRequest.Builder to create a request. Requests API Gateway to delete a Stage resource.

Returns:

Result of the DeleteStage operation returned by the service.

deleteUsagePlan

default DeleteUsagePlanResponse deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a usage plan of a given plan Id.

Parameters:

deleteUsagePlanRequest - The DELETE request to delete a usage plan of a given plan Id.

Returns:

Result of the DeleteUsagePlan operation returned by the service.

deleteUsagePlan

default DeleteUsagePlanResponse deleteUsagePlan(Consumer<DeleteUsagePlanRequest.Builder> deleteUsagePlanRequest)
                                         throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

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.

Returns:

Result of the DeleteUsagePlan operation returned by the service.

deleteUsagePlanKey

default DeleteUsagePlanKeyResponse deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
                                               throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Parameters:

deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

Returns:

Result of the DeleteUsagePlanKey operation returned by the service.

deleteUsagePlanKey

default DeleteUsagePlanKeyResponse deleteUsagePlanKey(Consumer<DeleteUsagePlanKeyRequest.Builder> deleteUsagePlanKeyRequest)
                                               throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the DeleteUsagePlanKey operation returned by the service.

deleteVpcLink

default DeleteVpcLinkResponse deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Deletes an existing VpcLink of a specified identifier.

Parameters:

deleteVpcLinkRequest - Deletes an existing VpcLink of a specified identifier.

Returns:

Result of the DeleteVpcLink operation returned by the service.

deleteVpcLink

default DeleteVpcLinkResponse deleteVpcLink(Consumer<DeleteVpcLinkRequest.Builder> deleteVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

deleteVpcLinkRequest - A Consumer that will call methods on DeleteVpcLinkRequest.Builder to create a request. Deletes an existing VpcLink of a specified identifier.

Returns:

Result of the DeleteVpcLink operation returned by the service.

flushStageAuthorizersCache

default FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
                                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Flushes all authorizer cache entries on a stage.

Parameters:

flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.

Returns:

Result of the FlushStageAuthorizersCache operation returned by the service.

flushStageAuthorizersCache

default FlushStageAuthorizersCacheResponse flushStageAuthorizersCache(Consumer<FlushStageAuthorizersCacheRequest.Builder> flushStageAuthorizersCacheRequest)
                                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

flushStageAuthorizersCacheRequest - A Consumer that will call methods on FlushStageAuthorizersCacheRequest.Builder to create a request. Request to flush authorizer cache entries on a specified stage.

Returns:

Result of the FlushStageAuthorizersCache operation returned by the service.

flushStageCache

default FlushStageCacheResponse flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Flushes a stage's cache.

Parameters:

flushStageCacheRequest - Requests API Gateway to flush a stage's cache.

Returns:

Result of the FlushStageCache operation returned by the service.

flushStageCache

default FlushStageCacheResponse flushStageCache(Consumer<FlushStageCacheRequest.Builder> flushStageCacheRequest)
                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

flushStageCacheRequest - A Consumer that will call methods on FlushStageCacheRequest.Builder to create a request. Requests API Gateway to flush a stage's cache.

Returns:

Result of the FlushStageCache operation returned by the service.

generateClientCertificate

default GenerateClientCertificateResponse generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
                                                             throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a ClientCertificate resource.

Parameters:

generateClientCertificateRequest - A request to generate a ClientCertificate resource.

Returns:

Result of the GenerateClientCertificate operation returned by the service.

generateClientCertificate

default GenerateClientCertificateResponse generateClientCertificate(Consumer<GenerateClientCertificateRequest.Builder> generateClientCertificateRequest)
                                                             throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
TooManyRequestsException,
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()

Parameters:

generateClientCertificateRequest - A Consumer that will call methods on GenerateClientCertificateRequest.Builder to create a request. A request to generate a ClientCertificate resource.

Returns:

Result of the GenerateClientCertificate operation returned by the service.

generateClientCertificate

default GenerateClientCertificateResponse generateClientCertificate()
                                                             throws BadRequestException,
ConflictException,
LimitExceededException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a ClientCertificate resource.

Returns:

Result of the GenerateClientCertificate operation returned by the service.

See Also:

• generateClientCertificate(GenerateClientCertificateRequest)

getAccount

default GetAccountResponse getAccount(GetAccountRequest getAccountRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current Account resource.

Parameters:

getAccountRequest - Requests API Gateway to get information about the current Account resource.

Returns:

Result of the GetAccount operation returned by the service.

getAccount

default GetAccountResponse getAccount(Consumer<GetAccountRequest.Builder> getAccountRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the GetAccount operation returned by the service.

getAccount

default GetAccountResponse getAccount()
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current Account resource.

Returns:

Result of the GetAccount operation returned by the service.

See Also:

• getAccount(GetAccountRequest)

getApiKey

default GetApiKeyResponse getApiKey(GetApiKeyRequest getApiKeyRequest)
                             throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current ApiKey resource.

Parameters:

getApiKeyRequest - A request to get information about the current ApiKey resource.

Returns:

Result of the GetApiKey operation returned by the service.

getApiKey

default GetApiKeyResponse getApiKey(Consumer<GetApiKeyRequest.Builder> getApiKeyRequest)
                             throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getApiKeyRequest - A Consumer that will call methods on GetApiKeyRequest.Builder to create a request. A request to get information about the current ApiKey resource.

Returns:

Result of the GetApiKey operation returned by the service.

getApiKeys

default GetApiKeysResponse getApiKeys(GetApiKeysRequest getApiKeysRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current ApiKeys resource.

Parameters:

getApiKeysRequest - A request to get information about the current ApiKeys resource.

Returns:

Result of the GetApiKeys operation returned by the service.

getApiKeys

default GetApiKeysResponse getApiKeys(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
                               throws BadRequestException,
NotFoundException,
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()

Parameters:

getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A request to get information about the current ApiKeys resource.

Returns:

Result of the GetApiKeys operation returned by the service.

getApiKeys

default GetApiKeysResponse getApiKeys()
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current ApiKeys resource.

Returns:

Result of the GetApiKeys operation returned by the service.

See Also:

• getApiKeys(GetApiKeysRequest)

getApiKeysPaginator

default GetApiKeysIterable getApiKeysPaginator()
                                        throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getApiKeysPaginator(GetApiKeysRequest)

getApiKeysPaginator

default GetApiKeysIterable getApiKeysPaginator(GetApiKeysRequest getApiKeysRequest)
                                        throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Parameters:

getApiKeysRequest - A request to get information about the current ApiKeys resource.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getApiKeysPaginator

default GetApiKeysIterable getApiKeysPaginator(Consumer<GetApiKeysRequest.Builder> getApiKeysRequest)
                                        throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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()

Parameters:

getApiKeysRequest - A Consumer that will call methods on GetApiKeysRequest.Builder to create a request. A request to get information about the current ApiKeys resource.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getAuthorizer

default GetAuthorizerResponse getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describe an existing Authorizer resource.

Parameters:

getAuthorizerRequest - Request to describe an existing Authorizer resource.

Returns:

Result of the GetAuthorizer operation returned by the service.

getAuthorizer

default GetAuthorizerResponse getAuthorizer(Consumer<GetAuthorizerRequest.Builder> getAuthorizerRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getAuthorizerRequest - A Consumer that will call methods on GetAuthorizerRequest.Builder to create a request. Request to describe an existing Authorizer resource.

Returns:

Result of the GetAuthorizer operation returned by the service.

getAuthorizers

default GetAuthorizersResponse getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describe an existing Authorizers resource.

Parameters:

getAuthorizersRequest - Request to describe an existing Authorizers resource.

Returns:

Result of the GetAuthorizers operation returned by the service.

getAuthorizers

default GetAuthorizersResponse getAuthorizers(Consumer<GetAuthorizersRequest.Builder> getAuthorizersRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getAuthorizersRequest - A Consumer that will call methods on GetAuthorizersRequest.Builder to create a request. Request to describe an existing Authorizers resource.

Returns:

Result of the GetAuthorizers operation returned by the service.

getBasePathMapping

default GetBasePathMappingResponse getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
                                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describe a BasePathMapping resource.

Parameters:

getBasePathMappingRequest - Request to describe a BasePathMapping resource.

Returns:

Result of the GetBasePathMapping operation returned by the service.

getBasePathMapping

default GetBasePathMappingResponse getBasePathMapping(Consumer<GetBasePathMappingRequest.Builder> getBasePathMappingRequest)
                                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getBasePathMappingRequest - A Consumer that will call methods on GetBasePathMappingRequest.Builder to create a request. Request to describe a BasePathMapping resource.

Returns:

Result of the GetBasePathMapping operation returned by the service.

getBasePathMappings

default GetBasePathMappingsResponse getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a collection of BasePathMapping resources.

Parameters:

getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.

Returns:

Result of the GetBasePathMappings operation returned by the service.

getBasePathMappings

default GetBasePathMappingsResponse getBasePathMappings(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the GetBasePathMappings operation returned by the service.

getBasePathMappingsPaginator

default GetBasePathMappingsIterable getBasePathMappingsPaginator(GetBasePathMappingsRequest getBasePathMappingsRequest)
                                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Parameters:

getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getBasePathMappingsPaginator

default GetBasePathMappingsIterable getBasePathMappingsPaginator(Consumer<GetBasePathMappingsRequest.Builder> getBasePathMappingsRequest)
                                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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()

Parameters:

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getClientCertificate

default GetClientCertificateResponse getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about the current ClientCertificate resource.

Parameters:

getClientCertificateRequest - A request to get information about the current ClientCertificate resource.

Returns:

Result of the GetClientCertificate operation returned by the service.

getClientCertificate

default GetClientCertificateResponse getClientCertificate(Consumer<GetClientCertificateRequest.Builder> getClientCertificateRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getClientCertificateRequest - A Consumer that will call methods on GetClientCertificateRequest.Builder to create a request. A request to get information about the current ClientCertificate resource.

Returns:

Result of the GetClientCertificate operation returned by the service.

getClientCertificates

default GetClientCertificatesResponse getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
                                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a collection of ClientCertificate resources.

Parameters:

getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.

Returns:

Result of the GetClientCertificates operation returned by the service.

getClientCertificates

default GetClientCertificatesResponse getClientCertificates(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
                                                     throws BadRequestException,
NotFoundException,
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()

Parameters:

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.

Returns:

Result of the GetClientCertificates operation returned by the service.

getClientCertificates

default GetClientCertificatesResponse getClientCertificates()
                                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a collection of ClientCertificate resources.

Returns:

Result of the GetClientCertificates operation returned by the service.

See Also:

• getClientCertificates(GetClientCertificatesRequest)

getClientCertificatesPaginator

default GetClientCertificatesIterable getClientCertificatesPaginator()
                                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getClientCertificatesPaginator(GetClientCertificatesRequest)

getClientCertificatesPaginator

default GetClientCertificatesIterable getClientCertificatesPaginator(GetClientCertificatesRequest getClientCertificatesRequest)
                                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Parameters:

getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getClientCertificatesPaginator

default GetClientCertificatesIterable getClientCertificatesPaginator(Consumer<GetClientCertificatesRequest.Builder> getClientCertificatesRequest)
                                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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()

Parameters:

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getDeployment

default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about a Deployment resource.

Parameters:

getDeploymentRequest - Requests API Gateway to get information about a Deployment resource.

Returns:

Result of the GetDeployment operation returned by the service.

getDeployment

default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getDeploymentRequest - A Consumer that will call methods on GetDeploymentRequest.Builder to create a request. Requests API Gateway to get information about a Deployment resource.

Returns:

Result of the GetDeployment operation returned by the service.

getDeployments

default GetDeploymentsResponse getDeployments(GetDeploymentsRequest getDeploymentsRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about a Deployments collection.

Parameters:

getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.

Returns:

Result of the GetDeployments operation returned by the service.

getDeployments

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()

Parameters:

getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request. Requests API Gateway to get information about a Deployments collection.

Returns:

Result of the GetDeployments operation returned by the service.

getDeploymentsPaginator

default GetDeploymentsIterable getDeploymentsPaginator(GetDeploymentsRequest getDeploymentsRequest)
                                                throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Parameters:

getDeploymentsRequest - Requests API Gateway to get information about a Deployments collection.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getDeploymentsPaginator

default GetDeploymentsIterable getDeploymentsPaginator(Consumer<GetDeploymentsRequest.Builder> getDeploymentsRequest)
                                                throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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()

Parameters:

getDeploymentsRequest - A Consumer that will call methods on GetDeploymentsRequest.Builder to create a request. Requests API Gateway to get information about a Deployments collection.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getDocumentationPart

default GetDocumentationPartResponse getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a documentation part.

Parameters:

getDocumentationPartRequest - Gets a specified documentation part of a given API.

Returns:

Result of the GetDocumentationPart operation returned by the service.

getDocumentationPart

default GetDocumentationPartResponse getDocumentationPart(Consumer<GetDocumentationPartRequest.Builder> getDocumentationPartRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a documentation part.

This is a convenience which creates an instance of the GetDocumentationPartRequest.Builder avoiding the need to create one manually via GetDocumentationPartRequest.builder()

Parameters:

getDocumentationPartRequest - A Consumer that will call methods on GetDocumentationPartRequest.Builder to create a request. Gets a specified documentation part of a given API.

Returns:

Result of the GetDocumentationPart operation returned by the service.

getDocumentationParts

default GetDocumentationPartsResponse getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
                                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets documentation parts.

Parameters:

getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Returns:

Result of the GetDocumentationParts operation returned by the service.

getDocumentationParts

default GetDocumentationPartsResponse getDocumentationParts(Consumer<GetDocumentationPartsRequest.Builder> getDocumentationPartsRequest)
                                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets documentation parts.

This is a convenience which creates an instance of the GetDocumentationPartsRequest.Builder avoiding the need to create one manually via GetDocumentationPartsRequest.builder()

Parameters:

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).

Returns:

Result of the GetDocumentationParts operation returned by the service.

getDocumentationVersion

default GetDocumentationVersionResponse getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
                                                         throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a documentation version.

Parameters:

getDocumentationVersionRequest - Gets a documentation snapshot of an API.

Returns:

Result of the GetDocumentationVersion operation returned by the service.

getDocumentationVersion

default GetDocumentationVersionResponse getDocumentationVersion(Consumer<GetDocumentationVersionRequest.Builder> getDocumentationVersionRequest)
                                                         throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a documentation version.

This is a convenience which creates an instance of the GetDocumentationVersionRequest.Builder avoiding the need to create one manually via GetDocumentationVersionRequest.builder()

Parameters:

getDocumentationVersionRequest - A Consumer that will call methods on GetDocumentationVersionRequest.Builder to create a request. Gets a documentation snapshot of an API.

Returns:

Result of the GetDocumentationVersion operation returned by the service.

getDocumentationVersions

default GetDocumentationVersionsResponse getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
                                                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets documentation versions.

Parameters:

getDocumentationVersionsRequest - Gets the documentation versions of an API.

Returns:

Result of the GetDocumentationVersions operation returned by the service.

getDocumentationVersions

default GetDocumentationVersionsResponse getDocumentationVersions(Consumer<GetDocumentationVersionsRequest.Builder> getDocumentationVersionsRequest)
                                                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets documentation versions.

This is a convenience which creates an instance of the GetDocumentationVersionsRequest.Builder avoiding the need to create one manually via GetDocumentationVersionsRequest.builder()

Parameters:

getDocumentationVersionsRequest - A Consumer that will call methods on GetDocumentationVersionsRequest.Builder to create a request. Gets the documentation versions of an API.

Returns:

Result of the GetDocumentationVersions operation returned by the service.

getDomainName

default GetDomainNameResponse getDomainName(GetDomainNameRequest getDomainNameRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Parameters:

getDomainNameRequest - Request to get the name of a DomainName resource.

Returns:

Result of the GetDomainName operation returned by the service.

getDomainName

default GetDomainNameResponse getDomainName(Consumer<GetDomainNameRequest.Builder> getDomainNameRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

getDomainNameRequest - A Consumer that will call methods on GetDomainNameRequest.Builder to create a request. Request to get the name of a DomainName resource.

Returns:

Result of the GetDomainName operation returned by the service.

getDomainNames

default GetDomainNamesResponse getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a collection of DomainName resources.

Parameters:

getDomainNamesRequest - Request to describe a collection of DomainName resources.

Returns:

Result of the GetDomainNames operation returned by the service.

getDomainNames

default GetDomainNamesResponse getDomainNames(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
                                       throws BadRequestException,
NotFoundException,
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()

Parameters:

getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request. Request to describe a collection of DomainName resources.

Returns:

Result of the GetDomainNames operation returned by the service.

getDomainNames

default GetDomainNamesResponse getDomainNames()
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a collection of DomainName resources.

Returns:

Result of the GetDomainNames operation returned by the service.

See Also:

• getDomainNames(GetDomainNamesRequest)

getDomainNamesPaginator

default GetDomainNamesIterable getDomainNamesPaginator()
                                                throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getDomainNamesPaginator(GetDomainNamesRequest)

getDomainNamesPaginator

default GetDomainNamesIterable getDomainNamesPaginator(GetDomainNamesRequest getDomainNamesRequest)
                                                throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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.

Parameters:

getDomainNamesRequest - Request to describe a collection of DomainName resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getDomainNamesPaginator

default GetDomainNamesIterable getDomainNamesPaginator(Consumer<GetDomainNamesRequest.Builder> getDomainNamesRequest)
                                                throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

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()

Parameters:

getDomainNamesRequest - A Consumer that will call methods on GetDomainNamesRequest.Builder to create a request. Request to describe a collection of DomainName resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getExport

default GetExportResponse getExport(GetExportRequest getExportRequest)
                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Exports a deployed version of a RestApi in a specified format.

Parameters:

getExportRequest - Request a new export of a RestApi for a particular Stage.

Returns:

Result of the GetExport operation returned by the service.

getExport

default GetExportResponse getExport(Consumer<GetExportRequest.Builder> getExportRequest)
                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the GetExport operation returned by the service.

getGatewayResponse

default GetGatewayResponseResponse getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
                                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a GatewayResponse of a specified response type on the given RestApi.

Parameters:

getGatewayResponseRequest - Gets a GatewayResponse of a specified response type on the given RestApi.

Returns:

Result of the GetGatewayResponse operation returned by the service.

getGatewayResponse

default GetGatewayResponseResponse getGatewayResponse(Consumer<GetGatewayResponseRequest.Builder> getGatewayResponseRequest)
                                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
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()

Parameters:

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.

Returns:

Result of the GetGatewayResponse operation returned by the service.

getGatewayResponses

default GetGatewayResponsesResponse getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
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.

Parameters:

getGatewayResponsesRequest - Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Returns:

Result of the GetGatewayResponses operation returned by the service.

getGatewayResponses

default GetGatewayResponsesResponse getGatewayResponses(Consumer<GetGatewayResponsesRequest.Builder> getGatewayResponsesRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
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.

This is a convenience which creates an instance of the GetGatewayResponsesRequest.Builder avoiding the need to create one manually via GetGatewayResponsesRequest.builder()

Parameters:

getGatewayResponsesRequest - A Consumer that will call methods on GetGatewayResponsesRequest.Builder to create a request. Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Returns:

Result of the GetGatewayResponses operation returned by the service.

getIntegration

default GetIntegrationResponse getIntegration(GetIntegrationRequest getIntegrationRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Get the integration settings.

Parameters:

getIntegrationRequest - Represents a request to get the integration configuration.

Returns:

Result of the GetIntegration operation returned by the service.

getIntegration

default GetIntegrationResponse getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest)
                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Get the integration settings.

This is a convenience which creates an instance of the GetIntegrationRequest.Builder avoiding the need to create one manually via GetIntegrationRequest.builder()

Parameters:

getIntegrationRequest - A Consumer that will call methods on GetIntegrationRequest.Builder to create a request. Represents a request to get the integration configuration.

Returns:

Result of the GetIntegration operation returned by the service.

getIntegrationResponse

default GetIntegrationResponseResponse getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
                                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a get integration response.

Parameters:

getIntegrationResponseRequest - Represents a get integration response request.

Returns:

Result of the GetIntegrationResponse operation returned by the service.

getIntegrationResponse

default GetIntegrationResponseResponse getIntegrationResponse(Consumer<GetIntegrationResponseRequest.Builder> getIntegrationResponseRequest)
                                                       throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a get integration response.

This is a convenience which creates an instance of the GetIntegrationResponseRequest.Builder avoiding the need to create one manually via GetIntegrationResponseRequest.builder()

Parameters:

getIntegrationResponseRequest - A Consumer that will call methods on GetIntegrationResponseRequest.Builder to create a request. Represents a get integration response request.

Returns:

Result of the GetIntegrationResponse operation returned by the service.

getMethod

default GetMethodResponse getMethod(GetMethodRequest getMethodRequest)
                             throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describe an existing Method resource.

Parameters:

getMethodRequest - Request to describe an existing Method resource.

Returns:

Result of the GetMethod operation returned by the service.

getMethod

default GetMethodResponse getMethod(Consumer<GetMethodRequest.Builder> getMethodRequest)
                             throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describe an existing Method resource.

This is a convenience which creates an instance of the GetMethodRequest.Builder avoiding the need to create one manually via GetMethodRequest.builder()

Parameters:

getMethodRequest - A Consumer that will call methods on GetMethodRequest.Builder to create a request. Request to describe an existing Method resource.

Returns:

Result of the GetMethod operation returned by the service.

getMethodResponse

default GetMethodResponseResponse getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
                                             throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes a MethodResponse resource.

Parameters:

getMethodResponseRequest - Request to describe a MethodResponse resource.

Returns:

Result of the GetMethodResponse operation returned by the service.

getMethodResponse

default GetMethodResponseResponse getMethodResponse(Consumer<GetMethodResponseRequest.Builder> getMethodResponseRequest)
                                             throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes a MethodResponse resource.

This is a convenience which creates an instance of the GetMethodResponseRequest.Builder avoiding the need to create one manually via GetMethodResponseRequest.builder()

Parameters:

getMethodResponseRequest - A Consumer that will call methods on GetMethodResponseRequest.Builder to create a request. Request to describe a MethodResponse resource.

Returns:

Result of the GetMethodResponse operation returned by the service.

getModel

default GetModelResponse getModel(GetModelRequest getModelRequest)
                           throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes an existing model defined for a RestApi resource.

Parameters:

getModelRequest - Request to list information about a model in an existing RestApi resource.

Returns:

Result of the GetModel operation returned by the service.

getModel

default GetModelResponse getModel(Consumer<GetModelRequest.Builder> getModelRequest)
                           throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes an existing model defined for a RestApi resource.

This is a convenience which creates an instance of the GetModelRequest.Builder avoiding the need to create one manually via GetModelRequest.builder()

Parameters:

getModelRequest - A Consumer that will call methods on GetModelRequest.Builder to create a request. Request to list information about a model in an existing RestApi resource.

Returns:

Result of the GetModel operation returned by the service.

getModelTemplate

default GetModelTemplateResponse getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
                                           throws UnauthorizedException,
NotFoundException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Parameters:

getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.

Returns:

Result of the GetModelTemplate operation returned by the service.

getModelTemplate

default GetModelTemplateResponse getModelTemplate(Consumer<GetModelTemplateRequest.Builder> getModelTemplateRequest)
                                           throws UnauthorizedException,
NotFoundException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

This is a convenience which creates an instance of the GetModelTemplateRequest.Builder avoiding the need to create one manually via GetModelTemplateRequest.builder()

Parameters:

getModelTemplateRequest - A Consumer that will call methods on GetModelTemplateRequest.Builder to create a request. Request to generate a sample mapping template used to transform the payload.

Returns:

Result of the GetModelTemplate operation returned by the service.

getModels

default GetModelsResponse getModels(GetModelsRequest getModelsRequest)
                             throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes existing Models defined for a RestApi resource.

Parameters:

getModelsRequest - Request to list existing Models defined for a RestApi resource.

Returns:

Result of the GetModels operation returned by the service.

getModels

default GetModelsResponse getModels(Consumer<GetModelsRequest.Builder> getModelsRequest)
                             throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Describes existing Models defined for a RestApi resource.

This is a convenience which creates an instance of the GetModelsRequest.Builder avoiding the need to create one manually via GetModelsRequest.builder()

Parameters:

getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request to list existing Models defined for a RestApi resource.

Returns:

Result of the GetModels operation returned by the service.

getModelsPaginator

default GetModelsIterable getModelsPaginator(GetModelsRequest getModelsRequest)
                                      throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) 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.GetModelsIterable responses = client.getModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(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 getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.

Parameters:

getModelsRequest - Request to list existing Models defined for a RestApi resource.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getModelsPaginator

default GetModelsIterable getModelsPaginator(Consumer<GetModelsRequest.Builder> getModelsRequest)
                                      throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) 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.GetModelsIterable responses = client.getModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetModelsIterable responses = client.getModelsPaginator(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 getModels(software.amazon.awssdk.services.apigateway.model.GetModelsRequest) operation.

This is a convenience which creates an instance of the GetModelsRequest.Builder avoiding the need to create one manually via GetModelsRequest.builder()

Parameters:

getModelsRequest - A Consumer that will call methods on GetModelsRequest.Builder to create a request. Request to list existing Models defined for a RestApi resource.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getRequestValidator

default GetRequestValidatorResponse getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a RequestValidator of a given RestApi.

Parameters:

getRequestValidatorRequest - Gets a RequestValidator of a given RestApi.

Returns:

Result of the GetRequestValidator operation returned by the service.

getRequestValidator

default GetRequestValidatorResponse getRequestValidator(Consumer<GetRequestValidatorRequest.Builder> getRequestValidatorRequest)
                                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a RequestValidator of a given RestApi.

This is a convenience which creates an instance of the GetRequestValidatorRequest.Builder avoiding the need to create one manually via GetRequestValidatorRequest.builder()

Parameters:

getRequestValidatorRequest - A Consumer that will call methods on GetRequestValidatorRequest.Builder to create a request. Gets a RequestValidator of a given RestApi.

Returns:

Result of the GetRequestValidator operation returned by the service.

getRequestValidators

default GetRequestValidatorsResponse getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the RequestValidators collection of a given RestApi.

Parameters:

getRequestValidatorsRequest - Gets the RequestValidators collection of a given RestApi.

Returns:

Result of the GetRequestValidators operation returned by the service.

getRequestValidators

default GetRequestValidatorsResponse getRequestValidators(Consumer<GetRequestValidatorsRequest.Builder> getRequestValidatorsRequest)
                                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the RequestValidators collection of a given RestApi.

This is a convenience which creates an instance of the GetRequestValidatorsRequest.Builder avoiding the need to create one manually via GetRequestValidatorsRequest.builder()

Parameters:

getRequestValidatorsRequest - A Consumer that will call methods on GetRequestValidatorsRequest.Builder to create a request. Gets the RequestValidators collection of a given RestApi.

Returns:

Result of the GetRequestValidators operation returned by the service.

getResource

default GetResourceResponse getResource(GetResourceRequest getResourceRequest)
                                 throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists information about a resource.

Parameters:

getResourceRequest - Request to list information about a resource.

Returns:

Result of the GetResource operation returned by the service.

getResource

default GetResourceResponse getResource(Consumer<GetResourceRequest.Builder> getResourceRequest)
                                 throws UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists information about a resource.

This is a convenience which creates an instance of the GetResourceRequest.Builder avoiding the need to create one manually via GetResourceRequest.builder()

Parameters:

getResourceRequest - A Consumer that will call methods on GetResourceRequest.Builder to create a request. Request to list information about a resource.

Returns:

Result of the GetResource operation returned by the service.

getResources

default GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest)
                                   throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists information about a collection of Resource resources.

Parameters:

getResourcesRequest - Request to list information about a collection of resources.

Returns:

Result of the GetResources operation returned by the service.

getResources

default GetResourcesResponse getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
                                   throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists information about a collection of Resource resources.

This is a convenience which creates an instance of the GetResourcesRequest.Builder avoiding the need to create one manually via GetResourcesRequest.builder()

Parameters:

getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request. Request to list information about a collection of resources.

Returns:

Result of the GetResources operation returned by the service.

getResourcesPaginator

default GetResourcesIterable getResourcesPaginator(GetResourcesRequest getResourcesRequest)
                                            throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) 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.GetResourcesIterable responses = client.getResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(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 getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.

Parameters:

getResourcesRequest - Request to list information about a collection of resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getResourcesPaginator

default GetResourcesIterable getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
                                            throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) 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.GetResourcesIterable responses = client.getResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetResourcesIterable responses = client.getResourcesPaginator(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 getResources(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest) operation.

This is a convenience which creates an instance of the GetResourcesRequest.Builder avoiding the need to create one manually via GetResourcesRequest.builder()

Parameters:

getResourcesRequest - A Consumer that will call methods on GetResourcesRequest.Builder to create a request. Request to list information about a collection of resources.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getRestApi

default GetRestApiResponse getRestApi(GetRestApiRequest getRestApiRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists the RestApi resource in the collection.

Parameters:

getRestApiRequest - The GET request to list an existing RestApi defined for your collection.

Returns:

Result of the GetRestApi operation returned by the service.

getRestApi

default GetRestApiResponse getRestApi(Consumer<GetRestApiRequest.Builder> getRestApiRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists the RestApi resource in the collection.

This is a convenience which creates an instance of the GetRestApiRequest.Builder avoiding the need to create one manually via GetRestApiRequest.builder()

Parameters:

getRestApiRequest - A Consumer that will call methods on GetRestApiRequest.Builder to create a request. The GET request to list an existing RestApi defined for your collection.

Returns:

Result of the GetRestApi operation returned by the service.

getRestApis

default GetRestApisResponse getRestApis(GetRestApisRequest getRestApisRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists the RestApis resources for your collection.

Parameters:

getRestApisRequest - The GET request to list existing RestApis defined for your collection.

Returns:

Result of the GetRestApis operation returned by the service.

getRestApis

default GetRestApisResponse getRestApis(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists the RestApis resources for your collection.

This is a convenience which creates an instance of the GetRestApisRequest.Builder avoiding the need to create one manually via GetRestApisRequest.builder()

Parameters:

getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The GET request to list existing RestApis defined for your collection.

Returns:

Result of the GetRestApis operation returned by the service.

getRestApis

default GetRestApisResponse getRestApis()
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Lists the RestApis resources for your collection.

Returns:

Result of the GetRestApis operation returned by the service.

See Also:

• getRestApis(GetRestApisRequest)

getRestApisPaginator

default GetRestApisIterable getRestApisPaginator()
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.GetRestApisIterable responses = client.getRestApisPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getRestApisPaginator(GetRestApisRequest)

getRestApisPaginator

default GetRestApisIterable getRestApisPaginator(GetRestApisRequest getRestApisRequest)
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.GetRestApisIterable responses = client.getRestApisPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.

Parameters:

getRestApisRequest - The GET request to list existing RestApis defined for your collection.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getRestApisPaginator

default GetRestApisIterable getRestApisPaginator(Consumer<GetRestApisRequest.Builder> getRestApisRequest)
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) 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.GetRestApisIterable responses = client.getRestApisPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetRestApisResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetRestApisIterable responses = client.getRestApisPaginator(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 getRestApis(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest) operation.

This is a convenience which creates an instance of the GetRestApisRequest.Builder avoiding the need to create one manually via GetRestApisRequest.builder()

Parameters:

getRestApisRequest - A Consumer that will call methods on GetRestApisRequest.Builder to create a request. The GET request to list existing RestApis defined for your collection.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getSdk

default GetSdkResponse getSdk(GetSdkRequest getSdkRequest)
                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a client SDK for a RestApi and Stage.

Parameters:

getSdkRequest - Request a new generated client SDK for a RestApi and Stage.

Returns:

Result of the GetSdk operation returned by the service.

getSdk

default GetSdkResponse getSdk(Consumer<GetSdkRequest.Builder> getSdkRequest)
                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Generates a client SDK for a RestApi and Stage.

This is a convenience which creates an instance of the GetSdkRequest.Builder avoiding the need to create one manually via GetSdkRequest.builder()

Parameters:

getSdkRequest - A Consumer that will call methods on GetSdkRequest.Builder to create a request. Request a new generated client SDK for a RestApi and Stage.

Returns:

Result of the GetSdk operation returned by the service.

getSdkType

default GetSdkTypeResponse getSdkType(GetSdkTypeRequest getSdkTypeRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets an SDK type.

Parameters:

getSdkTypeRequest - Get an SdkType instance.

Returns:

Result of the GetSdkType operation returned by the service.

getSdkType

default GetSdkTypeResponse getSdkType(Consumer<GetSdkTypeRequest.Builder> getSdkTypeRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets an SDK type.

This is a convenience which creates an instance of the GetSdkTypeRequest.Builder avoiding the need to create one manually via GetSdkTypeRequest.builder()

Parameters:

getSdkTypeRequest - A Consumer that will call methods on GetSdkTypeRequest.Builder to create a request. Get an SdkType instance.

Returns:

Result of the GetSdkType operation returned by the service.

getSdkTypes

default GetSdkTypesResponse getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets SDK types

Parameters:

getSdkTypesRequest - Get the SdkTypes collection.

Returns:

Result of the GetSdkTypes operation returned by the service.

getSdkTypes

default GetSdkTypesResponse getSdkTypes(Consumer<GetSdkTypesRequest.Builder> getSdkTypesRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets SDK types

This is a convenience which creates an instance of the GetSdkTypesRequest.Builder avoiding the need to create one manually via GetSdkTypesRequest.builder()

Parameters:

getSdkTypesRequest - A Consumer that will call methods on GetSdkTypesRequest.Builder to create a request. Get the SdkTypes collection.

Returns:

Result of the GetSdkTypes operation returned by the service.

getSdkTypes

default GetSdkTypesResponse getSdkTypes()
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets SDK types

Returns:

Result of the GetSdkTypes operation returned by the service.

See Also:

• getSdkTypes(GetSdkTypesRequest)

getStage

default GetStageResponse getStage(GetStageRequest getStageRequest)
                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about a Stage resource.

Parameters:

getStageRequest - Requests API Gateway to get information about a Stage resource.

Returns:

Result of the GetStage operation returned by the service.

getStage

default GetStageResponse getStage(Consumer<GetStageRequest.Builder> getStageRequest)
                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about a Stage resource.

This is a convenience which creates an instance of the GetStageRequest.Builder avoiding the need to create one manually via GetStageRequest.builder()

Parameters:

getStageRequest - A Consumer that will call methods on GetStageRequest.Builder to create a request. Requests API Gateway to get information about a Stage resource.

Returns:

Result of the GetStage operation returned by the service.

getStages

default GetStagesResponse getStages(GetStagesRequest getStagesRequest)
                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about one or more Stage resources.

Parameters:

getStagesRequest - Requests API Gateway to get information about one or more Stage resources.

Returns:

Result of the GetStages operation returned by the service.

getStages

default GetStagesResponse getStages(Consumer<GetStagesRequest.Builder> getStagesRequest)
                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets information about one or more Stage resources.

This is a convenience which creates an instance of the GetStagesRequest.Builder avoiding the need to create one manually via GetStagesRequest.builder()

Parameters:

getStagesRequest - A Consumer that will call methods on GetStagesRequest.Builder to create a request. Requests API Gateway to get information about one or more Stage resources.

Returns:

Result of the GetStages operation returned by the service.

getTags

default GetTagsResponse getTags(GetTagsRequest getTagsRequest)
                         throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the Tags collection for a given resource.

Parameters:

getTagsRequest - Gets the Tags collection for a given resource.

Returns:

Result of the GetTags operation returned by the service.

getTags

default GetTagsResponse getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
                         throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the Tags collection for a given resource.

This is a convenience which creates an instance of the GetTagsRequest.Builder avoiding the need to create one manually via GetTagsRequest.builder()

Parameters:

getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request. Gets the Tags collection for a given resource.

Returns:

Result of the GetTags operation returned by the service.

getUsage

default GetUsageResponse getUsage(GetUsageRequest getUsageRequest)
                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the usage data of a usage plan in a specified time interval.

Parameters:

getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.

Returns:

Result of the GetUsage operation returned by the service.

getUsage

default GetUsageResponse getUsage(Consumer<GetUsageRequest.Builder> getUsageRequest)
                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the usage data of a usage plan in a specified time interval.

This is a convenience which creates an instance of the GetUsageRequest.Builder avoiding the need to create one manually via GetUsageRequest.builder()

Parameters:

getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET request to get the usage data of a usage plan in a specified time interval.

Returns:

Result of the GetUsage operation returned by the service.

getUsagePaginator

default GetUsageIterable getUsagePaginator(GetUsageRequest getUsageRequest)
                                    throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) 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.GetUsageIterable responses = client.getUsagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(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 getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.

Parameters:

getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUsagePaginator

default GetUsageIterable getUsagePaginator(Consumer<GetUsageRequest.Builder> getUsageRequest)
                                    throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) 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.GetUsageIterable responses = client.getUsagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsageIterable responses = client.getUsagePaginator(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 getUsage(software.amazon.awssdk.services.apigateway.model.GetUsageRequest) operation.

This is a convenience which creates an instance of the GetUsageRequest.Builder avoiding the need to create one manually via GetUsageRequest.builder()

Parameters:

getUsageRequest - A Consumer that will call methods on GetUsageRequest.Builder to create a request. The GET request to get the usage data of a usage plan in a specified time interval.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUsagePlan

default GetUsagePlanResponse getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a usage plan of a given plan identifier.

Parameters:

getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.

Returns:

Result of the GetUsagePlan operation returned by the service.

getUsagePlan

default GetUsagePlanResponse getUsagePlan(Consumer<GetUsagePlanRequest.Builder> getUsagePlanRequest)
                                   throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a usage plan of a given plan identifier.

This is a convenience which creates an instance of the GetUsagePlanRequest.Builder avoiding the need to create one manually via GetUsagePlanRequest.builder()

Parameters:

getUsagePlanRequest - A Consumer that will call methods on GetUsagePlanRequest.Builder to create a request. The GET request to get a usage plan of a given plan identifier.

Returns:

Result of the GetUsagePlan operation returned by the service.

getUsagePlanKey

default GetUsagePlanKeyResponse getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
                                         throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a usage plan key of a given key identifier.

Parameters:

getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.

Returns:

Result of the GetUsagePlanKey operation returned by the service.

getUsagePlanKey

default GetUsagePlanKeyResponse getUsagePlanKey(Consumer<GetUsagePlanKeyRequest.Builder> getUsagePlanKeyRequest)
                                         throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a usage plan key of a given key identifier.

This is a convenience which creates an instance of the GetUsagePlanKeyRequest.Builder avoiding the need to create one manually via GetUsagePlanKeyRequest.builder()

Parameters:

getUsagePlanKeyRequest - A Consumer that will call methods on GetUsagePlanKeyRequest.Builder to create a request. The GET request to get a usage plan key of a given key identifier.

Returns:

Result of the GetUsagePlanKey operation returned by the service.

getUsagePlanKeys

default GetUsagePlanKeysResponse getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
                                           throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Parameters:

getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Returns:

Result of the GetUsagePlanKeys operation returned by the service.

getUsagePlanKeys

default GetUsagePlanKeysResponse getUsagePlanKeys(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
                                           throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets all the usage plan keys representing the API keys added to a specified usage plan.

This is a convenience which creates an instance of the GetUsagePlanKeysRequest.Builder avoiding the need to create one manually via GetUsagePlanKeysRequest.builder()

Parameters:

getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request. The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Returns:

Result of the GetUsagePlanKeys operation returned by the service.

getUsagePlanKeysPaginator

default GetUsagePlanKeysIterable getUsagePlanKeysPaginator(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
                                                    throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client
             .getUsagePlanKeysPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(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 getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.

Parameters:

getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUsagePlanKeysPaginator

default GetUsagePlanKeysIterable getUsagePlanKeysPaginator(Consumer<GetUsagePlanKeysRequest.Builder> getUsagePlanKeysRequest)
                                                    throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) 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.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client
             .getUsagePlanKeysPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlanKeysIterable responses = client.getUsagePlanKeysPaginator(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 getUsagePlanKeys(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest) operation.

This is a convenience which creates an instance of the GetUsagePlanKeysRequest.Builder avoiding the need to create one manually via GetUsagePlanKeysRequest.builder()

Parameters:

getUsagePlanKeysRequest - A Consumer that will call methods on GetUsagePlanKeysRequest.Builder to create a request. The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUsagePlans

default GetUsagePlansResponse getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets all the usage plans of the caller's account.

Parameters:

getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.

Returns:

Result of the GetUsagePlans operation returned by the service.

getUsagePlans

default GetUsagePlansResponse getUsagePlans(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets all the usage plans of the caller's account.

This is a convenience which creates an instance of the GetUsagePlansRequest.Builder avoiding the need to create one manually via GetUsagePlansRequest.builder()

Parameters:

getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The GET request to get all the usage plans of the caller's account.

Returns:

Result of the GetUsagePlans operation returned by the service.

getUsagePlans

default GetUsagePlansResponse getUsagePlans()
                                     throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets all the usage plans of the caller's account.

Returns:

Result of the GetUsagePlans operation returned by the service.

See Also:

• getUsagePlans(GetUsagePlansRequest)

getUsagePlansPaginator

default GetUsagePlansIterable getUsagePlansPaginator()
                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
             .getUsagePlansPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getUsagePlansPaginator(GetUsagePlansRequest)

getUsagePlansPaginator

default GetUsagePlansIterable getUsagePlansPaginator(GetUsagePlansRequest getUsagePlansRequest)
                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
             .getUsagePlansPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.

Parameters:

getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUsagePlansPaginator

default GetUsagePlansIterable getUsagePlansPaginator(Consumer<GetUsagePlansRequest.Builder> getUsagePlansRequest)
                                              throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) 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.GetUsagePlansIterable responses = client.getUsagePlansPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client
             .getUsagePlansPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetUsagePlansResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetUsagePlansIterable responses = client.getUsagePlansPaginator(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 getUsagePlans(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest) operation.

This is a convenience which creates an instance of the GetUsagePlansRequest.Builder avoiding the need to create one manually via GetUsagePlansRequest.builder()

Parameters:

getUsagePlansRequest - A Consumer that will call methods on GetUsagePlansRequest.Builder to create a request. The GET request to get all the usage plans of the caller's account.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getVpcLink

default GetVpcLinkResponse getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a specified VPC link under the caller's account in a region.

Parameters:

getVpcLinkRequest - Gets a specified VPC link under the caller's account in a region.

Returns:

Result of the GetVpcLink operation returned by the service.

getVpcLink

default GetVpcLinkResponse getVpcLink(Consumer<GetVpcLinkRequest.Builder> getVpcLinkRequest)
                               throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets a specified VPC link under the caller's account in a region.

This is a convenience which creates an instance of the GetVpcLinkRequest.Builder avoiding the need to create one manually via GetVpcLinkRequest.builder()

Parameters:

getVpcLinkRequest - A Consumer that will call methods on GetVpcLinkRequest.Builder to create a request. Gets a specified VPC link under the caller's account in a region.

Returns:

Result of the GetVpcLink operation returned by the service.

getVpcLinks

default GetVpcLinksResponse getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the VpcLinks collection under the caller's account in a selected region.

Parameters:

getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.

Returns:

Result of the GetVpcLinks operation returned by the service.

getVpcLinks

default GetVpcLinksResponse getVpcLinks(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the VpcLinks collection under the caller's account in a selected region.

This is a convenience which creates an instance of the GetVpcLinksRequest.Builder avoiding the need to create one manually via GetVpcLinksRequest.builder()

Parameters:

getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets the VpcLinks collection under the caller's account in a selected region.

Returns:

Result of the GetVpcLinks operation returned by the service.

getVpcLinks

default GetVpcLinksResponse getVpcLinks()
                                 throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Gets the VpcLinks collection under the caller's account in a selected region.

Returns:

Result of the GetVpcLinks operation returned by the service.

See Also:

• getVpcLinks(GetVpcLinksRequest)

getVpcLinksPaginator

default GetVpcLinksIterable getVpcLinksPaginator()
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• getVpcLinksPaginator(GetVpcLinksRequest)

getVpcLinksPaginator

default GetVpcLinksIterable getVpcLinksPaginator(GetVpcLinksRequest getVpcLinksRequest)
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.

Parameters:

getVpcLinksRequest - Gets the VpcLinks collection under the caller's account in a selected region.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getVpcLinksPaginator

default GetVpcLinksIterable getVpcLinksPaginator(Consumer<GetVpcLinksRequest.Builder> getVpcLinksRequest)
                                          throws BadRequestException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

This is a variant of getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) 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.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(request);
     for (software.amazon.awssdk.services.apigateway.model.GetVpcLinksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.apigateway.paginators.GetVpcLinksIterable responses = client.getVpcLinksPaginator(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 getVpcLinks(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest) operation.

This is a convenience which creates an instance of the GetVpcLinksRequest.Builder avoiding the need to create one manually via GetVpcLinksRequest.builder()

Parameters:

getVpcLinksRequest - A Consumer that will call methods on GetVpcLinksRequest.Builder to create a request. Gets the VpcLinks collection under the caller's account in a selected region.

Returns:

A custom iterable that can be used to iterate through all the response pages.

importApiKeys

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

Import API keys from an external source, such as a CSV-formatted file.

Parameters:

importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.

Returns:

Result of the ImportApiKeys operation returned by the service.

importApiKeys

default ImportApiKeysResponse importApiKeys(Consumer<ImportApiKeysRequest.Builder> importApiKeysRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Import API keys from an external source, such as a CSV-formatted file.

This is a convenience which creates an instance of the ImportApiKeysRequest.Builder avoiding the need to create one manually via ImportApiKeysRequest.builder()

Parameters:

importApiKeysRequest - A Consumer that will call methods on ImportApiKeysRequest.Builder to create a request. The POST request to import API keys from an external source, such as a CSV-formatted file.

Returns:

Result of the ImportApiKeys operation returned by the service.

importDocumentationParts

default ImportDocumentationPartsResponse importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
                                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Imports documentation parts

Parameters:

importDocumentationPartsRequest - Import documentation parts from an external (e.g., OpenAPI) definition file.

Returns:

Result of the ImportDocumentationParts operation returned by the service.

importDocumentationParts

default ImportDocumentationPartsResponse importDocumentationParts(Consumer<ImportDocumentationPartsRequest.Builder> importDocumentationPartsRequest)
                                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Imports documentation parts

This is a convenience which creates an instance of the ImportDocumentationPartsRequest.Builder avoiding the need to create one manually via ImportDocumentationPartsRequest.builder()

Parameters:

importDocumentationPartsRequest - A Consumer that will call methods on ImportDocumentationPartsRequest.Builder to create a request. Import documentation parts from an external (e.g., OpenAPI) definition file.

Returns:

Result of the ImportDocumentationParts operation returned by the service.

importRestApi

default ImportRestApiResponse importRestApi(ImportRestApiRequest importRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

A feature of the API Gateway control service for creating a new API from an external API definition file.

Parameters:

importRestApiRequest - A POST request to import an API to API Gateway using an input of an API definition file.

Returns:

Result of the ImportRestApi operation returned by the service.

importRestApi

default ImportRestApiResponse importRestApi(Consumer<ImportRestApiRequest.Builder> importRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

A feature of the API Gateway control service for creating a new API from an external API definition file.

This is a convenience which creates an instance of the ImportRestApiRequest.Builder avoiding the need to create one manually via ImportRestApiRequest.builder()

Parameters:

importRestApiRequest - A Consumer that will call methods on ImportRestApiRequest.Builder to create a request. A POST request to import an API to API Gateway using an input of an API definition file.

Returns:

Result of the ImportRestApi operation returned by the service.

putGatewayResponse

default PutGatewayResponseResponse putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Parameters:

putGatewayResponseRequest - Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Returns:

Result of the PutGatewayResponse operation returned by the service.

putGatewayResponse

default PutGatewayResponseResponse putGatewayResponse(Consumer<PutGatewayResponseRequest.Builder> putGatewayResponseRequest)
                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

This is a convenience which creates an instance of the PutGatewayResponseRequest.Builder avoiding the need to create one manually via PutGatewayResponseRequest.builder()

Parameters:

putGatewayResponseRequest - A Consumer that will call methods on PutGatewayResponseRequest.Builder to create a request. Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Returns:

Result of the PutGatewayResponse operation returned by the service.

putIntegration

default PutIntegrationResponse putIntegration(PutIntegrationRequest putIntegrationRequest)
                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Sets up a method's integration.

Parameters:

putIntegrationRequest - Sets up a method's integration.

Returns:

Result of the PutIntegration operation returned by the service.

putIntegration

default PutIntegrationResponse putIntegration(Consumer<PutIntegrationRequest.Builder> putIntegrationRequest)
                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Sets up a method's integration.

This is a convenience which creates an instance of the PutIntegrationRequest.Builder avoiding the need to create one manually via PutIntegrationRequest.builder()

Parameters:

putIntegrationRequest - A Consumer that will call methods on PutIntegrationRequest.Builder to create a request. Sets up a method's integration.

Returns:

Result of the PutIntegration operation returned by the service.

putIntegrationResponse

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

Represents a put integration.

Parameters:

putIntegrationResponseRequest - Represents a put integration response request.

Returns:

Result of the PutIntegrationResponse operation returned by the service.

putIntegrationResponse

default PutIntegrationResponseResponse putIntegrationResponse(Consumer<PutIntegrationResponseRequest.Builder> putIntegrationResponseRequest)
                                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents a put integration.

This is a convenience which creates an instance of the PutIntegrationResponseRequest.Builder avoiding the need to create one manually via PutIntegrationResponseRequest.builder()

Parameters:

putIntegrationResponseRequest - A Consumer that will call methods on PutIntegrationResponseRequest.Builder to create a request. Represents a put integration response request.

Returns:

Result of the PutIntegrationResponse operation returned by the service.

putMethod

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

Add a method to an existing Resource resource.

Parameters:

putMethodRequest - Request to add a method to an existing Resource resource.

Returns:

Result of the PutMethod operation returned by the service.

putMethod

default PutMethodResponse putMethod(Consumer<PutMethodRequest.Builder> putMethodRequest)
                             throws BadRequestException,
UnauthorizedException,
NotFoundException,
ConflictException,
LimitExceededException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Add a method to an existing Resource resource.

This is a convenience which creates an instance of the PutMethodRequest.Builder avoiding the need to create one manually via PutMethodRequest.builder()

Parameters:

putMethodRequest - A Consumer that will call methods on PutMethodRequest.Builder to create a request. Request to add a method to an existing Resource resource.

Returns:

Result of the PutMethod operation returned by the service.

putMethodResponse

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

Adds a MethodResponse to an existing Method resource.

Parameters:

putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.

Returns:

Result of the PutMethodResponse operation returned by the service.

putMethodResponse

default PutMethodResponseResponse putMethodResponse(Consumer<PutMethodResponseRequest.Builder> putMethodResponseRequest)
                                             throws UnauthorizedException,
NotFoundException,
ConflictException,
LimitExceededException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Adds a MethodResponse to an existing Method resource.

This is a convenience which creates an instance of the PutMethodResponseRequest.Builder avoiding the need to create one manually via PutMethodResponseRequest.builder()

Parameters:

putMethodResponseRequest - A Consumer that will call methods on PutMethodResponseRequest.Builder to create a request. Request to add a MethodResponse to an existing Method resource.

Returns:

Result of the PutMethodResponse operation returned by the service.

putRestApi

default PutRestApiResponse putRestApi(PutRestApiRequest putRestApiRequest)
                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Parameters:

putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.

Returns:

Result of the PutRestApi operation returned by the service.

putRestApi

default PutRestApiResponse putRestApi(Consumer<PutRestApiRequest.Builder> putRestApiRequest)
                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

This is a convenience which creates an instance of the PutRestApiRequest.Builder avoiding the need to create one manually via PutRestApiRequest.builder()

Parameters:

putRestApiRequest - A Consumer that will call methods on PutRestApiRequest.Builder to create a request. A PUT request to update an existing API, with external API definitions specified as the request body.

Returns:

Result of the PutRestApi operation returned by the service.

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Adds or updates a tag on a given resource.

Parameters:

tagResourceRequest - Adds or updates a tag on a given resource.

Returns:

Result of the TagResource operation returned by the service.

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Adds or updates a tag on a given resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Adds or updates a tag on a given resource.

Returns:

Result of the TagResource operation returned by the service.

testInvokeAuthorizer

default TestInvokeAuthorizerResponse testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
                                                   throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Parameters:

testInvokeAuthorizerRequest - Make a request to simulate the invocation of an Authorizer.

Returns:

Result of the TestInvokeAuthorizer operation returned by the service.

testInvokeAuthorizer

default TestInvokeAuthorizerResponse testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest)
                                                   throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

This is a convenience which creates an instance of the TestInvokeAuthorizerRequest.Builder avoiding the need to create one manually via TestInvokeAuthorizerRequest.builder()

Parameters:

testInvokeAuthorizerRequest - A Consumer that will call methods on TestInvokeAuthorizerRequest.Builder to create a request. Make a request to simulate the invocation of an Authorizer.

Returns:

Result of the TestInvokeAuthorizer operation returned by the service.

testInvokeMethod

default TestInvokeMethodResponse testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
                                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

Parameters:

testInvokeMethodRequest - Make a request to simulate the invocation of a Method.

Returns:

Result of the TestInvokeMethod operation returned by the service.

testInvokeMethod

default TestInvokeMethodResponse testInvokeMethod(Consumer<TestInvokeMethodRequest.Builder> testInvokeMethodRequest)
                                           throws BadRequestException,
UnauthorizedException,
NotFoundException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

This is a convenience which creates an instance of the TestInvokeMethodRequest.Builder avoiding the need to create one manually via TestInvokeMethodRequest.builder()

Parameters:

testInvokeMethodRequest - A Consumer that will call methods on TestInvokeMethodRequest.Builder to create a request. Make a request to simulate the invocation of a Method.

Returns:

Result of the TestInvokeMethod operation returned by the service.

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Removes a tag from a given resource.

Parameters:

untagResourceRequest - Removes a tag from a given resource.

Returns:

Result of the UntagResource operation returned by the service.

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Removes a tag from a given resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. Removes a tag from a given resource.

Returns:

Result of the UntagResource operation returned by the service.

updateAccount

default UpdateAccountResponse updateAccount(UpdateAccountRequest updateAccountRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the current Account resource.

Parameters:

updateAccountRequest - Requests API Gateway to change information about the current Account resource.

Returns:

Result of the UpdateAccount operation returned by the service.

updateAccount

default UpdateAccountResponse updateAccount(Consumer<UpdateAccountRequest.Builder> updateAccountRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the current Account resource.

This is a convenience which creates an instance of the UpdateAccountRequest.Builder avoiding the need to create one manually via UpdateAccountRequest.builder()

Parameters:

updateAccountRequest - A Consumer that will call methods on UpdateAccountRequest.Builder to create a request. Requests API Gateway to change information about the current Account resource.

Returns:

Result of the UpdateAccount operation returned by the service.

updateApiKey

default UpdateApiKeyResponse updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
                                   throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about an ApiKey resource.

Parameters:

updateApiKeyRequest - A request to change information about an ApiKey resource.

Returns:

Result of the UpdateApiKey operation returned by the service.

updateApiKey

default UpdateApiKeyResponse updateApiKey(Consumer<UpdateApiKeyRequest.Builder> updateApiKeyRequest)
                                   throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about an ApiKey resource.

This is a convenience which creates an instance of the UpdateApiKeyRequest.Builder avoiding the need to create one manually via UpdateApiKeyRequest.builder()

Parameters:

updateApiKeyRequest - A Consumer that will call methods on UpdateApiKeyRequest.Builder to create a request. A request to change information about an ApiKey resource.

Returns:

Result of the UpdateApiKey operation returned by the service.

updateAuthorizer

default UpdateAuthorizerResponse updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing Authorizer resource.

Parameters:

updateAuthorizerRequest - Request to update an existing Authorizer resource.

Returns:

Result of the UpdateAuthorizer operation returned by the service.

updateAuthorizer

default UpdateAuthorizerResponse updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing Authorizer resource.

This is a convenience which creates an instance of the UpdateAuthorizerRequest.Builder avoiding the need to create one manually via UpdateAuthorizerRequest.builder()

Parameters:

updateAuthorizerRequest - A Consumer that will call methods on UpdateAuthorizerRequest.Builder to create a request. Request to update an existing Authorizer resource.

Returns:

Result of the UpdateAuthorizer operation returned by the service.

updateBasePathMapping

default UpdateBasePathMappingResponse updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the BasePathMapping resource.

Parameters:

updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.

Returns:

Result of the UpdateBasePathMapping operation returned by the service.

updateBasePathMapping

default UpdateBasePathMappingResponse updateBasePathMapping(Consumer<UpdateBasePathMappingRequest.Builder> updateBasePathMappingRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the BasePathMapping resource.

This is a convenience which creates an instance of the UpdateBasePathMappingRequest.Builder avoiding the need to create one manually via UpdateBasePathMappingRequest.builder()

Parameters:

updateBasePathMappingRequest - A Consumer that will call methods on UpdateBasePathMappingRequest.Builder to create a request. A request to change information about the BasePathMapping resource.

Returns:

Result of the UpdateBasePathMapping operation returned by the service.

updateClientCertificate

default UpdateClientCertificateResponse updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
                                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about an ClientCertificate resource.

Parameters:

updateClientCertificateRequest - A request to change information about an ClientCertificate resource.

Returns:

Result of the UpdateClientCertificate operation returned by the service.

updateClientCertificate

default UpdateClientCertificateResponse updateClientCertificate(Consumer<UpdateClientCertificateRequest.Builder> updateClientCertificateRequest)
                                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about an ClientCertificate resource.

This is a convenience which creates an instance of the UpdateClientCertificateRequest.Builder avoiding the need to create one manually via UpdateClientCertificateRequest.builder()

Parameters:

updateClientCertificateRequest - A Consumer that will call methods on UpdateClientCertificateRequest.Builder to create a request. A request to change information about an ClientCertificate resource.

Returns:

Result of the UpdateClientCertificate operation returned by the service.

updateDeployment

default UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Deployment resource.

Parameters:

updateDeploymentRequest - Requests API Gateway to change information about a Deployment resource.

Returns:

Result of the UpdateDeployment operation returned by the service.

updateDeployment

default UpdateDeploymentResponse updateDeployment(Consumer<UpdateDeploymentRequest.Builder> updateDeploymentRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Deployment resource.

This is a convenience which creates an instance of the UpdateDeploymentRequest.Builder avoiding the need to create one manually via UpdateDeploymentRequest.builder()

Parameters:

updateDeploymentRequest - A Consumer that will call methods on UpdateDeploymentRequest.Builder to create a request. Requests API Gateway to change information about a Deployment resource.

Returns:

Result of the UpdateDeployment operation returned by the service.

updateDocumentationPart

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

Updates a documentation part.

Parameters:

updateDocumentationPartRequest - Updates an existing documentation part of a given API.

Returns:

Result of the UpdateDocumentationPart operation returned by the service.

updateDocumentationPart

default UpdateDocumentationPartResponse updateDocumentationPart(Consumer<UpdateDocumentationPartRequest.Builder> updateDocumentationPartRequest)
                                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a documentation part.

This is a convenience which creates an instance of the UpdateDocumentationPartRequest.Builder avoiding the need to create one manually via UpdateDocumentationPartRequest.builder()

Parameters:

updateDocumentationPartRequest - A Consumer that will call methods on UpdateDocumentationPartRequest.Builder to create a request. Updates an existing documentation part of a given API.

Returns:

Result of the UpdateDocumentationPart operation returned by the service.

updateDocumentationVersion

default UpdateDocumentationVersionResponse updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
                                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a documentation version.

Parameters:

updateDocumentationVersionRequest - Updates an existing documentation version of an API.

Returns:

Result of the UpdateDocumentationVersion operation returned by the service.

updateDocumentationVersion

default UpdateDocumentationVersionResponse updateDocumentationVersion(Consumer<UpdateDocumentationVersionRequest.Builder> updateDocumentationVersionRequest)
                                                               throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a documentation version.

This is a convenience which creates an instance of the UpdateDocumentationVersionRequest.Builder avoiding the need to create one manually via UpdateDocumentationVersionRequest.builder()

Parameters:

updateDocumentationVersionRequest - A Consumer that will call methods on UpdateDocumentationVersionRequest.Builder to create a request. Updates an existing documentation version of an API.

Returns:

Result of the UpdateDocumentationVersion operation returned by the service.

updateDomainName

default UpdateDomainNameResponse updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the DomainName resource.

Parameters:

updateDomainNameRequest - A request to change information about the DomainName resource.

Returns:

Result of the UpdateDomainName operation returned by the service.

updateDomainName

default UpdateDomainNameResponse updateDomainName(Consumer<UpdateDomainNameRequest.Builder> updateDomainNameRequest)
                                           throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the DomainName resource.

This is a convenience which creates an instance of the UpdateDomainNameRequest.Builder avoiding the need to create one manually via UpdateDomainNameRequest.builder()

Parameters:

updateDomainNameRequest - A Consumer that will call methods on UpdateDomainNameRequest.Builder to create a request. A request to change information about the DomainName resource.

Returns:

Result of the UpdateDomainName operation returned by the service.

updateGatewayResponse

default UpdateGatewayResponseResponse updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a GatewayResponse of a specified response type on the given RestApi.

Parameters:

updateGatewayResponseRequest - Updates a GatewayResponse of a specified response type on the given RestApi.

Returns:

Result of the UpdateGatewayResponse operation returned by the service.

updateGatewayResponse

default UpdateGatewayResponseResponse updateGatewayResponse(Consumer<UpdateGatewayResponseRequest.Builder> updateGatewayResponseRequest)
                                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a GatewayResponse of a specified response type on the given RestApi.

This is a convenience which creates an instance of the UpdateGatewayResponseRequest.Builder avoiding the need to create one manually via UpdateGatewayResponseRequest.builder()

Parameters:

updateGatewayResponseRequest - A Consumer that will call methods on UpdateGatewayResponseRequest.Builder to create a request. Updates a GatewayResponse of a specified response type on the given RestApi.

Returns:

Result of the UpdateGatewayResponse operation returned by the service.

updateIntegration

default UpdateIntegrationResponse updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
                                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents an update integration.

Parameters:

updateIntegrationRequest - Represents an update integration request.

Returns:

Result of the UpdateIntegration operation returned by the service.

updateIntegration

default UpdateIntegrationResponse updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest)
                                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents an update integration.

This is a convenience which creates an instance of the UpdateIntegrationRequest.Builder avoiding the need to create one manually via UpdateIntegrationRequest.builder()

Parameters:

updateIntegrationRequest - A Consumer that will call methods on UpdateIntegrationRequest.Builder to create a request. Represents an update integration request.

Returns:

Result of the UpdateIntegration operation returned by the service.

updateIntegrationResponse

default UpdateIntegrationResponseResponse updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
                                                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents an update integration response.

Parameters:

updateIntegrationResponseRequest - Represents an update integration response request.

Returns:

Result of the UpdateIntegrationResponse operation returned by the service.

updateIntegrationResponse

default UpdateIntegrationResponseResponse updateIntegrationResponse(Consumer<UpdateIntegrationResponseRequest.Builder> updateIntegrationResponseRequest)
                                                             throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Represents an update integration response.

This is a convenience which creates an instance of the UpdateIntegrationResponseRequest.Builder avoiding the need to create one manually via UpdateIntegrationResponseRequest.builder()

Parameters:

updateIntegrationResponseRequest - A Consumer that will call methods on UpdateIntegrationResponseRequest.Builder to create a request. Represents an update integration response request.

Returns:

Result of the UpdateIntegrationResponse operation returned by the service.

updateMethod

default UpdateMethodResponse updateMethod(UpdateMethodRequest updateMethodRequest)
                                   throws UnauthorizedException,
NotFoundException,
BadRequestException,
ConflictException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing Method resource.

Parameters:

updateMethodRequest - Request to update an existing Method resource.

Returns:

Result of the UpdateMethod operation returned by the service.

updateMethod

default UpdateMethodResponse updateMethod(Consumer<UpdateMethodRequest.Builder> updateMethodRequest)
                                   throws UnauthorizedException,
NotFoundException,
BadRequestException,
ConflictException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing Method resource.

This is a convenience which creates an instance of the UpdateMethodRequest.Builder avoiding the need to create one manually via UpdateMethodRequest.builder()

Parameters:

updateMethodRequest - A Consumer that will call methods on UpdateMethodRequest.Builder to create a request. Request to update an existing Method resource.

Returns:

Result of the UpdateMethod operation returned by the service.

updateMethodResponse

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

Updates an existing MethodResponse resource.

Parameters:

updateMethodResponseRequest - A request to update an existing MethodResponse resource.

Returns:

Result of the UpdateMethodResponse operation returned by the service.

updateMethodResponse

default UpdateMethodResponseResponse updateMethodResponse(Consumer<UpdateMethodResponseRequest.Builder> updateMethodResponseRequest)
                                                   throws UnauthorizedException,
NotFoundException,
ConflictException,
LimitExceededException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing MethodResponse resource.

This is a convenience which creates an instance of the UpdateMethodResponseRequest.Builder avoiding the need to create one manually via UpdateMethodResponseRequest.builder()

Parameters:

updateMethodResponseRequest - A Consumer that will call methods on UpdateMethodResponseRequest.Builder to create a request. A request to update an existing MethodResponse resource.

Returns:

Result of the UpdateMethodResponse operation returned by the service.

updateModel

default UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a model. The maximum size of the model is 400 KB.

Parameters:

updateModelRequest - Request to update an existing model in an existing RestApi resource.

Returns:

Result of the UpdateModel operation returned by the service.

updateModel

default UpdateModelResponse updateModel(Consumer<UpdateModelRequest.Builder> updateModelRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a model. The maximum size of the model is 400 KB.

This is a convenience which creates an instance of the UpdateModelRequest.Builder avoiding the need to create one manually via UpdateModelRequest.builder()

Parameters:

updateModelRequest - A Consumer that will call methods on UpdateModelRequest.Builder to create a request. Request to update an existing model in an existing RestApi resource.

Returns:

Result of the UpdateModel operation returned by the service.

updateRequestValidator

default UpdateRequestValidatorResponse updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a RequestValidator of a given RestApi.

Parameters:

updateRequestValidatorRequest - Updates a RequestValidator of a given RestApi.

Returns:

Result of the UpdateRequestValidator operation returned by the service.

updateRequestValidator

default UpdateRequestValidatorResponse updateRequestValidator(Consumer<UpdateRequestValidatorRequest.Builder> updateRequestValidatorRequest)
                                                       throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a RequestValidator of a given RestApi.

This is a convenience which creates an instance of the UpdateRequestValidatorRequest.Builder avoiding the need to create one manually via UpdateRequestValidatorRequest.builder()

Parameters:

updateRequestValidatorRequest - A Consumer that will call methods on UpdateRequestValidatorRequest.Builder to create a request. Updates a RequestValidator of a given RestApi.

Returns:

Result of the UpdateRequestValidator operation returned by the service.

updateResource

default UpdateResourceResponse updateResource(UpdateResourceRequest updateResourceRequest)
                                       throws UnauthorizedException,
NotFoundException,
ConflictException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Resource resource.

Parameters:

updateResourceRequest - Request to change information about a Resource resource.

Returns:

Result of the UpdateResource operation returned by the service.

updateResource

default UpdateResourceResponse updateResource(Consumer<UpdateResourceRequest.Builder> updateResourceRequest)
                                       throws UnauthorizedException,
NotFoundException,
ConflictException,
BadRequestException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Resource resource.

This is a convenience which creates an instance of the UpdateResourceRequest.Builder avoiding the need to create one manually via UpdateResourceRequest.builder()

Parameters:

updateResourceRequest - A Consumer that will call methods on UpdateResourceRequest.Builder to create a request. Request to change information about a Resource resource.

Returns:

Result of the UpdateResource operation returned by the service.

updateRestApi

default UpdateRestApiResponse updateRestApi(UpdateRestApiRequest updateRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the specified API.

Parameters:

updateRestApiRequest - Request to update an existing RestApi resource in your collection.

Returns:

Result of the UpdateRestApi operation returned by the service.

updateRestApi

default UpdateRestApiResponse updateRestApi(Consumer<UpdateRestApiRequest.Builder> updateRestApiRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about the specified API.

This is a convenience which creates an instance of the UpdateRestApiRequest.Builder avoiding the need to create one manually via UpdateRestApiRequest.builder()

Parameters:

updateRestApiRequest - A Consumer that will call methods on UpdateRestApiRequest.Builder to create a request. Request to update an existing RestApi resource in your collection.

Returns:

Result of the UpdateRestApi operation returned by the service.

updateStage

default UpdateStageResponse updateStage(UpdateStageRequest updateStageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Stage resource.

Parameters:

updateStageRequest - Requests API Gateway to change information about a Stage resource.

Returns:

Result of the UpdateStage operation returned by the service.

updateStage

default UpdateStageResponse updateStage(Consumer<UpdateStageRequest.Builder> updateStageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Changes information about a Stage resource.

This is a convenience which creates an instance of the UpdateStageRequest.Builder avoiding the need to create one manually via UpdateStageRequest.builder()

Parameters:

updateStageRequest - A Consumer that will call methods on UpdateStageRequest.Builder to create a request. Requests API Gateway to change information about a Stage resource.

Returns:

Result of the UpdateStage operation returned by the service.

updateUsage

default UpdateUsageResponse updateUsage(UpdateUsageRequest updateUsageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Parameters:

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

Returns:

Result of the UpdateUsage operation returned by the service.

updateUsage

default UpdateUsageResponse updateUsage(Consumer<UpdateUsageRequest.Builder> updateUsageRequest)
                                 throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

This is a convenience which creates an instance of the UpdateUsageRequest.Builder avoiding the need to create one manually via UpdateUsageRequest.builder()

Parameters:

updateUsageRequest - A Consumer that will call methods on UpdateUsageRequest.Builder to create a request. The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Returns:

Result of the UpdateUsage operation returned by the service.

updateUsagePlan

default UpdateUsagePlanResponse updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a usage plan of a given plan Id.

Parameters:

updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.

Returns:

Result of the UpdateUsagePlan operation returned by the service.

updateUsagePlan

default UpdateUsagePlanResponse updateUsagePlan(Consumer<UpdateUsagePlanRequest.Builder> updateUsagePlanRequest)
                                         throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates a usage plan of a given plan Id.

This is a convenience which creates an instance of the UpdateUsagePlanRequest.Builder avoiding the need to create one manually via UpdateUsagePlanRequest.builder()

Parameters:

updateUsagePlanRequest - A Consumer that will call methods on UpdateUsagePlanRequest.Builder to create a request. The PATCH request to update a usage plan of a given plan Id.

Returns:

Result of the UpdateUsagePlan operation returned by the service.

updateVpcLink

default UpdateVpcLinkResponse updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing VpcLink of a specified identifier.

Parameters:

updateVpcLinkRequest - Updates an existing VpcLink of a specified identifier.

Returns:

Result of the UpdateVpcLink operation returned by the service.

updateVpcLink

default UpdateVpcLinkResponse updateVpcLink(Consumer<UpdateVpcLinkRequest.Builder> updateVpcLinkRequest)
                                     throws BadRequestException,
ConflictException,
LimitExceededException,
NotFoundException,
UnauthorizedException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ApiGatewayException

Updates an existing VpcLink of a specified identifier.

This is a convenience which creates an instance of the UpdateVpcLinkRequest.Builder avoiding the need to create one manually via UpdateVpcLinkRequest.builder()

Parameters:

updateVpcLinkRequest - A Consumer that will call methods on UpdateVpcLinkRequest.Builder to create a request. Updates an existing VpcLink of a specified identifier.

Returns:

Result of the UpdateVpcLink operation returned by the service.

create

static ApiGatewayClient create()

Create a ApiGatewayClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ApiGatewayClientBuilder builder()

Create a builder that can be used to configure and create a ApiGatewayClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ApiGatewayServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration