@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonApiGateway extends Object implements AmazonApiGateway
AmazonApiGateway
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest request)
Create an ApiKey resource.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest request)
Adds a new Authorizer resource to an existing RestApi resource.
|
CreateBasePathMappingResult |
createBasePathMapping(CreateBasePathMappingRequest request)
Creates a new BasePathMapping resource.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
CreateDocumentationPartResult |
createDocumentationPart(CreateDocumentationPartRequest request)
Creates a documentation part.
|
CreateDocumentationVersionResult |
createDocumentationVersion(CreateDocumentationVersionRequest request)
Creates a documentation version
|
CreateDomainNameResult |
createDomainName(CreateDomainNameRequest request)
Creates a new domain name.
|
CreateModelResult |
createModel(CreateModelRequest request)
Adds a new Model resource to an existing RestApi resource.
|
CreateRequestValidatorResult |
createRequestValidator(CreateRequestValidatorRequest request)
Creates a RequestValidator of a given RestApi.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a Resource resource.
|
CreateRestApiResult |
createRestApi(CreateRestApiRequest request)
Creates a new RestApi resource.
|
CreateStageResult |
createStage(CreateStageRequest request)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
CreateUsagePlanResult |
createUsagePlan(CreateUsagePlanRequest request)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
payload.
|
CreateUsagePlanKeyResult |
createUsagePlanKey(CreateUsagePlanKeyRequest request)
Creates a usage plan key for adding an existing API key to a usage plan.
|
CreateVpcLinkResult |
createVpcLink(CreateVpcLinkRequest request)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
takes 2-4 minutes to complete and become operational.
|
DeleteApiKeyResult |
deleteApiKey(DeleteApiKeyRequest request)
Deletes the ApiKey resource.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an existing Authorizer resource.
|
DeleteBasePathMappingResult |
deleteBasePathMapping(DeleteBasePathMappingRequest request)
Deletes the BasePathMapping resource.
|
DeleteClientCertificateResult |
deleteClientCertificate(DeleteClientCertificateRequest request)
Deletes the ClientCertificate resource.
|
DeleteDeploymentResult |
deleteDeployment(DeleteDeploymentRequest request)
Deletes a Deployment resource.
|
DeleteDocumentationPartResult |
deleteDocumentationPart(DeleteDocumentationPartRequest request)
Deletes a documentation part
|
DeleteDocumentationVersionResult |
deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
Deletes a documentation version.
|
DeleteDomainNameResult |
deleteDomainName(DeleteDomainNameRequest request)
Deletes the DomainName resource.
|
DeleteGatewayResponseResult |
deleteGatewayResponse(DeleteGatewayResponseRequest request)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it
with the default settings.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest request)
Represents a delete integration.
|
DeleteIntegrationResponseResult |
deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
Represents a delete integration response.
|
DeleteMethodResult |
deleteMethod(DeleteMethodRequest request)
Deletes an existing Method resource.
|
DeleteMethodResponseResult |
deleteMethodResponse(DeleteMethodResponseRequest request)
Deletes an existing MethodResponse resource.
|
DeleteModelResult |
deleteModel(DeleteModelRequest request)
Deletes a model.
|
DeleteRequestValidatorResult |
deleteRequestValidator(DeleteRequestValidatorRequest request)
Deletes a RequestValidator of a given RestApi.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest request)
Deletes a Resource resource.
|
DeleteRestApiResult |
deleteRestApi(DeleteRestApiRequest request)
Deletes the specified API.
|
DeleteStageResult |
deleteStage(DeleteStageRequest request)
Deletes a Stage resource.
|
DeleteUsagePlanResult |
deleteUsagePlan(DeleteUsagePlanRequest request)
Deletes a usage plan of a given plan Id.
|
DeleteUsagePlanKeyResult |
deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
DeleteVpcLinkResult |
deleteVpcLink(DeleteVpcLinkRequest request)
Deletes an existing VpcLink of a specified identifier.
|
FlushStageAuthorizersCacheResult |
flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)
Flushes all authorizer cache entries on a stage.
|
FlushStageCacheResult |
flushStageCache(FlushStageCacheRequest request)
Flushes a stage's cache.
|
GenerateClientCertificateResult |
generateClientCertificate(GenerateClientCertificateRequest request)
Generates a ClientCertificate resource.
|
GetAccountResult |
getAccount(GetAccountRequest request)
Gets information about the current Account resource.
|
GetApiKeyResult |
getApiKey(GetApiKeyRequest request)
Gets information about the current ApiKey resource.
|
GetApiKeysResult |
getApiKeys(GetApiKeysRequest request)
Gets information about the current ApiKeys resource.
|
GetAuthorizerResult |
getAuthorizer(GetAuthorizerRequest request)
Describe an existing Authorizer resource.
|
GetAuthorizersResult |
getAuthorizers(GetAuthorizersRequest request)
Describe an existing Authorizers resource.
|
GetBasePathMappingResult |
getBasePathMapping(GetBasePathMappingRequest request)
Describe a BasePathMapping resource.
|
GetBasePathMappingsResult |
getBasePathMappings(GetBasePathMappingsRequest request)
Represents a collection of BasePathMapping resources.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetClientCertificateResult |
getClientCertificate(GetClientCertificateRequest request)
Gets information about the current ClientCertificate resource.
|
GetClientCertificatesResult |
getClientCertificates(GetClientCertificatesRequest request)
Gets a collection of ClientCertificate resources.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest request)
Gets information about a Deployment resource.
|
GetDeploymentsResult |
getDeployments(GetDeploymentsRequest request)
Gets information about a Deployments collection.
|
GetDocumentationPartResult |
getDocumentationPart(GetDocumentationPartRequest request)
Gets a documentation part.
|
GetDocumentationPartsResult |
getDocumentationParts(GetDocumentationPartsRequest request)
Gets documentation parts.
|
GetDocumentationVersionResult |
getDocumentationVersion(GetDocumentationVersionRequest request)
Gets a documentation version.
|
GetDocumentationVersionsResult |
getDocumentationVersions(GetDocumentationVersionsRequest request)
Gets documentation versions.
|
GetDomainNameResult |
getDomainName(GetDomainNameRequest request)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
GetDomainNamesResult |
getDomainNames(GetDomainNamesRequest request)
Represents a collection of DomainName resources.
|
GetExportResult |
getExport(GetExportRequest request)
Exports a deployed version of a RestApi in a specified format.
|
GetGatewayResponseResult |
getGatewayResponse(GetGatewayResponseRequest request)
Gets a GatewayResponse of a specified response type on the given RestApi.
|
GetGatewayResponsesResult |
getGatewayResponses(GetGatewayResponsesRequest request)
Gets the GatewayResponses collection on the given RestApi.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest request)
Get the integration settings.
|
GetIntegrationResponseResult |
getIntegrationResponse(GetIntegrationResponseRequest request)
Represents a get integration response.
|
GetMethodResult |
getMethod(GetMethodRequest request)
Describe an existing Method resource.
|
GetMethodResponseResult |
getMethodResponse(GetMethodResponseRequest request)
Describes a MethodResponse resource.
|
GetModelResult |
getModel(GetModelRequest request)
Describes an existing model defined for a RestApi resource.
|
GetModelsResult |
getModels(GetModelsRequest request)
Describes existing Models defined for a RestApi resource.
|
GetModelTemplateResult |
getModelTemplate(GetModelTemplateRequest request)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
GetRequestValidatorResult |
getRequestValidator(GetRequestValidatorRequest request)
Gets a RequestValidator of a given RestApi.
|
GetRequestValidatorsResult |
getRequestValidators(GetRequestValidatorsRequest request)
Gets the RequestValidators collection of a given RestApi.
|
GetResourceResult |
getResource(GetResourceRequest request)
Lists information about a resource.
|
GetResourcesResult |
getResources(GetResourcesRequest request)
Lists information about a collection of Resource resources.
|
GetRestApiResult |
getRestApi(GetRestApiRequest request)
Lists the RestApi resource in the collection.
|
GetRestApisResult |
getRestApis(GetRestApisRequest request)
Lists the RestApis resources for your collection.
|
GetSdkResult |
getSdk(GetSdkRequest request)
Generates a client SDK for a RestApi and Stage.
|
GetSdkTypeResult |
getSdkType(GetSdkTypeRequest request)
Gets an SDK type.
|
GetSdkTypesResult |
getSdkTypes(GetSdkTypesRequest request)
Gets SDK types
|
GetStageResult |
getStage(GetStageRequest request)
Gets information about a Stage resource.
|
GetStagesResult |
getStages(GetStagesRequest request)
Gets information about one or more Stage resources.
|
GetTagsResult |
getTags(GetTagsRequest request)
Gets the Tags collection for a given resource.
|
GetUsageResult |
getUsage(GetUsageRequest request)
Gets the usage data of a usage plan in a specified time interval.
|
GetUsagePlanResult |
getUsagePlan(GetUsagePlanRequest request)
Gets a usage plan of a given plan identifier.
|
GetUsagePlanKeyResult |
getUsagePlanKey(GetUsagePlanKeyRequest request)
Gets a usage plan key of a given key identifier.
|
GetUsagePlanKeysResult |
getUsagePlanKeys(GetUsagePlanKeysRequest request)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
GetUsagePlansResult |
getUsagePlans(GetUsagePlansRequest request)
Gets all the usage plans of the caller's account.
|
GetVpcLinkResult |
getVpcLink(GetVpcLinkRequest request)
Gets a specified VPC link under the caller's account in a region.
|
GetVpcLinksResult |
getVpcLinks(GetVpcLinksRequest request)
Gets the VpcLinks collection under the caller's account in a selected region.
|
ImportApiKeysResult |
importApiKeys(ImportApiKeysRequest request)
Import API keys from an external source, such as a CSV-formatted file.
|
ImportDocumentationPartsResult |
importDocumentationParts(ImportDocumentationPartsRequest request)
Imports documentation parts
|
ImportRestApiResult |
importRestApi(ImportRestApiRequest request)
A feature of the API Gateway control service for creating a new API from an external API definition file.
|
PutGatewayResponseResult |
putGatewayResponse(PutGatewayResponseRequest request)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest request)
Sets up a method's integration.
|
PutIntegrationResponseResult |
putIntegrationResponse(PutIntegrationResponseRequest request)
Represents a put integration.
|
PutMethodResult |
putMethod(PutMethodRequest request)
Add a method to an existing Resource resource.
|
PutMethodResponseResult |
putMethodResponse(PutMethodResponseRequest request)
Adds a MethodResponse to an existing Method resource.
|
PutRestApiResult |
putRestApi(PutRestApiRequest request)
A feature of the API Gateway control service for updating an existing API with an input of external API
definitions.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonApiGateway.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates a tag on a given resource.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
|
TestInvokeMethodResult |
testInvokeMethod(TestInvokeMethodRequest request)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from a given resource.
|
UpdateAccountResult |
updateAccount(UpdateAccountRequest request)
Changes information about the current Account resource.
|
UpdateApiKeyResult |
updateApiKey(UpdateApiKeyRequest request)
Changes information about an ApiKey resource.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest request)
Updates an existing Authorizer resource.
|
UpdateBasePathMappingResult |
updateBasePathMapping(UpdateBasePathMappingRequest request)
Changes information about the BasePathMapping resource.
|
UpdateClientCertificateResult |
updateClientCertificate(UpdateClientCertificateRequest request)
Changes information about an ClientCertificate resource.
|
UpdateDeploymentResult |
updateDeployment(UpdateDeploymentRequest request)
Changes information about a Deployment resource.
|
UpdateDocumentationPartResult |
updateDocumentationPart(UpdateDocumentationPartRequest request)
Updates a documentation part.
|
UpdateDocumentationVersionResult |
updateDocumentationVersion(UpdateDocumentationVersionRequest request)
Updates a documentation version.
|
UpdateDomainNameResult |
updateDomainName(UpdateDomainNameRequest request)
Changes information about the DomainName resource.
|
UpdateGatewayResponseResult |
updateGatewayResponse(UpdateGatewayResponseRequest request)
Updates a GatewayResponse of a specified response type on the given RestApi.
|
UpdateIntegrationResult |
updateIntegration(UpdateIntegrationRequest request)
Represents an update integration.
|
UpdateIntegrationResponseResult |
updateIntegrationResponse(UpdateIntegrationResponseRequest request)
Represents an update integration response.
|
UpdateMethodResult |
updateMethod(UpdateMethodRequest request)
Updates an existing Method resource.
|
UpdateMethodResponseResult |
updateMethodResponse(UpdateMethodResponseRequest request)
Updates an existing MethodResponse resource.
|
UpdateModelResult |
updateModel(UpdateModelRequest request)
Changes information about a model.
|
UpdateRequestValidatorResult |
updateRequestValidator(UpdateRequestValidatorRequest request)
Updates a RequestValidator of a given RestApi.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Changes information about a Resource resource.
|
UpdateRestApiResult |
updateRestApi(UpdateRestApiRequest request)
Changes information about the specified API.
|
UpdateStageResult |
updateStage(UpdateStageRequest request)
Changes information about a Stage resource.
|
UpdateUsageResult |
updateUsage(UpdateUsageRequest request)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
|
UpdateUsagePlanResult |
updateUsagePlan(UpdateUsagePlanRequest request)
Updates a usage plan of a given plan Id.
|
UpdateVpcLinkResult |
updateVpcLink(UpdateVpcLinkRequest request)
Updates an existing VpcLink of a specified identifier.
|
public void setEndpoint(String endpoint)
AmazonApiGateway
Callers can pass in just the endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AmazonApiGateway
endpoint
- The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://apigateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AmazonApiGateway
AmazonApiGateway.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AmazonApiGateway
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
AmazonApiGateway
Create an ApiKey resource.
createApiKey
in interface AmazonApiGateway
request
- Request to create an ApiKey resource.public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
AmazonApiGateway
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizer
in interface AmazonApiGateway
request
- Request to add a new Authorizer to an existing RestApi resource.public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
AmazonApiGateway
Creates a new BasePathMapping resource.
createBasePathMapping
in interface AmazonApiGateway
request
- Requests API Gateway to create a new BasePathMapping resource.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AmazonApiGateway
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment
in interface AmazonApiGateway
request
- Requests API Gateway to create a Deployment resource.public CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest request)
AmazonApiGateway
Creates a documentation part.
createDocumentationPart
in interface AmazonApiGateway
request
- Creates a new documentation part of a given API.public CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest request)
AmazonApiGateway
Creates a documentation version
createDocumentationVersion
in interface AmazonApiGateway
request
- Creates a new documentation version of a given API.public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
AmazonApiGateway
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
request
- A request to create a new domain name.public CreateModelResult createModel(CreateModelRequest request)
AmazonApiGateway
Adds a new Model resource to an existing RestApi resource.
createModel
in interface AmazonApiGateway
request
- Request to add a new Model to an existing RestApi resource.public CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest request)
AmazonApiGateway
Creates a RequestValidator of a given RestApi.
createRequestValidator
in interface AmazonApiGateway
request
- Creates a RequestValidator of a given RestApi.public CreateResourceResult createResource(CreateResourceRequest request)
AmazonApiGateway
Creates a Resource resource.
createResource
in interface AmazonApiGateway
request
- Requests API Gateway to create a Resource resource.public CreateRestApiResult createRestApi(CreateRestApiRequest request)
AmazonApiGateway
Creates a new RestApi resource.
createRestApi
in interface AmazonApiGateway
request
- The POST Request to add a new RestApi resource to your collection.public CreateStageResult createStage(CreateStageRequest request)
AmazonApiGateway
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStage
in interface AmazonApiGateway
request
- Requests API Gateway to create a Stage resource.public CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest request)
AmazonApiGateway
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
createUsagePlan
in interface AmazonApiGateway
request
- The POST request to create a usage plan with the name, description, throttle limits and quota limits, as
well as the associated API stages, specified in the payload.public CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest request)
AmazonApiGateway
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKey
in interface AmazonApiGateway
request
- The POST request to create a usage plan key for adding an existing API key to a usage plan.public CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest request)
AmazonApiGateway
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.
createVpcLink
in interface AmazonApiGateway
request
- Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
AmazonApiGateway
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
request
- A request to delete the ApiKey resource.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
AmazonApiGateway
Deletes an existing Authorizer resource.
deleteAuthorizer
in interface AmazonApiGateway
request
- Request to delete an existing Authorizer resource.public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)
AmazonApiGateway
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
request
- A request to delete the BasePathMapping resource.public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request)
AmazonApiGateway
Deletes the ClientCertificate resource.
deleteClientCertificate
in interface AmazonApiGateway
request
- A request to delete the ClientCertificate resource.public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)
AmazonApiGateway
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeployment
in interface AmazonApiGateway
request
- Requests API Gateway to delete a Deployment resource.public DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)
AmazonApiGateway
Deletes a documentation part
deleteDocumentationPart
in interface AmazonApiGateway
request
- Deletes an existing documentation part of an API.public DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
AmazonApiGateway
Deletes a documentation version.
deleteDocumentationVersion
in interface AmazonApiGateway
request
- Deletes an existing documentation version of an API.public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
AmazonApiGateway
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
request
- A request to delete the DomainName resource.public DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest request)
AmazonApiGateway
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
deleteGatewayResponse
in interface AmazonApiGateway
request
- Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets
it with the default settings.public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
AmazonApiGateway
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
request
- Represents a delete integration request.public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
AmazonApiGateway
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
request
- Represents a delete integration response request.public DeleteMethodResult deleteMethod(DeleteMethodRequest request)
AmazonApiGateway
Deletes an existing Method resource.
deleteMethod
in interface AmazonApiGateway
request
- Request to delete an existing Method resource.public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest request)
AmazonApiGateway
Deletes an existing MethodResponse resource.
deleteMethodResponse
in interface AmazonApiGateway
request
- A request to delete an existing MethodResponse resource.public DeleteModelResult deleteModel(DeleteModelRequest request)
AmazonApiGateway
Deletes a model.
deleteModel
in interface AmazonApiGateway
request
- Request to delete an existing model in an existing RestApi resource.public DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest request)
AmazonApiGateway
Deletes a RequestValidator of a given RestApi.
deleteRequestValidator
in interface AmazonApiGateway
request
- Deletes a specified RequestValidator of a given RestApi.public DeleteResourceResult deleteResource(DeleteResourceRequest request)
AmazonApiGateway
Deletes a Resource resource.
deleteResource
in interface AmazonApiGateway
request
- Request to delete a Resource.public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest request)
AmazonApiGateway
Deletes the specified API.
deleteRestApi
in interface AmazonApiGateway
request
- Request to delete the specified API from your collection.public DeleteStageResult deleteStage(DeleteStageRequest request)
AmazonApiGateway
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
request
- Requests API Gateway to delete a Stage resource.public DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest request)
AmazonApiGateway
Deletes a usage plan of a given plan Id.
deleteUsagePlan
in interface AmazonApiGateway
request
- The DELETE request to delete a usage plan of a given plan Id.public DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)
AmazonApiGateway
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKey
in interface AmazonApiGateway
request
- The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.public DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest request)
AmazonApiGateway
Deletes an existing VpcLink of a specified identifier.
deleteVpcLink
in interface AmazonApiGateway
request
- Deletes an existing VpcLink of a specified identifier.public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)
AmazonApiGateway
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCache
in interface AmazonApiGateway
request
- Request to flush authorizer cache entries on a specified stage.public FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)
AmazonApiGateway
Flushes a stage's cache.
flushStageCache
in interface AmazonApiGateway
request
- Requests API Gateway to flush a stage's cache.public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
AmazonApiGateway
Generates a ClientCertificate resource.
generateClientCertificate
in interface AmazonApiGateway
request
- A request to generate a ClientCertificate resource.public GetAccountResult getAccount(GetAccountRequest request)
AmazonApiGateway
Gets information about the current Account resource.
getAccount
in interface AmazonApiGateway
request
- Requests API Gateway to get information about the current Account resource.public GetApiKeyResult getApiKey(GetApiKeyRequest request)
AmazonApiGateway
Gets information about the current ApiKey resource.
getApiKey
in interface AmazonApiGateway
request
- A request to get information about the current ApiKey resource.public GetApiKeysResult getApiKeys(GetApiKeysRequest request)
AmazonApiGateway
Gets information about the current ApiKeys resource.
getApiKeys
in interface AmazonApiGateway
request
- A request to get information about the current ApiKeys resource.public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
AmazonApiGateway
Describe an existing Authorizer resource.
getAuthorizer
in interface AmazonApiGateway
request
- Request to describe an existing Authorizer resource.public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
AmazonApiGateway
Describe an existing Authorizers resource.
getAuthorizers
in interface AmazonApiGateway
request
- Request to describe an existing Authorizers resource.public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
AmazonApiGateway
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
request
- Request to describe a BasePathMapping resource.public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)
AmazonApiGateway
Represents a collection of BasePathMapping resources.
getBasePathMappings
in interface AmazonApiGateway
request
- A request to get information about a collection of BasePathMapping resources.public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest request)
AmazonApiGateway
Gets information about the current ClientCertificate resource.
getClientCertificate
in interface AmazonApiGateway
request
- A request to get information about the current ClientCertificate resource.public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)
AmazonApiGateway
Gets a collection of ClientCertificate resources.
getClientCertificates
in interface AmazonApiGateway
request
- A request to get information about a collection of ClientCertificate resources.public GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonApiGateway
Gets information about a Deployment resource.
getDeployment
in interface AmazonApiGateway
request
- Requests API Gateway to get information about a Deployment resource.public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
AmazonApiGateway
Gets information about a Deployments collection.
getDeployments
in interface AmazonApiGateway
request
- Requests API Gateway to get information about a Deployments collection.public GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest request)
AmazonApiGateway
Gets a documentation part.
getDocumentationPart
in interface AmazonApiGateway
request
- Gets a specified documentation part of a given API.public GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest request)
AmazonApiGateway
Gets documentation parts.
getDocumentationParts
in interface AmazonApiGateway
request
- Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).public GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest request)
AmazonApiGateway
Gets a documentation version.
getDocumentationVersion
in interface AmazonApiGateway
request
- Gets a documentation snapshot of an API.public GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest request)
AmazonApiGateway
Gets documentation versions.
getDocumentationVersions
in interface AmazonApiGateway
request
- Gets the documentation versions of an API.public GetDomainNameResult getDomainName(GetDomainNameRequest request)
AmazonApiGateway
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainName
in interface AmazonApiGateway
request
- Request to get the name of a DomainName resource.public GetDomainNamesResult getDomainNames(GetDomainNamesRequest request)
AmazonApiGateway
Represents a collection of DomainName resources.
getDomainNames
in interface AmazonApiGateway
request
- Request to describe a collection of DomainName resources.public GetExportResult getExport(GetExportRequest request)
AmazonApiGateway
Exports a deployed version of a RestApi in a specified format.
getExport
in interface AmazonApiGateway
request
- Request a new export of a RestApi for a particular Stage.public GetGatewayResponseResult getGatewayResponse(GetGatewayResponseRequest request)
AmazonApiGateway
Gets a GatewayResponse of a specified response type on the given RestApi.
getGatewayResponse
in interface AmazonApiGateway
request
- Gets a GatewayResponse of a specified response type on the given RestApi.public GetGatewayResponsesResult getGatewayResponses(GetGatewayResponsesRequest request)
AmazonApiGateway
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.
getGatewayResponses
in interface AmazonApiGateway
request
- Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any
definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses
collection for the supported response types.public GetIntegrationResult getIntegration(GetIntegrationRequest request)
AmazonApiGateway
Get the integration settings.
getIntegration
in interface AmazonApiGateway
request
- Represents a request to get the integration configuration.public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
AmazonApiGateway
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
request
- Represents a get integration response request.public GetMethodResult getMethod(GetMethodRequest request)
AmazonApiGateway
Describe an existing Method resource.
getMethod
in interface AmazonApiGateway
request
- Request to describe an existing Method resource.public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
AmazonApiGateway
Describes a MethodResponse resource.
getMethodResponse
in interface AmazonApiGateway
request
- Request to describe a MethodResponse resource.public GetModelResult getModel(GetModelRequest request)
AmazonApiGateway
Describes an existing model defined for a RestApi resource.
getModel
in interface AmazonApiGateway
request
- Request to list information about a model in an existing RestApi resource.public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest request)
AmazonApiGateway
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplate
in interface AmazonApiGateway
request
- Request to generate a sample mapping template used to transform the payload.public GetModelsResult getModels(GetModelsRequest request)
AmazonApiGateway
Describes existing Models defined for a RestApi resource.
getModels
in interface AmazonApiGateway
request
- Request to list existing Models defined for a RestApi resource.public GetRequestValidatorResult getRequestValidator(GetRequestValidatorRequest request)
AmazonApiGateway
Gets a RequestValidator of a given RestApi.
getRequestValidator
in interface AmazonApiGateway
request
- Gets a RequestValidator of a given RestApi.public GetRequestValidatorsResult getRequestValidators(GetRequestValidatorsRequest request)
AmazonApiGateway
Gets the RequestValidators collection of a given RestApi.
getRequestValidators
in interface AmazonApiGateway
request
- Gets the RequestValidators collection of a given RestApi.public GetResourceResult getResource(GetResourceRequest request)
AmazonApiGateway
Lists information about a resource.
getResource
in interface AmazonApiGateway
request
- Request to list information about a resource.public GetResourcesResult getResources(GetResourcesRequest request)
AmazonApiGateway
Lists information about a collection of Resource resources.
getResources
in interface AmazonApiGateway
request
- Request to list information about a collection of resources.public GetRestApiResult getRestApi(GetRestApiRequest request)
AmazonApiGateway
Lists the RestApi resource in the collection.
getRestApi
in interface AmazonApiGateway
request
- The GET request to list an existing RestApi defined for your collection.public GetRestApisResult getRestApis(GetRestApisRequest request)
AmazonApiGateway
Lists the RestApis resources for your collection.
getRestApis
in interface AmazonApiGateway
request
- The GET request to list existing RestApis defined for your collection.public GetSdkResult getSdk(GetSdkRequest request)
AmazonApiGateway
Generates a client SDK for a RestApi and Stage.
getSdk
in interface AmazonApiGateway
request
- Request a new generated client SDK for a RestApi and Stage.public GetSdkTypeResult getSdkType(GetSdkTypeRequest request)
AmazonApiGateway
Gets an SDK type.
getSdkType
in interface AmazonApiGateway
request
- Get an SdkType instance.public GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)
AmazonApiGateway
Gets SDK types
getSdkTypes
in interface AmazonApiGateway
request
- Get the SdkTypes collection.public GetStageResult getStage(GetStageRequest request)
AmazonApiGateway
Gets information about a Stage resource.
getStage
in interface AmazonApiGateway
request
- Requests API Gateway to get information about a Stage resource.public GetStagesResult getStages(GetStagesRequest request)
AmazonApiGateway
Gets information about one or more Stage resources.
getStages
in interface AmazonApiGateway
request
- Requests API Gateway to get information about one or more Stage resources.public GetTagsResult getTags(GetTagsRequest request)
AmazonApiGateway
Gets the Tags collection for a given resource.
getTags
in interface AmazonApiGateway
request
- Gets the Tags collection for a given resource.public GetUsageResult getUsage(GetUsageRequest request)
AmazonApiGateway
Gets the usage data of a usage plan in a specified time interval.
getUsage
in interface AmazonApiGateway
request
- The GET request to get the usage data of a usage plan in a specified time interval.public GetUsagePlanResult getUsagePlan(GetUsagePlanRequest request)
AmazonApiGateway
Gets a usage plan of a given plan identifier.
getUsagePlan
in interface AmazonApiGateway
request
- The GET request to get a usage plan of a given plan identifier.public GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest request)
AmazonApiGateway
Gets a usage plan key of a given key identifier.
getUsagePlanKey
in interface AmazonApiGateway
request
- The GET request to get a usage plan key of a given key identifier.public GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest request)
AmazonApiGateway
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeys
in interface AmazonApiGateway
request
- The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.public GetUsagePlansResult getUsagePlans(GetUsagePlansRequest request)
AmazonApiGateway
Gets all the usage plans of the caller's account.
getUsagePlans
in interface AmazonApiGateway
request
- The GET request to get all the usage plans of the caller's account.public GetVpcLinkResult getVpcLink(GetVpcLinkRequest request)
AmazonApiGateway
Gets a specified VPC link under the caller's account in a region.
getVpcLink
in interface AmazonApiGateway
request
- Gets a specified VPC link under the caller's account in a region.public GetVpcLinksResult getVpcLinks(GetVpcLinksRequest request)
AmazonApiGateway
Gets the VpcLinks collection under the caller's account in a selected region.
getVpcLinks
in interface AmazonApiGateway
request
- Gets the VpcLinks collection under the caller's account in a selected region.public ImportApiKeysResult importApiKeys(ImportApiKeysRequest request)
AmazonApiGateway
Import API keys from an external source, such as a CSV-formatted file.
importApiKeys
in interface AmazonApiGateway
request
- The POST request to import API keys from an external source, such as a CSV-formatted file.public ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)
AmazonApiGateway
Imports documentation parts
importDocumentationParts
in interface AmazonApiGateway
request
- Import documentation parts from an external (e.g., OpenAPI) definition file.public ImportRestApiResult importRestApi(ImportRestApiRequest request)
AmazonApiGateway
A feature of the API Gateway control service for creating a new API from an external API definition file.
importRestApi
in interface AmazonApiGateway
request
- A POST request to import an API to API Gateway using an input of an API definition file.public PutGatewayResponseResult putGatewayResponse(PutGatewayResponseRequest request)
AmazonApiGateway
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
putGatewayResponse
in interface AmazonApiGateway
request
- Creates a customization of a GatewayResponse of a specified response type and status code on the given
RestApi.public PutIntegrationResult putIntegration(PutIntegrationRequest request)
AmazonApiGateway
Sets up a method's integration.
putIntegration
in interface AmazonApiGateway
request
- Sets up a method's integration.public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
AmazonApiGateway
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
request
- Represents a put integration response request.public PutMethodResult putMethod(PutMethodRequest request)
AmazonApiGateway
Add a method to an existing Resource resource.
putMethod
in interface AmazonApiGateway
request
- Request to add a method to an existing Resource resource.public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest request)
AmazonApiGateway
Adds a MethodResponse to an existing Method resource.
putMethodResponse
in interface AmazonApiGateway
request
- Request to add a MethodResponse to an existing Method resource.public PutRestApiResult putRestApi(PutRestApiRequest request)
AmazonApiGateway
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.
putRestApi
in interface AmazonApiGateway
request
- A PUT request to update an existing API, with external API definitions specified as the request body.public TagResourceResult tagResource(TagResourceRequest request)
AmazonApiGateway
Adds or updates a tag on a given resource.
tagResource
in interface AmazonApiGateway
request
- Adds or updates a tag on a given resource.public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
AmazonApiGateway
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizer
in interface AmazonApiGateway
request
- Make a request to simulate the invocation of an Authorizer.public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
AmazonApiGateway
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethod
in interface AmazonApiGateway
request
- Make a request to simulate the invocation of a Method.public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonApiGateway
Removes a tag from a given resource.
untagResource
in interface AmazonApiGateway
request
- Removes a tag from a given resource.public UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonApiGateway
Changes information about the current Account resource.
updateAccount
in interface AmazonApiGateway
request
- Requests API Gateway to change information about the current Account resource.public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
AmazonApiGateway
Changes information about an ApiKey resource.
updateApiKey
in interface AmazonApiGateway
request
- A request to change information about an ApiKey resource.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
AmazonApiGateway
Updates an existing Authorizer resource.
updateAuthorizer
in interface AmazonApiGateway
request
- Request to update an existing Authorizer resource.public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
AmazonApiGateway
Changes information about the BasePathMapping resource.
updateBasePathMapping
in interface AmazonApiGateway
request
- A request to change information about the BasePathMapping resource.public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request)
AmazonApiGateway
Changes information about an ClientCertificate resource.
updateClientCertificate
in interface AmazonApiGateway
request
- A request to change information about an ClientCertificate resource.public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
AmazonApiGateway
Changes information about a Deployment resource.
updateDeployment
in interface AmazonApiGateway
request
- Requests API Gateway to change information about a Deployment resource.public UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest request)
AmazonApiGateway
Updates a documentation part.
updateDocumentationPart
in interface AmazonApiGateway
request
- Updates an existing documentation part of a given API.public UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest request)
AmazonApiGateway
Updates a documentation version.
updateDocumentationVersion
in interface AmazonApiGateway
request
- Updates an existing documentation version of an API.public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
AmazonApiGateway
Changes information about the DomainName resource.
updateDomainName
in interface AmazonApiGateway
request
- A request to change information about the DomainName resource.public UpdateGatewayResponseResult updateGatewayResponse(UpdateGatewayResponseRequest request)
AmazonApiGateway
Updates a GatewayResponse of a specified response type on the given RestApi.
updateGatewayResponse
in interface AmazonApiGateway
request
- Updates a GatewayResponse of a specified response type on the given RestApi.public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
AmazonApiGateway
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
request
- Represents an update integration request.public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
AmazonApiGateway
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
request
- Represents an update integration response request.public UpdateMethodResult updateMethod(UpdateMethodRequest request)
AmazonApiGateway
Updates an existing Method resource.
updateMethod
in interface AmazonApiGateway
request
- Request to update an existing Method resource.public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
AmazonApiGateway
Updates an existing MethodResponse resource.
updateMethodResponse
in interface AmazonApiGateway
request
- A request to update an existing MethodResponse resource.public UpdateModelResult updateModel(UpdateModelRequest request)
AmazonApiGateway
Changes information about a model. The maximum size of the model is 400 KB.
updateModel
in interface AmazonApiGateway
request
- Request to update an existing model in an existing RestApi resource.public UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest request)
AmazonApiGateway
Updates a RequestValidator of a given RestApi.
updateRequestValidator
in interface AmazonApiGateway
request
- Updates a RequestValidator of a given RestApi.public UpdateResourceResult updateResource(UpdateResourceRequest request)
AmazonApiGateway
Changes information about a Resource resource.
updateResource
in interface AmazonApiGateway
request
- Request to change information about a Resource resource.public UpdateRestApiResult updateRestApi(UpdateRestApiRequest request)
AmazonApiGateway
Changes information about the specified API.
updateRestApi
in interface AmazonApiGateway
request
- Request to update an existing RestApi resource in your collection.public UpdateStageResult updateStage(UpdateStageRequest request)
AmazonApiGateway
Changes information about a Stage resource.
updateStage
in interface AmazonApiGateway
request
- Requests API Gateway to change information about a Stage resource.public UpdateUsageResult updateUsage(UpdateUsageRequest request)
AmazonApiGateway
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
updateUsage
in interface AmazonApiGateway
request
- The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a
specified API key.public UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest request)
AmazonApiGateway
Updates a usage plan of a given plan Id.
updateUsagePlan
in interface AmazonApiGateway
request
- The PATCH request to update a usage plan of a given plan Id.public UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest request)
AmazonApiGateway
Updates an existing VpcLink of a specified identifier.
updateVpcLink
in interface AmazonApiGateway
request
- Updates an existing VpcLink of a specified identifier.public void shutdown()
AmazonApiGateway
shutdown
in interface AmazonApiGateway
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonApiGateway
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonApiGateway
request
- The originally executed request.