@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonApiGatewayAsync extends AmazonApiGateway
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonApiGatewayAsync
instead.
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.
ENDPOINT_PREFIX
createApiKey, createAuthorizer, createBasePathMapping, createDeployment, createDocumentationPart, createDocumentationVersion, createDomainName, createModel, createRequestValidator, createResource, createRestApi, createStage, createUsagePlan, createUsagePlanKey, createVpcLink, deleteApiKey, deleteAuthorizer, deleteBasePathMapping, deleteClientCertificate, deleteDeployment, deleteDocumentationPart, deleteDocumentationVersion, deleteDomainName, deleteGatewayResponse, deleteIntegration, deleteIntegrationResponse, deleteMethod, deleteMethodResponse, deleteModel, deleteRequestValidator, deleteResource, deleteRestApi, deleteStage, deleteUsagePlan, deleteUsagePlanKey, deleteVpcLink, flushStageAuthorizersCache, flushStageCache, generateClientCertificate, getAccount, getApiKey, getApiKeys, getAuthorizer, getAuthorizers, getBasePathMapping, getBasePathMappings, getCachedResponseMetadata, getClientCertificate, getClientCertificates, getDeployment, getDeployments, getDocumentationPart, getDocumentationParts, getDocumentationVersion, getDocumentationVersions, getDomainName, getDomainNames, getExport, getGatewayResponse, getGatewayResponses, getIntegration, getIntegrationResponse, getMethod, getMethodResponse, getModel, getModels, getModelTemplate, getRequestValidator, getRequestValidators, getResource, getResources, getRestApi, getRestApis, getSdk, getSdkType, getSdkTypes, getStage, getStages, getTags, getUsage, getUsagePlan, getUsagePlanKey, getUsagePlanKeys, getUsagePlans, getVpcLink, getVpcLinks, importApiKeys, importDocumentationParts, importRestApi, putGatewayResponse, putIntegration, putIntegrationResponse, putMethod, putMethodResponse, putRestApi, setEndpoint, setRegion, shutdown, tagResource, testInvokeAuthorizer, testInvokeMethod, untagResource, updateAccount, updateApiKey, updateAuthorizer, updateBasePathMapping, updateClientCertificate, updateDeployment, updateDocumentationPart, updateDocumentationVersion, updateDomainName, updateGatewayResponse, updateIntegration, updateIntegrationResponse, updateMethod, updateMethodResponse, updateModel, updateRequestValidator, updateResource, updateRestApi, updateStage, updateUsage, updateUsagePlan, updateVpcLink
Future<CreateApiKeyResult> createApiKeyAsync(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
createApiKeyRequest
- Request to create an ApiKey resource.Future<CreateApiKeyResult> createApiKeyAsync(CreateApiKeyRequest createApiKeyRequest, AsyncHandler<CreateApiKeyRequest,CreateApiKeyResult> asyncHandler)
Create an ApiKey resource.
createApiKeyRequest
- Request to create an ApiKey resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAuthorizerResult> createAuthorizerAsync(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizerRequest
- Request to add a new Authorizer to an existing RestApi resource.Future<CreateAuthorizerResult> createAuthorizerAsync(CreateAuthorizerRequest createAuthorizerRequest, AsyncHandler<CreateAuthorizerRequest,CreateAuthorizerResult> asyncHandler)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizerRequest
- Request to add a new Authorizer to an existing RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBasePathMappingResult> createBasePathMappingAsync(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
createBasePathMappingRequest
- Requests API Gateway to create a new BasePathMapping resource.Future<CreateBasePathMappingResult> createBasePathMappingAsync(CreateBasePathMappingRequest createBasePathMappingRequest, AsyncHandler<CreateBasePathMappingRequest,CreateBasePathMappingResult> asyncHandler)
Creates a new BasePathMapping resource.
createBasePathMappingRequest
- Requests API Gateway to create a new BasePathMapping resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeploymentRequest
- Requests API Gateway to create a Deployment resource.Future<CreateDeploymentResult> createDeploymentAsync(CreateDeploymentRequest createDeploymentRequest, AsyncHandler<CreateDeploymentRequest,CreateDeploymentResult> asyncHandler)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeploymentRequest
- Requests API Gateway to create a Deployment resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDocumentationPartResult> createDocumentationPartAsync(CreateDocumentationPartRequest createDocumentationPartRequest)
Creates a documentation part.
createDocumentationPartRequest
- Creates a new documentation part of a given API.Future<CreateDocumentationPartResult> createDocumentationPartAsync(CreateDocumentationPartRequest createDocumentationPartRequest, AsyncHandler<CreateDocumentationPartRequest,CreateDocumentationPartResult> asyncHandler)
Creates a documentation part.
createDocumentationPartRequest
- Creates a new documentation part of a given API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDocumentationVersionResult> createDocumentationVersionAsync(CreateDocumentationVersionRequest createDocumentationVersionRequest)
Creates a documentation version
createDocumentationVersionRequest
- Creates a new documentation version of a given API.Future<CreateDocumentationVersionResult> createDocumentationVersionAsync(CreateDocumentationVersionRequest createDocumentationVersionRequest, AsyncHandler<CreateDocumentationVersionRequest,CreateDocumentationVersionResult> asyncHandler)
Creates a documentation version
createDocumentationVersionRequest
- Creates a new documentation version of a given API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDomainNameResult> createDomainNameAsync(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
createDomainNameRequest
- A request to create a new domain name.Future<CreateDomainNameResult> createDomainNameAsync(CreateDomainNameRequest createDomainNameRequest, AsyncHandler<CreateDomainNameRequest,CreateDomainNameResult> asyncHandler)
Creates a new domain name.
createDomainNameRequest
- A request to create a new domain name.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateModelResult> createModelAsync(CreateModelRequest createModelRequest)
Adds a new Model resource to an existing RestApi resource.
createModelRequest
- Request to add a new Model to an existing RestApi resource.Future<CreateModelResult> createModelAsync(CreateModelRequest createModelRequest, AsyncHandler<CreateModelRequest,CreateModelResult> asyncHandler)
Adds a new Model resource to an existing RestApi resource.
createModelRequest
- Request to add a new Model to an existing RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRequestValidatorResult> createRequestValidatorAsync(CreateRequestValidatorRequest createRequestValidatorRequest)
Creates a RequestValidator of a given RestApi.
createRequestValidatorRequest
- Creates a RequestValidator of a given RestApi.Future<CreateRequestValidatorResult> createRequestValidatorAsync(CreateRequestValidatorRequest createRequestValidatorRequest, AsyncHandler<CreateRequestValidatorRequest,CreateRequestValidatorResult> asyncHandler)
Creates a RequestValidator of a given RestApi.
createRequestValidatorRequest
- Creates a RequestValidator of a given RestApi.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
createResourceRequest
- Requests API Gateway to create a Resource resource.Future<CreateResourceResult> createResourceAsync(CreateResourceRequest createResourceRequest, AsyncHandler<CreateResourceRequest,CreateResourceResult> asyncHandler)
Creates a Resource resource.
createResourceRequest
- Requests API Gateway to create a Resource resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRestApiResult> createRestApiAsync(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
createRestApiRequest
- The POST Request to add a new RestApi resource to your collection.Future<CreateRestApiResult> createRestApiAsync(CreateRestApiRequest createRestApiRequest, AsyncHandler<CreateRestApiRequest,CreateRestApiResult> asyncHandler)
Creates a new RestApi resource.
createRestApiRequest
- The POST Request to add a new RestApi resource to your collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStageRequest
- Requests API Gateway to create a Stage resource.Future<CreateStageResult> createStageAsync(CreateStageRequest createStageRequest, AsyncHandler<CreateStageRequest,CreateStageResult> asyncHandler)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStageRequest
- Requests API Gateway to create a Stage resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUsagePlanResult> createUsagePlanAsync(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.Future<CreateUsagePlanResult> createUsagePlanAsync(CreateUsagePlanRequest createUsagePlanRequest, AsyncHandler<CreateUsagePlanRequest,CreateUsagePlanResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateUsagePlanKeyResult> createUsagePlanKeyAsync(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.Future<CreateUsagePlanKeyResult> createUsagePlanKeyAsync(CreateUsagePlanKeyRequest createUsagePlanKeyRequest, AsyncHandler<CreateUsagePlanKeyRequest,CreateUsagePlanKeyResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVpcLinkResult> createVpcLinkAsync(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. The caller must have permissions to create and update VPC Endpoint services.
createVpcLinkRequest
- Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.Future<CreateVpcLinkResult> createVpcLinkAsync(CreateVpcLinkRequest createVpcLinkRequest, AsyncHandler<CreateVpcLinkRequest,CreateVpcLinkResult> asyncHandler)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
createVpcLinkRequest
- Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteApiKeyResult> deleteApiKeyAsync(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
deleteApiKeyRequest
- A request to delete the ApiKey resource.Future<DeleteApiKeyResult> deleteApiKeyAsync(DeleteApiKeyRequest deleteApiKeyRequest, AsyncHandler<DeleteApiKeyRequest,DeleteApiKeyResult> asyncHandler)
Deletes the ApiKey resource.
deleteApiKeyRequest
- A request to delete the ApiKey resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAuthorizerResult> deleteAuthorizerAsync(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.Future<DeleteAuthorizerResult> deleteAuthorizerAsync(DeleteAuthorizerRequest deleteAuthorizerRequest, AsyncHandler<DeleteAuthorizerRequest,DeleteAuthorizerResult> asyncHandler)
Deletes an existing Authorizer resource.
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBasePathMappingResult> deleteBasePathMappingAsync(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.Future<DeleteBasePathMappingResult> deleteBasePathMappingAsync(DeleteBasePathMappingRequest deleteBasePathMappingRequest, AsyncHandler<DeleteBasePathMappingRequest,DeleteBasePathMappingResult> asyncHandler)
Deletes the BasePathMapping resource.
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteClientCertificateResult> deleteClientCertificateAsync(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.Future<DeleteClientCertificateResult> deleteClientCertificateAsync(DeleteClientCertificateRequest deleteClientCertificateRequest, AsyncHandler<DeleteClientCertificateRequest,DeleteClientCertificateResult> asyncHandler)
Deletes the ClientCertificate resource.
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDeploymentResult> deleteDeploymentAsync(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeploymentRequest
- Requests API Gateway to delete a Deployment resource.Future<DeleteDeploymentResult> deleteDeploymentAsync(DeleteDeploymentRequest deleteDeploymentRequest, AsyncHandler<DeleteDeploymentRequest,DeleteDeploymentResult> asyncHandler)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeploymentRequest
- Requests API Gateway to delete a Deployment resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDocumentationPartResult> deleteDocumentationPartAsync(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
Deletes a documentation part
deleteDocumentationPartRequest
- Deletes an existing documentation part of an API.Future<DeleteDocumentationPartResult> deleteDocumentationPartAsync(DeleteDocumentationPartRequest deleteDocumentationPartRequest, AsyncHandler<DeleteDocumentationPartRequest,DeleteDocumentationPartResult> asyncHandler)
Deletes a documentation part
deleteDocumentationPartRequest
- Deletes an existing documentation part of an API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDocumentationVersionResult> deleteDocumentationVersionAsync(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
Deletes a documentation version.
deleteDocumentationVersionRequest
- Deletes an existing documentation version of an API.Future<DeleteDocumentationVersionResult> deleteDocumentationVersionAsync(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest, AsyncHandler<DeleteDocumentationVersionRequest,DeleteDocumentationVersionResult> asyncHandler)
Deletes a documentation version.
deleteDocumentationVersionRequest
- Deletes an existing documentation version of an API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDomainNameResult> deleteDomainNameAsync(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
deleteDomainNameRequest
- A request to delete the DomainName resource.Future<DeleteDomainNameResult> deleteDomainNameAsync(DeleteDomainNameRequest deleteDomainNameRequest, AsyncHandler<DeleteDomainNameRequest,DeleteDomainNameResult> asyncHandler)
Deletes the DomainName resource.
deleteDomainNameRequest
- A request to delete the DomainName resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteGatewayResponseResult> deleteGatewayResponseAsync(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.Future<DeleteGatewayResponseResult> deleteGatewayResponseAsync(DeleteGatewayResponseRequest deleteGatewayResponseRequest, AsyncHandler<DeleteGatewayResponseRequest,DeleteGatewayResponseResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
deleteIntegrationRequest
- Represents a delete integration request.Future<DeleteIntegrationResult> deleteIntegrationAsync(DeleteIntegrationRequest deleteIntegrationRequest, AsyncHandler<DeleteIntegrationRequest,DeleteIntegrationResult> asyncHandler)
Represents a delete integration.
deleteIntegrationRequest
- Represents a delete integration request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteIntegrationResponseResult> deleteIntegrationResponseAsync(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
deleteIntegrationResponseRequest
- Represents a delete integration response request.Future<DeleteIntegrationResponseResult> deleteIntegrationResponseAsync(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest, AsyncHandler<DeleteIntegrationResponseRequest,DeleteIntegrationResponseResult> asyncHandler)
Represents a delete integration response.
deleteIntegrationResponseRequest
- Represents a delete integration response request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMethodResult> deleteMethodAsync(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
deleteMethodRequest
- Request to delete an existing Method resource.Future<DeleteMethodResult> deleteMethodAsync(DeleteMethodRequest deleteMethodRequest, AsyncHandler<DeleteMethodRequest,DeleteMethodResult> asyncHandler)
Deletes an existing Method resource.
deleteMethodRequest
- Request to delete an existing Method resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMethodResponseResult> deleteMethodResponseAsync(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.Future<DeleteMethodResponseResult> deleteMethodResponseAsync(DeleteMethodResponseRequest deleteMethodResponseRequest, AsyncHandler<DeleteMethodResponseRequest,DeleteMethodResponseResult> asyncHandler)
Deletes an existing MethodResponse resource.
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteModelResult> deleteModelAsync(DeleteModelRequest deleteModelRequest)
Deletes a model.
deleteModelRequest
- Request to delete an existing model in an existing RestApi resource.Future<DeleteModelResult> deleteModelAsync(DeleteModelRequest deleteModelRequest, AsyncHandler<DeleteModelRequest,DeleteModelResult> asyncHandler)
Deletes a model.
deleteModelRequest
- Request to delete an existing model in an existing RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRequestValidatorResult> deleteRequestValidatorAsync(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
deleteRequestValidatorRequest
- Deletes a specified RequestValidator of a given RestApi.Future<DeleteRequestValidatorResult> deleteRequestValidatorAsync(DeleteRequestValidatorRequest deleteRequestValidatorRequest, AsyncHandler<DeleteRequestValidatorRequest,DeleteRequestValidatorResult> asyncHandler)
Deletes a RequestValidator of a given RestApi.
deleteRequestValidatorRequest
- Deletes a specified RequestValidator of a given RestApi.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
deleteResourceRequest
- Request to delete a Resource.Future<DeleteResourceResult> deleteResourceAsync(DeleteResourceRequest deleteResourceRequest, AsyncHandler<DeleteResourceRequest,DeleteResourceResult> asyncHandler)
Deletes a Resource resource.
deleteResourceRequest
- Request to delete a Resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRestApiResult> deleteRestApiAsync(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
deleteRestApiRequest
- Request to delete the specified API from your collection.Future<DeleteRestApiResult> deleteRestApiAsync(DeleteRestApiRequest deleteRestApiRequest, AsyncHandler<DeleteRestApiRequest,DeleteRestApiResult> asyncHandler)
Deletes the specified API.
deleteRestApiRequest
- Request to delete the specified API from your collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
deleteStageRequest
- Requests API Gateway to delete a Stage resource.Future<DeleteStageResult> deleteStageAsync(DeleteStageRequest deleteStageRequest, AsyncHandler<DeleteStageRequest,DeleteStageResult> asyncHandler)
Deletes a Stage resource.
deleteStageRequest
- Requests API Gateway to delete a Stage resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUsagePlanResult> deleteUsagePlanAsync(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.Future<DeleteUsagePlanResult> deleteUsagePlanAsync(DeleteUsagePlanRequest deleteUsagePlanRequest, AsyncHandler<DeleteUsagePlanRequest,DeleteUsagePlanResult> asyncHandler)
Deletes a usage plan of a given plan Id.
deleteUsagePlanRequest
- The DELETE request to delete a usage plan of a given plan Id.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteUsagePlanKeyResult> deleteUsagePlanKeyAsync(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.Future<DeleteUsagePlanKeyResult> deleteUsagePlanKeyAsync(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest, AsyncHandler<DeleteUsagePlanKeyRequest,DeleteUsagePlanKeyResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVpcLinkResult> deleteVpcLinkAsync(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
deleteVpcLinkRequest
- Deletes an existing VpcLink of a specified identifier.Future<DeleteVpcLinkResult> deleteVpcLinkAsync(DeleteVpcLinkRequest deleteVpcLinkRequest, AsyncHandler<DeleteVpcLinkRequest,DeleteVpcLinkResult> asyncHandler)
Deletes an existing VpcLink of a specified identifier.
deleteVpcLinkRequest
- Deletes an existing VpcLink of a specified identifier.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<FlushStageAuthorizersCacheResult> flushStageAuthorizersCacheAsync(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCacheRequest
- Request to flush authorizer cache entries on a specified stage.Future<FlushStageAuthorizersCacheResult> flushStageAuthorizersCacheAsync(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest, AsyncHandler<FlushStageAuthorizersCacheRequest,FlushStageAuthorizersCacheResult> asyncHandler)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCacheRequest
- Request to flush authorizer cache entries on a specified stage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<FlushStageCacheResult> flushStageCacheAsync(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
flushStageCacheRequest
- Requests API Gateway to flush a stage's cache.Future<FlushStageCacheResult> flushStageCacheAsync(FlushStageCacheRequest flushStageCacheRequest, AsyncHandler<FlushStageCacheRequest,FlushStageCacheResult> asyncHandler)
Flushes a stage's cache.
flushStageCacheRequest
- Requests API Gateway to flush a stage's cache.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GenerateClientCertificateResult> generateClientCertificateAsync(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.Future<GenerateClientCertificateResult> generateClientCertificateAsync(GenerateClientCertificateRequest generateClientCertificateRequest, AsyncHandler<GenerateClientCertificateRequest,GenerateClientCertificateResult> asyncHandler)
Generates a ClientCertificate resource.
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAccountResult> getAccountAsync(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
getAccountRequest
- Requests API Gateway to get information about the current Account resource.Future<GetAccountResult> getAccountAsync(GetAccountRequest getAccountRequest, AsyncHandler<GetAccountRequest,GetAccountResult> asyncHandler)
Gets information about the current Account resource.
getAccountRequest
- Requests API Gateway to get information about the current Account resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApiKeyResult> getApiKeyAsync(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
getApiKeyRequest
- A request to get information about the current ApiKey resource.Future<GetApiKeyResult> getApiKeyAsync(GetApiKeyRequest getApiKeyRequest, AsyncHandler<GetApiKeyRequest,GetApiKeyResult> asyncHandler)
Gets information about the current ApiKey resource.
getApiKeyRequest
- A request to get information about the current ApiKey resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApiKeysResult> getApiKeysAsync(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
getApiKeysRequest
- A request to get information about the current ApiKeys resource.Future<GetApiKeysResult> getApiKeysAsync(GetApiKeysRequest getApiKeysRequest, AsyncHandler<GetApiKeysRequest,GetApiKeysResult> asyncHandler)
Gets information about the current ApiKeys resource.
getApiKeysRequest
- A request to get information about the current ApiKeys resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAuthorizerResult> getAuthorizerAsync(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
getAuthorizerRequest
- Request to describe an existing Authorizer resource.Future<GetAuthorizerResult> getAuthorizerAsync(GetAuthorizerRequest getAuthorizerRequest, AsyncHandler<GetAuthorizerRequest,GetAuthorizerResult> asyncHandler)
Describe an existing Authorizer resource.
getAuthorizerRequest
- Request to describe an existing Authorizer resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAuthorizersResult> getAuthorizersAsync(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
getAuthorizersRequest
- Request to describe an existing Authorizers resource.Future<GetAuthorizersResult> getAuthorizersAsync(GetAuthorizersRequest getAuthorizersRequest, AsyncHandler<GetAuthorizersRequest,GetAuthorizersResult> asyncHandler)
Describe an existing Authorizers resource.
getAuthorizersRequest
- Request to describe an existing Authorizers resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBasePathMappingResult> getBasePathMappingAsync(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.Future<GetBasePathMappingResult> getBasePathMappingAsync(GetBasePathMappingRequest getBasePathMappingRequest, AsyncHandler<GetBasePathMappingRequest,GetBasePathMappingResult> asyncHandler)
Describe a BasePathMapping resource.
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBasePathMappingsResult> getBasePathMappingsAsync(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
getBasePathMappingsRequest
- A request to get information about a collection of BasePathMapping resources.Future<GetBasePathMappingsResult> getBasePathMappingsAsync(GetBasePathMappingsRequest getBasePathMappingsRequest, AsyncHandler<GetBasePathMappingsRequest,GetBasePathMappingsResult> asyncHandler)
Represents a collection of BasePathMapping resources.
getBasePathMappingsRequest
- A request to get information about a collection of BasePathMapping resources.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetClientCertificateResult> getClientCertificateAsync(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
getClientCertificateRequest
- A request to get information about the current ClientCertificate resource.Future<GetClientCertificateResult> getClientCertificateAsync(GetClientCertificateRequest getClientCertificateRequest, AsyncHandler<GetClientCertificateRequest,GetClientCertificateResult> asyncHandler)
Gets information about the current ClientCertificate resource.
getClientCertificateRequest
- A request to get information about the current ClientCertificate resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetClientCertificatesResult> getClientCertificatesAsync(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
getClientCertificatesRequest
- A request to get information about a collection of ClientCertificate resources.Future<GetClientCertificatesResult> getClientCertificatesAsync(GetClientCertificatesRequest getClientCertificatesRequest, AsyncHandler<GetClientCertificatesRequest,GetClientCertificatesResult> asyncHandler)
Gets a collection of ClientCertificate resources.
getClientCertificatesRequest
- A request to get information about a collection of ClientCertificate resources.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
getDeploymentRequest
- Requests API Gateway to get information about a Deployment resource.Future<GetDeploymentResult> getDeploymentAsync(GetDeploymentRequest getDeploymentRequest, AsyncHandler<GetDeploymentRequest,GetDeploymentResult> asyncHandler)
Gets information about a Deployment resource.
getDeploymentRequest
- Requests API Gateway to get information about a Deployment resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDeploymentsResult> getDeploymentsAsync(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
getDeploymentsRequest
- Requests API Gateway to get information about a Deployments collection.Future<GetDeploymentsResult> getDeploymentsAsync(GetDeploymentsRequest getDeploymentsRequest, AsyncHandler<GetDeploymentsRequest,GetDeploymentsResult> asyncHandler)
Gets information about a Deployments collection.
getDeploymentsRequest
- Requests API Gateway to get information about a Deployments collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDocumentationPartResult> getDocumentationPartAsync(GetDocumentationPartRequest getDocumentationPartRequest)
Gets a documentation part.
getDocumentationPartRequest
- Gets a specified documentation part of a given API.Future<GetDocumentationPartResult> getDocumentationPartAsync(GetDocumentationPartRequest getDocumentationPartRequest, AsyncHandler<GetDocumentationPartRequest,GetDocumentationPartResult> asyncHandler)
Gets a documentation part.
getDocumentationPartRequest
- Gets a specified documentation part of a given API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDocumentationPartsResult> getDocumentationPartsAsync(GetDocumentationPartsRequest getDocumentationPartsRequest)
Gets documentation parts.
getDocumentationPartsRequest
- Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).Future<GetDocumentationPartsResult> getDocumentationPartsAsync(GetDocumentationPartsRequest getDocumentationPartsRequest, AsyncHandler<GetDocumentationPartsRequest,GetDocumentationPartsResult> asyncHandler)
Gets documentation parts.
getDocumentationPartsRequest
- Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDocumentationVersionResult> getDocumentationVersionAsync(GetDocumentationVersionRequest getDocumentationVersionRequest)
Gets a documentation version.
getDocumentationVersionRequest
- Gets a documentation snapshot of an API.Future<GetDocumentationVersionResult> getDocumentationVersionAsync(GetDocumentationVersionRequest getDocumentationVersionRequest, AsyncHandler<GetDocumentationVersionRequest,GetDocumentationVersionResult> asyncHandler)
Gets a documentation version.
getDocumentationVersionRequest
- Gets a documentation snapshot of an API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDocumentationVersionsResult> getDocumentationVersionsAsync(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
Gets documentation versions.
getDocumentationVersionsRequest
- Gets the documentation versions of an API.Future<GetDocumentationVersionsResult> getDocumentationVersionsAsync(GetDocumentationVersionsRequest getDocumentationVersionsRequest, AsyncHandler<GetDocumentationVersionsRequest,GetDocumentationVersionsResult> asyncHandler)
Gets documentation versions.
getDocumentationVersionsRequest
- Gets the documentation versions of an API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDomainNameResult> getDomainNameAsync(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.Future<GetDomainNameResult> getDomainNameAsync(GetDomainNameRequest getDomainNameRequest, AsyncHandler<GetDomainNameRequest,GetDomainNameResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDomainNamesResult> getDomainNamesAsync(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
getDomainNamesRequest
- Request to describe a collection of DomainName resources.Future<GetDomainNamesResult> getDomainNamesAsync(GetDomainNamesRequest getDomainNamesRequest, AsyncHandler<GetDomainNamesRequest,GetDomainNamesResult> asyncHandler)
Represents a collection of DomainName resources.
getDomainNamesRequest
- Request to describe a collection of DomainName resources.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetExportResult> getExportAsync(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.Future<GetExportResult> getExportAsync(GetExportRequest getExportRequest, AsyncHandler<GetExportRequest,GetExportResult> asyncHandler)
Exports a deployed version of a RestApi in a specified format.
getExportRequest
- Request a new export of a RestApi for a particular Stage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGatewayResponseResult> getGatewayResponseAsync(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.Future<GetGatewayResponseResult> getGatewayResponseAsync(GetGatewayResponseRequest getGatewayResponseRequest, AsyncHandler<GetGatewayResponseRequest,GetGatewayResponseResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetGatewayResponsesResult> getGatewayResponsesAsync(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 API Gateway-generated default GatewayResponses collection for the supported response types.
getGatewayResponsesRequest
- Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
collection for the supported response types.Future<GetGatewayResponsesResult> getGatewayResponsesAsync(GetGatewayResponsesRequest getGatewayResponsesRequest, AsyncHandler<GetGatewayResponsesRequest,GetGatewayResponsesResult> asyncHandler)
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
getGatewayResponsesRequest
- Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
collection for the supported response types.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest getIntegrationRequest)
Get the integration settings.
getIntegrationRequest
- Represents a request to get the integration configuration.Future<GetIntegrationResult> getIntegrationAsync(GetIntegrationRequest getIntegrationRequest, AsyncHandler<GetIntegrationRequest,GetIntegrationResult> asyncHandler)
Get the integration settings.
getIntegrationRequest
- Represents a request to get the integration configuration.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIntegrationResponseResult> getIntegrationResponseAsync(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
getIntegrationResponseRequest
- Represents a get integration response request.Future<GetIntegrationResponseResult> getIntegrationResponseAsync(GetIntegrationResponseRequest getIntegrationResponseRequest, AsyncHandler<GetIntegrationResponseRequest,GetIntegrationResponseResult> asyncHandler)
Represents a get integration response.
getIntegrationResponseRequest
- Represents a get integration response request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMethodResult> getMethodAsync(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
getMethodRequest
- Request to describe an existing Method resource.Future<GetMethodResult> getMethodAsync(GetMethodRequest getMethodRequest, AsyncHandler<GetMethodRequest,GetMethodResult> asyncHandler)
Describe an existing Method resource.
getMethodRequest
- Request to describe an existing Method resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMethodResponseResult> getMethodResponseAsync(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
getMethodResponseRequest
- Request to describe a MethodResponse resource.Future<GetMethodResponseResult> getMethodResponseAsync(GetMethodResponseRequest getMethodResponseRequest, AsyncHandler<GetMethodResponseRequest,GetMethodResponseResult> asyncHandler)
Describes a MethodResponse resource.
getMethodResponseRequest
- Request to describe a MethodResponse resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetModelResult> getModelAsync(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
getModelRequest
- Request to list information about a model in an existing RestApi resource.Future<GetModelResult> getModelAsync(GetModelRequest getModelRequest, AsyncHandler<GetModelRequest,GetModelResult> asyncHandler)
Describes an existing model defined for a RestApi resource.
getModelRequest
- Request to list information about a model in an existing RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetModelTemplateResult> getModelTemplateAsync(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.Future<GetModelTemplateResult> getModelTemplateAsync(GetModelTemplateRequest getModelTemplateRequest, AsyncHandler<GetModelTemplateRequest,GetModelTemplateResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetModelsResult> getModelsAsync(GetModelsRequest getModelsRequest)
Describes existing Models defined for a RestApi resource.
getModelsRequest
- Request to list existing Models defined for a RestApi resource.Future<GetModelsResult> getModelsAsync(GetModelsRequest getModelsRequest, AsyncHandler<GetModelsRequest,GetModelsResult> asyncHandler)
Describes existing Models defined for a RestApi resource.
getModelsRequest
- Request to list existing Models defined for a RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRequestValidatorResult> getRequestValidatorAsync(GetRequestValidatorRequest getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
getRequestValidatorRequest
- Gets a RequestValidator of a given RestApi.Future<GetRequestValidatorResult> getRequestValidatorAsync(GetRequestValidatorRequest getRequestValidatorRequest, AsyncHandler<GetRequestValidatorRequest,GetRequestValidatorResult> asyncHandler)
Gets a RequestValidator of a given RestApi.
getRequestValidatorRequest
- Gets a RequestValidator of a given RestApi.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRequestValidatorsResult> getRequestValidatorsAsync(GetRequestValidatorsRequest getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
getRequestValidatorsRequest
- Gets the RequestValidators collection of a given RestApi.Future<GetRequestValidatorsResult> getRequestValidatorsAsync(GetRequestValidatorsRequest getRequestValidatorsRequest, AsyncHandler<GetRequestValidatorsRequest,GetRequestValidatorsResult> asyncHandler)
Gets the RequestValidators collection of a given RestApi.
getRequestValidatorsRequest
- Gets the RequestValidators collection of a given RestApi.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourceResult> getResourceAsync(GetResourceRequest getResourceRequest)
Lists information about a resource.
getResourceRequest
- Request to list information about a resource.Future<GetResourceResult> getResourceAsync(GetResourceRequest getResourceRequest, AsyncHandler<GetResourceRequest,GetResourceResult> asyncHandler)
Lists information about a resource.
getResourceRequest
- Request to list information about a resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
getResourcesRequest
- Request to list information about a collection of resources.Future<GetResourcesResult> getResourcesAsync(GetResourcesRequest getResourcesRequest, AsyncHandler<GetResourcesRequest,GetResourcesResult> asyncHandler)
Lists information about a collection of Resource resources.
getResourcesRequest
- Request to list information about a collection of resources.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRestApiResult> getRestApiAsync(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
getRestApiRequest
- The GET request to list an existing RestApi defined for your collection.Future<GetRestApiResult> getRestApiAsync(GetRestApiRequest getRestApiRequest, AsyncHandler<GetRestApiRequest,GetRestApiResult> asyncHandler)
Lists the RestApi resource in the collection.
getRestApiRequest
- The GET request to list an existing RestApi defined for your collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRestApisResult> getRestApisAsync(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
getRestApisRequest
- The GET request to list existing RestApis defined for your collection.Future<GetRestApisResult> getRestApisAsync(GetRestApisRequest getRestApisRequest, AsyncHandler<GetRestApisRequest,GetRestApisResult> asyncHandler)
Lists the RestApis resources for your collection.
getRestApisRequest
- The GET request to list existing RestApis defined for your collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSdkResult> getSdkAsync(GetSdkRequest getSdkRequest)
Generates a client SDK for a RestApi and Stage.
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.Future<GetSdkResult> getSdkAsync(GetSdkRequest getSdkRequest, AsyncHandler<GetSdkRequest,GetSdkResult> asyncHandler)
Generates a client SDK for a RestApi and Stage.
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSdkTypeResult> getSdkTypeAsync(GetSdkTypeRequest getSdkTypeRequest)
Gets an SDK type.
getSdkTypeRequest
- Get an SdkType instance.Future<GetSdkTypeResult> getSdkTypeAsync(GetSdkTypeRequest getSdkTypeRequest, AsyncHandler<GetSdkTypeRequest,GetSdkTypeResult> asyncHandler)
Gets an SDK type.
getSdkTypeRequest
- Get an SdkType instance.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSdkTypesResult> getSdkTypesAsync(GetSdkTypesRequest getSdkTypesRequest)
Gets SDK types
getSdkTypesRequest
- Get the SdkTypes collection.Future<GetSdkTypesResult> getSdkTypesAsync(GetSdkTypesRequest getSdkTypesRequest, AsyncHandler<GetSdkTypesRequest,GetSdkTypesResult> asyncHandler)
Gets SDK types
getSdkTypesRequest
- Get the SdkTypes collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest)
Gets information about a Stage resource.
getStageRequest
- Requests API Gateway to get information about a Stage resource.Future<GetStageResult> getStageAsync(GetStageRequest getStageRequest, AsyncHandler<GetStageRequest,GetStageResult> asyncHandler)
Gets information about a Stage resource.
getStageRequest
- Requests API Gateway to get information about a Stage resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetStagesResult> getStagesAsync(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
getStagesRequest
- Requests API Gateway to get information about one or more Stage resources.Future<GetStagesResult> getStagesAsync(GetStagesRequest getStagesRequest, AsyncHandler<GetStagesRequest,GetStagesResult> asyncHandler)
Gets information about one or more Stage resources.
getStagesRequest
- Requests API Gateway to get information about one or more Stage resources.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTagsResult> getTagsAsync(GetTagsRequest getTagsRequest)
Gets the Tags collection for a given resource.
getTagsRequest
- Gets the Tags collection for a given resource.Future<GetTagsResult> getTagsAsync(GetTagsRequest getTagsRequest, AsyncHandler<GetTagsRequest,GetTagsResult> asyncHandler)
Gets the Tags collection for a given resource.
getTagsRequest
- Gets the Tags collection for a given resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUsageResult> getUsageAsync(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.Future<GetUsageResult> getUsageAsync(GetUsageRequest getUsageRequest, AsyncHandler<GetUsageRequest,GetUsageResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUsagePlanResult> getUsagePlanAsync(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.Future<GetUsagePlanResult> getUsagePlanAsync(GetUsagePlanRequest getUsagePlanRequest, AsyncHandler<GetUsagePlanRequest,GetUsagePlanResult> asyncHandler)
Gets a usage plan of a given plan identifier.
getUsagePlanRequest
- The GET request to get a usage plan of a given plan identifier.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUsagePlanKeyResult> getUsagePlanKeyAsync(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.Future<GetUsagePlanKeyResult> getUsagePlanKeyAsync(GetUsagePlanKeyRequest getUsagePlanKeyRequest, AsyncHandler<GetUsagePlanKeyRequest,GetUsagePlanKeyResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUsagePlanKeysResult> getUsagePlanKeysAsync(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.Future<GetUsagePlanKeysResult> getUsagePlanKeysAsync(GetUsagePlanKeysRequest getUsagePlanKeysRequest, AsyncHandler<GetUsagePlanKeysRequest,GetUsagePlanKeysResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetUsagePlansResult> getUsagePlansAsync(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.Future<GetUsagePlansResult> getUsagePlansAsync(GetUsagePlansRequest getUsagePlansRequest, AsyncHandler<GetUsagePlansRequest,GetUsagePlansResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetVpcLinkResult> getVpcLinkAsync(GetVpcLinkRequest getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
getVpcLinkRequest
- Gets a specified VPC link under the caller's account in a region.Future<GetVpcLinkResult> getVpcLinkAsync(GetVpcLinkRequest getVpcLinkRequest, AsyncHandler<GetVpcLinkRequest,GetVpcLinkResult> asyncHandler)
Gets a specified VPC link under the caller's account in a region.
getVpcLinkRequest
- Gets a specified VPC link under the caller's account in a region.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetVpcLinksResult> getVpcLinksAsync(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
getVpcLinksRequest
- Gets the VpcLinks collection under the caller's account in a selected region.Future<GetVpcLinksResult> getVpcLinksAsync(GetVpcLinksRequest getVpcLinksRequest, AsyncHandler<GetVpcLinksRequest,GetVpcLinksResult> asyncHandler)
Gets the VpcLinks collection under the caller's account in a selected region.
getVpcLinksRequest
- Gets the VpcLinks collection under the caller's account in a selected region.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportApiKeysResult> importApiKeysAsync(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.Future<ImportApiKeysResult> importApiKeysAsync(ImportApiKeysRequest importApiKeysRequest, AsyncHandler<ImportApiKeysRequest,ImportApiKeysResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportDocumentationPartsResult> importDocumentationPartsAsync(ImportDocumentationPartsRequest importDocumentationPartsRequest)
Imports documentation parts
importDocumentationPartsRequest
- Import documentation parts from an external (e.g., OpenAPI) definition file.Future<ImportDocumentationPartsResult> importDocumentationPartsAsync(ImportDocumentationPartsRequest importDocumentationPartsRequest, AsyncHandler<ImportDocumentationPartsRequest,ImportDocumentationPartsResult> asyncHandler)
Imports documentation parts
importDocumentationPartsRequest
- Import documentation parts from an external (e.g., OpenAPI) definition file.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportRestApiResult> importRestApiAsync(ImportRestApiRequest importRestApiRequest)
A feature of the API Gateway control service for creating a new API from an external API definition file.
importRestApiRequest
- A POST request to import an API to API Gateway using an input of an API definition file.Future<ImportRestApiResult> importRestApiAsync(ImportRestApiRequest importRestApiRequest, AsyncHandler<ImportRestApiRequest,ImportRestApiResult> asyncHandler)
A feature of the API Gateway control service for creating a new API from an external API definition file.
importRestApiRequest
- A POST request to import an API to API Gateway using an input of an API definition file.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutGatewayResponseResult> putGatewayResponseAsync(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.Future<PutGatewayResponseResult> putGatewayResponseAsync(PutGatewayResponseRequest putGatewayResponseRequest, AsyncHandler<PutGatewayResponseRequest,PutGatewayResponseResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest putIntegrationRequest)
Sets up a method's integration.
putIntegrationRequest
- Sets up a method's integration.Future<PutIntegrationResult> putIntegrationAsync(PutIntegrationRequest putIntegrationRequest, AsyncHandler<PutIntegrationRequest,PutIntegrationResult> asyncHandler)
Sets up a method's integration.
putIntegrationRequest
- Sets up a method's integration.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutIntegrationResponseResult> putIntegrationResponseAsync(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
putIntegrationResponseRequest
- Represents a put integration response request.Future<PutIntegrationResponseResult> putIntegrationResponseAsync(PutIntegrationResponseRequest putIntegrationResponseRequest, AsyncHandler<PutIntegrationResponseRequest,PutIntegrationResponseResult> asyncHandler)
Represents a put integration.
putIntegrationResponseRequest
- Represents a put integration response request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMethodResult> putMethodAsync(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
putMethodRequest
- Request to add a method to an existing Resource resource.Future<PutMethodResult> putMethodAsync(PutMethodRequest putMethodRequest, AsyncHandler<PutMethodRequest,PutMethodResult> asyncHandler)
Add a method to an existing Resource resource.
putMethodRequest
- Request to add a method to an existing Resource resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutMethodResponseResult> putMethodResponseAsync(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
putMethodResponseRequest
- Request to add a MethodResponse to an existing Method resource.Future<PutMethodResponseResult> putMethodResponseAsync(PutMethodResponseRequest putMethodResponseRequest, AsyncHandler<PutMethodResponseRequest,PutMethodResponseResult> asyncHandler)
Adds a MethodResponse to an existing Method resource.
putMethodResponseRequest
- Request to add a MethodResponse to an existing Method resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutRestApiResult> putRestApiAsync(PutRestApiRequest putRestApiRequest)
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.
putRestApiRequest
- A PUT request to update an existing API, with external API definitions specified as the request body.Future<PutRestApiResult> putRestApiAsync(PutRestApiRequest putRestApiRequest, AsyncHandler<PutRestApiRequest,PutRestApiResult> asyncHandler)
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.
putRestApiRequest
- A PUT request to update an existing API, with external API definitions specified as the request body.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds or updates a tag on a given resource.
tagResourceRequest
- Adds or updates a tag on a given resource.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds or updates a tag on a given resource.
tagResourceRequest
- Adds or updates a tag on a given resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TestInvokeAuthorizerResult> testInvokeAuthorizerAsync(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 invocation of an Authorizer.Future<TestInvokeAuthorizerResult> testInvokeAuthorizerAsync(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest, AsyncHandler<TestInvokeAuthorizerRequest,TestInvokeAuthorizerResult> asyncHandler)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizerRequest
- Make a request to simulate the invocation of an Authorizer.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TestInvokeMethodResult> testInvokeMethodAsync(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethodRequest
- Make a request to simulate the invocation of a Method.Future<TestInvokeMethodResult> testInvokeMethodAsync(TestInvokeMethodRequest testInvokeMethodRequest, AsyncHandler<TestInvokeMethodRequest,TestInvokeMethodResult> asyncHandler)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethodRequest
- Make a request to simulate the invocation of a Method.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from a given resource.
untagResourceRequest
- Removes a tag from a given resource.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from a given resource.
untagResourceRequest
- Removes a tag from a given resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
updateAccountRequest
- Requests API Gateway to change information about the current Account resource.Future<UpdateAccountResult> updateAccountAsync(UpdateAccountRequest updateAccountRequest, AsyncHandler<UpdateAccountRequest,UpdateAccountResult> asyncHandler)
Changes information about the current Account resource.
updateAccountRequest
- Requests API Gateway to change information about the current Account resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateApiKeyResult> updateApiKeyAsync(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
updateApiKeyRequest
- A request to change information about an ApiKey resource.Future<UpdateApiKeyResult> updateApiKeyAsync(UpdateApiKeyRequest updateApiKeyRequest, AsyncHandler<UpdateApiKeyRequest,UpdateApiKeyResult> asyncHandler)
Changes information about an ApiKey resource.
updateApiKeyRequest
- A request to change information about an ApiKey resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAuthorizerResult> updateAuthorizerAsync(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
updateAuthorizerRequest
- Request to update an existing Authorizer resource.Future<UpdateAuthorizerResult> updateAuthorizerAsync(UpdateAuthorizerRequest updateAuthorizerRequest, AsyncHandler<UpdateAuthorizerRequest,UpdateAuthorizerResult> asyncHandler)
Updates an existing Authorizer resource.
updateAuthorizerRequest
- Request to update an existing Authorizer resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBasePathMappingResult> updateBasePathMappingAsync(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
updateBasePathMappingRequest
- A request to change information about the BasePathMapping resource.Future<UpdateBasePathMappingResult> updateBasePathMappingAsync(UpdateBasePathMappingRequest updateBasePathMappingRequest, AsyncHandler<UpdateBasePathMappingRequest,UpdateBasePathMappingResult> asyncHandler)
Changes information about the BasePathMapping resource.
updateBasePathMappingRequest
- A request to change information about the BasePathMapping resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateClientCertificateResult> updateClientCertificateAsync(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
updateClientCertificateRequest
- A request to change information about an ClientCertificate resource.Future<UpdateClientCertificateResult> updateClientCertificateAsync(UpdateClientCertificateRequest updateClientCertificateRequest, AsyncHandler<UpdateClientCertificateRequest,UpdateClientCertificateResult> asyncHandler)
Changes information about an ClientCertificate resource.
updateClientCertificateRequest
- A request to change information about an ClientCertificate resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDeploymentResult> updateDeploymentAsync(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
updateDeploymentRequest
- Requests API Gateway to change information about a Deployment resource.Future<UpdateDeploymentResult> updateDeploymentAsync(UpdateDeploymentRequest updateDeploymentRequest, AsyncHandler<UpdateDeploymentRequest,UpdateDeploymentResult> asyncHandler)
Changes information about a Deployment resource.
updateDeploymentRequest
- Requests API Gateway to change information about a Deployment resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDocumentationPartResult> updateDocumentationPartAsync(UpdateDocumentationPartRequest updateDocumentationPartRequest)
Updates a documentation part.
updateDocumentationPartRequest
- Updates an existing documentation part of a given API.Future<UpdateDocumentationPartResult> updateDocumentationPartAsync(UpdateDocumentationPartRequest updateDocumentationPartRequest, AsyncHandler<UpdateDocumentationPartRequest,UpdateDocumentationPartResult> asyncHandler)
Updates a documentation part.
updateDocumentationPartRequest
- Updates an existing documentation part of a given API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDocumentationVersionResult> updateDocumentationVersionAsync(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
Updates a documentation version.
updateDocumentationVersionRequest
- Updates an existing documentation version of an API.Future<UpdateDocumentationVersionResult> updateDocumentationVersionAsync(UpdateDocumentationVersionRequest updateDocumentationVersionRequest, AsyncHandler<UpdateDocumentationVersionRequest,UpdateDocumentationVersionResult> asyncHandler)
Updates a documentation version.
updateDocumentationVersionRequest
- Updates an existing documentation version of an API.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDomainNameResult> updateDomainNameAsync(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
updateDomainNameRequest
- A request to change information about the DomainName resource.Future<UpdateDomainNameResult> updateDomainNameAsync(UpdateDomainNameRequest updateDomainNameRequest, AsyncHandler<UpdateDomainNameRequest,UpdateDomainNameResult> asyncHandler)
Changes information about the DomainName resource.
updateDomainNameRequest
- A request to change information about the DomainName resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGatewayResponseResult> updateGatewayResponseAsync(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.Future<UpdateGatewayResponseResult> updateGatewayResponseAsync(UpdateGatewayResponseRequest updateGatewayResponseRequest, AsyncHandler<UpdateGatewayResponseRequest,UpdateGatewayResponseResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIntegrationResult> updateIntegrationAsync(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
updateIntegrationRequest
- Represents an update integration request.Future<UpdateIntegrationResult> updateIntegrationAsync(UpdateIntegrationRequest updateIntegrationRequest, AsyncHandler<UpdateIntegrationRequest,UpdateIntegrationResult> asyncHandler)
Represents an update integration.
updateIntegrationRequest
- Represents an update integration request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateIntegrationResponseResult> updateIntegrationResponseAsync(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
updateIntegrationResponseRequest
- Represents an update integration response request.Future<UpdateIntegrationResponseResult> updateIntegrationResponseAsync(UpdateIntegrationResponseRequest updateIntegrationResponseRequest, AsyncHandler<UpdateIntegrationResponseRequest,UpdateIntegrationResponseResult> asyncHandler)
Represents an update integration response.
updateIntegrationResponseRequest
- Represents an update integration response request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMethodResult> updateMethodAsync(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
updateMethodRequest
- Request to update an existing Method resource.Future<UpdateMethodResult> updateMethodAsync(UpdateMethodRequest updateMethodRequest, AsyncHandler<UpdateMethodRequest,UpdateMethodResult> asyncHandler)
Updates an existing Method resource.
updateMethodRequest
- Request to update an existing Method resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMethodResponseResult> updateMethodResponseAsync(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
updateMethodResponseRequest
- A request to update an existing MethodResponse resource.Future<UpdateMethodResponseResult> updateMethodResponseAsync(UpdateMethodResponseRequest updateMethodResponseRequest, AsyncHandler<UpdateMethodResponseRequest,UpdateMethodResponseResult> asyncHandler)
Updates an existing MethodResponse resource.
updateMethodResponseRequest
- A request to update an existing MethodResponse resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateModelResult> updateModelAsync(UpdateModelRequest updateModelRequest)
Changes information about a model. The maximum size of the model is 400 KB.
updateModelRequest
- Request to update an existing model in an existing RestApi resource.Future<UpdateModelResult> updateModelAsync(UpdateModelRequest updateModelRequest, AsyncHandler<UpdateModelRequest,UpdateModelResult> asyncHandler)
Changes information about a model. The maximum size of the model is 400 KB.
updateModelRequest
- Request to update an existing model in an existing RestApi resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRequestValidatorResult> updateRequestValidatorAsync(UpdateRequestValidatorRequest updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
updateRequestValidatorRequest
- Updates a RequestValidator of a given RestApi.Future<UpdateRequestValidatorResult> updateRequestValidatorAsync(UpdateRequestValidatorRequest updateRequestValidatorRequest, AsyncHandler<UpdateRequestValidatorRequest,UpdateRequestValidatorResult> asyncHandler)
Updates a RequestValidator of a given RestApi.
updateRequestValidatorRequest
- Updates a RequestValidator of a given RestApi.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
updateResourceRequest
- Request to change information about a Resource resource.Future<UpdateResourceResult> updateResourceAsync(UpdateResourceRequest updateResourceRequest, AsyncHandler<UpdateResourceRequest,UpdateResourceResult> asyncHandler)
Changes information about a Resource resource.
updateResourceRequest
- Request to change information about a Resource resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRestApiResult> updateRestApiAsync(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
updateRestApiRequest
- Request to update an existing RestApi resource in your collection.Future<UpdateRestApiResult> updateRestApiAsync(UpdateRestApiRequest updateRestApiRequest, AsyncHandler<UpdateRestApiRequest,UpdateRestApiResult> asyncHandler)
Changes information about the specified API.
updateRestApiRequest
- Request to update an existing RestApi resource in your collection.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
updateStageRequest
- Requests API Gateway to change information about a Stage resource.Future<UpdateStageResult> updateStageAsync(UpdateStageRequest updateStageRequest, AsyncHandler<UpdateStageRequest,UpdateStageResult> asyncHandler)
Changes information about a Stage resource.
updateStageRequest
- Requests API Gateway to change information about a Stage resource.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUsageResult> updateUsageAsync(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.Future<UpdateUsageResult> updateUsageAsync(UpdateUsageRequest updateUsageRequest, AsyncHandler<UpdateUsageRequest,UpdateUsageResult> asyncHandler)
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.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateUsagePlanResult> updateUsagePlanAsync(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.Future<UpdateUsagePlanResult> updateUsagePlanAsync(UpdateUsagePlanRequest updateUsagePlanRequest, AsyncHandler<UpdateUsagePlanRequest,UpdateUsagePlanResult> asyncHandler)
Updates a usage plan of a given plan Id.
updateUsagePlanRequest
- The PATCH request to update a usage plan of a given plan Id.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVpcLinkResult> updateVpcLinkAsync(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
updateVpcLinkRequest
- Updates an existing VpcLink of a specified identifier.Future<UpdateVpcLinkResult> updateVpcLinkAsync(UpdateVpcLinkRequest updateVpcLinkRequest, AsyncHandler<UpdateVpcLinkRequest,UpdateVpcLinkResult> asyncHandler)
Updates an existing VpcLink of a specified identifier.
updateVpcLinkRequest
- Updates an existing VpcLink of a specified identifier.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.