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