public interface AmazonApiGateway
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonApiGateway instead.
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
|
CreateBasePathMappingResult |
createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
CreateDocumentationPartResult |
createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest) |
CreateDocumentationVersionResult |
createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest) |
CreateDomainNameResult |
createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
|
CreateModelResult |
createModel(CreateModelRequest createModelRequest)
|
CreateResourceResult |
createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
|
CreateRestApiResult |
createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
|
CreateStageResult |
createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
CreateUsagePlanResult |
createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
payload.
|
CreateUsagePlanKeyResult |
createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
|
DeleteApiKeyResult |
deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
|
DeleteBasePathMappingResult |
deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
|
DeleteClientCertificateResult |
deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
|
DeleteDeploymentResult |
deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource.
|
DeleteDocumentationPartResult |
deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest) |
DeleteDocumentationVersionResult |
deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest) |
DeleteDomainNameResult |
deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
|
DeleteIntegrationResponseResult |
deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
|
DeleteMethodResult |
deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
|
DeleteMethodResponseResult |
deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
|
DeleteModelResult |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
|
DeleteRestApiResult |
deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
|
DeleteStageResult |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
|
DeleteUsagePlanResult |
deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
|
DeleteUsagePlanKeyResult |
deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
FlushStageAuthorizersCacheResult |
flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
|
FlushStageCacheResult |
flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
|
GenerateClientCertificateResult |
generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
|
GetAccountResult |
getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
|
GetApiKeyResult |
getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
|
GetApiKeysResult |
getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
|
GetAuthorizerResult |
getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
|
GetAuthorizersResult |
getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
|
GetBasePathMappingResult |
getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
|
GetBasePathMappingsResult |
getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
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 getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
|
GetClientCertificatesResult |
getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
|
GetDeploymentsResult |
getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
|
GetDocumentationPartResult |
getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest) |
GetDocumentationPartsResult |
getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest) |
GetDocumentationVersionResult |
getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest) |
GetDocumentationVersionsResult |
getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest) |
GetDomainNameResult |
getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
GetDomainNamesResult |
getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
|
GetExportResult |
getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
|
GetIntegrationResponseResult |
getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
|
GetMethodResult |
getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
|
GetMethodResponseResult |
getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
|
GetModelResult |
getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
|
GetModelsResult |
getModels(GetModelsRequest getModelsRequest)
|
GetModelTemplateResult |
getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
GetResourceResult |
getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
|
GetResourcesResult |
getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
|
GetRestApiResult |
getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
|
GetRestApisResult |
getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
|
GetSdkResult |
getSdk(GetSdkRequest getSdkRequest)
|
GetStageResult |
getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
|
GetStagesResult |
getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
|
GetUsageResult |
getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
|
GetUsagePlanResult |
getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
|
GetUsagePlanKeyResult |
getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
|
GetUsagePlanKeysResult |
getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
GetUsagePlansResult |
getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
ImportApiKeysResult |
importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
|
ImportDocumentationPartsResult |
importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest) |
ImportRestApiResult |
importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
|
PutIntegrationResponseResult |
putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
|
PutMethodResult |
putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
|
PutMethodResponseResult |
putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
|
PutRestApiResult |
putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the Amazon 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
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.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming
request body.
|
TestInvokeMethodResult |
testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
|
UpdateAccountResult |
updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
|
UpdateApiKeyResult |
updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
|
UpdateBasePathMappingResult |
updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
|
UpdateClientCertificateResult |
updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
|
UpdateDeploymentResult |
updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
|
UpdateDocumentationPartResult |
updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest) |
UpdateDocumentationVersionResult |
updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest) |
UpdateDomainNameResult |
updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
|
UpdateIntegrationResult |
updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
|
UpdateIntegrationResponseResult |
updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
|
UpdateMethodResult |
updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
|
UpdateMethodResponseResult |
updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
|
UpdateModelResult |
updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
|
UpdateRestApiResult |
updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
|
UpdateStageResult |
updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
|
UpdateUsageResult |
updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
|
UpdateUsagePlanResult |
updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
|
static final String ENDPOINT_PREFIX
void setEndpoint(String endpoint)
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
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.void setRegion(Region region)
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.
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)CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
createApiKeyRequest - Request to create an ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionBadRequestExceptionConflictExceptionCreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionCreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
createBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.UnauthorizedExceptionConflictExceptionBadRequestExceptionNotFoundExceptionTooManyRequestsExceptionCreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeploymentRequest - Requests Amazon API Gateway to create a Deployment resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionServiceUnavailableExceptionCreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
createDocumentationPartRequest - Creates a new documentation part of a given API.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionCreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
createDocumentationVersionRequest - Creates a new documentation version of a given API.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionCreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
createDomainNameRequest - A request to create a new domain name.UnauthorizedExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionCreateModelResult createModel(CreateModelRequest createModelRequest)
createModelRequest - Request to add a new Model to an existing RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionCreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
createResourceRequest - Requests Amazon API Gateway to create a Resource resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionCreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
createRestApiRequest - The POST Request to add a new RestApi resource to your collection.UnauthorizedExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionCreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStageRequest - Requests Amazon API Gateway to create a Stage resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionCreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
createUsagePlanRequest - The POST request to create a usage plan with the name, description, throttle limits and quota limits, as
well as the associated API stages, specified in the payload.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionConflictExceptionNotFoundExceptionCreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionDeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
deleteApiKeyRequest - A request to delete the ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionDeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
deleteAuthorizerRequest - Request to delete an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionDeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionDeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
deleteClientCertificateRequest - A request to delete the ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionDeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeploymentRequest - Requests Amazon API Gateway to delete a Deployment resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionDeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
deleteDocumentationPartRequest - Deletes an existing documentation part of an API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionBadRequestExceptionDeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
deleteDocumentationVersionRequest - Deletes an existing documentation version of an API.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionDeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
deleteDomainNameRequest - A request to delete the DomainName resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionDeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
deleteIntegrationRequest - Represents a delete integration request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionDeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
deleteIntegrationResponseRequest - Represents a delete integration response request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionDeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
deleteMethodRequest - Request to delete an existing Method resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionDeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionDeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
deleteModelRequest - Request to delete an existing model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionDeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
deleteResourceRequest - Request to delete a Resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionDeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
deleteRestApiRequest - Request to delete the specified API from your collection.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionDeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
deleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionDeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
deleteUsagePlanRequest - The DELETE request to delete a uasge plan of a given plan Id.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionDeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionFlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionFlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
flushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionGenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
generateClientCertificateRequest - A request to generate a ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionGetAccountResult getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
getAccountRequest - Requests Amazon API Gateway to get information about the current Account resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
getApiKeyRequest - A request to get information about the current ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
getApiKeysRequest - A request to get information about the current ApiKeys resource.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionGetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
getAuthorizerRequest - Request to describe an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
getAuthorizersRequest - Request to describe an existing Authorizers resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
getBasePathMappingRequest - Request to describe a BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
getClientCertificateRequest - A request to get information about the current ClientCertificate resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionGetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
getDeploymentRequest - Requests Amazon API Gateway to get information about a Deployment resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionServiceUnavailableExceptionGetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
getDeploymentsRequest - Requests Amazon API Gateway to get information about a Deployments collection.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionServiceUnavailableExceptionGetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
getDocumentationPartRequest - Gets a specified documentation part of a given API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
getDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
getDocumentationVersionRequest - Gets a documentation snapshot of an API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
getDocumentationVersionsRequest - Gets the documentation versions of an API.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainNameRequest - Request to get the name of a DomainName resource.UnauthorizedExceptionNotFoundExceptionServiceUnavailableExceptionTooManyRequestsExceptionGetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
getDomainNamesRequest - Request to describe a collection of DomainName resources.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionGetExportResult getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
getExportRequest - Request a new export of a RestApi for a particular Stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionGetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
getIntegrationRequest - Represents a get integration request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
getIntegrationResponseRequest - Represents a get integration response request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetMethodResult getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
getMethodRequest - Request to describe an existing Method resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
getMethodResponseRequest - Request to describe a MethodResponse resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetModelResult getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
getModelRequest - Request to list information about a model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionGetModelsResult getModels(GetModelsRequest getModelsRequest)
getModelsRequest - Request to list existing Models defined for a RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetResourceResult getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
getResourceRequest - Request to list information about a resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
getResourcesRequest - Request to list information about a collection of resources.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
getRestApiRequest - The GET request to list an existing RestApi defined for your collection.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
getRestApisRequest - The GET request to list existing RestApis defined for your collection.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionGetSdkResult getSdk(GetSdkRequest getSdkRequest)
getSdkRequest - Request a new generated client SDK for a RestApi and Stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionGetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
getStageRequest - Requests Amazon API Gateway to get information about a Stage resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
getStagesRequest - Requests Amazon API Gateway to get information about one or more Stage resources.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetUsageResult getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetUsagePlanResult getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionGetUsagePlansResult getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionConflictExceptionNotFoundExceptionImportApiKeysResult importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionBadRequestExceptionConflictExceptionImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
importDocumentationPartsRequest - Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionLimitExceededExceptionTooManyRequestsExceptionImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
importRestApiRequest - A POST request to import an API to Amazon API Gateway using an input of an API definition file.UnauthorizedExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionPutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
putIntegrationRequest - Represents a put integration request.UnauthorizedExceptionBadRequestExceptionConflictExceptionNotFoundExceptionTooManyRequestsExceptionPutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
putIntegrationResponseRequest - Represents a put integration response request.UnauthorizedExceptionNotFoundExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionPutMethodResult putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
putMethodRequest - Request to add a method to an existing Resource resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionPutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionPutRestApiResult putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.UnauthorizedExceptionLimitExceededExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionTestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionTestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethodRequest - Make a request to simulate the execution of a Method.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionUpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
updateAccountRequest - Requests Amazon API Gateway to change information about the current Account resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionTooManyRequestsExceptionUpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
updateApiKeyRequest - A request to change information about an ApiKey resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionUpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
updateAuthorizerRequest - Request to update an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionUpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
updateClientCertificateRequest - A request to change information about an ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionUpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
updateDeploymentRequest - Requests Amazon API Gateway to change information about a Deployment resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionServiceUnavailableExceptionUpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
updateDocumentationPartRequest - Updates an existing documentation part of a given API.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionUpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
updateDocumentationVersionRequest - Updates an existing documentation version of an API.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
updateDomainNameRequest - A request to change information about the DomainName resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionUpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
updateIntegrationRequest - Represents an update integration request.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionUpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
updateIntegrationResponseRequest - Represents an update integration response request.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
updateMethodRequest - Request to update an existing Method resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionUpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
updateMethodResponseRequest - A request to update an existing MethodResponse resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionUpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
updateModelRequest - Request to update an existing model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionUpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
updateResourceRequest - Request to change information about a Resource resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
updateRestApiRequest - Request to update an existing RestApi resource in your collection.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
updateStageRequest - Requests Amazon API Gateway to change information about a Stage resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionUpdateUsageResult updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
updateUsageRequest - The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a
specified API key.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionUpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionConflictExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.