Interface AmazonApiGateway
-
- All Known Subinterfaces:
AmazonApiGatewayAsync
- All Known Implementing Classes:
AbstractAmazonApiGateway
,AbstractAmazonApiGatewayAsync
,AmazonApiGatewayAsyncClient
,AmazonApiGatewayClient
public interface AmazonApiGateway
Interface for accessing Amazon API Gateway.Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.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.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.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.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.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.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 tosetEndpoint(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.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.
-
-
-
Method Detail
-
setEndpoint
void setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.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.
- Parameters:
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.
-
setRegion
void setRegion(Region region)
An alternative tosetEndpoint(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.
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
createApiKey
CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
- Parameters:
createApiKeyRequest
- Request to create an ApiKey resource.- Returns:
- Result of the CreateApiKey operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
LimitExceededException
BadRequestException
-
createAuthorizer
CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
- Parameters:
createAuthorizerRequest
- Request to add a new Authorizer to an existing RestApi resource.- Returns:
- Result of the CreateAuthorizer operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
LimitExceededException
TooManyRequestsException
-
createBasePathMapping
CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
- Parameters:
createBasePathMappingRequest
- Requests Amazon API Gateway to create a new BasePathMapping resource.- Returns:
- Result of the CreateBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
ConflictException
BadRequestException
NotFoundException
TooManyRequestsException
-
createDeployment
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
- Parameters:
createDeploymentRequest
- Requests Amazon API Gateway to create a Deployment resource.- Returns:
- Result of the CreateDeployment operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
ServiceUnavailableException
-
createDomainName
CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
- Parameters:
createDomainNameRequest
- A request to create a new domain name.- Returns:
- Result of the CreateDomainName operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
ConflictException
TooManyRequestsException
-
createModel
CreateModelResult createModel(CreateModelRequest createModelRequest)
- Parameters:
createModelRequest
- Request to add a new Model to an existing RestApi resource.- Returns:
- Result of the CreateModel operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
-
createResource
CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
- Parameters:
createResourceRequest
- Requests Amazon API Gateway to create a Resource resource.- Returns:
- Result of the CreateResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
-
createRestApi
CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
- Parameters:
createRestApiRequest
- The POST Request to add a new RestApi resource to your collection.- Returns:
- Result of the CreateRestApi operation returned by the service.
- Throws:
UnauthorizedException
LimitExceededException
BadRequestException
TooManyRequestsException
-
createStage
CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
- Parameters:
createStageRequest
- Requests Amazon API Gateway to create a Stage resource.- Returns:
- Result of the CreateStage operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
-
deleteApiKey
DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
- Parameters:
deleteApiKeyRequest
- A request to delete the ApiKey resource.- Returns:
- Result of the DeleteApiKey operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteAuthorizer
DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
- Parameters:
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.- Returns:
- Result of the DeleteAuthorizer operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
-
deleteBasePathMapping
DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
- Parameters:
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.- Returns:
- Result of the DeleteBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteClientCertificate
DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
- Parameters:
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.- Returns:
- Result of the DeleteClientCertificate operation returned by the service.
- Throws:
UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
-
deleteDeployment
DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
- Parameters:
deleteDeploymentRequest
- Requests Amazon API Gateway to delete a Deployment resource.- Returns:
- Result of the DeleteDeployment operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
deleteDomainName
DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
- Parameters:
deleteDomainNameRequest
- A request to delete the DomainName resource.- Returns:
- Result of the DeleteDomainName operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteIntegration
DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
- Parameters:
deleteIntegrationRequest
- Represents a delete integration request.- Returns:
- Result of the DeleteIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteIntegrationResponse
DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
- Parameters:
deleteIntegrationResponseRequest
- Represents a delete integration response request.- Returns:
- Result of the DeleteIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteMethod
DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
- Parameters:
deleteMethodRequest
- Request to delete an existing Method resource.- Returns:
- Result of the DeleteMethod operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteMethodResponse
DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
- Parameters:
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.- Returns:
- Result of the DeleteMethodResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteModel
DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
- Parameters:
deleteModelRequest
- Request to delete an existing model in an existing RestApi resource.- Returns:
- Result of the DeleteModel operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
-
deleteResource
DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
- Parameters:
deleteResourceRequest
- Request to delete a Resource.- Returns:
- Result of the DeleteResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
-
deleteRestApi
DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
- Parameters:
deleteRestApiRequest
- Request to delete the specified API from your collection.- Returns:
- Result of the DeleteRestApi operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
-
deleteStage
DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
- Parameters:
deleteStageRequest
- Requests Amazon API Gateway to delete a Stage resource.- Returns:
- Result of the DeleteStage operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
-
flushStageAuthorizersCache
FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
- Parameters:
flushStageAuthorizersCacheRequest
- Request to flush authorizer cache entries on a specified stage.- Returns:
- Result of the FlushStageAuthorizersCache operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
flushStageCache
FlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
- Parameters:
flushStageCacheRequest
- Requests Amazon API Gateway to flush a stage's cache.- Returns:
- Result of the FlushStageCache operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
generateClientCertificate
GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
- Parameters:
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.- Returns:
- Result of the GenerateClientCertificate operation returned by the service.
- Throws:
UnauthorizedException
TooManyRequestsException
LimitExceededException
-
getAccount
GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
- Parameters:
getAccountRequest
- Requests Amazon API Gateway to get information about the current Account resource.- Returns:
- Result of the GetAccount operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getApiKey
GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
- Parameters:
getApiKeyRequest
- A request to get information about the current ApiKey resource.- Returns:
- Result of the GetApiKey operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getApiKeys
GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
- Parameters:
getApiKeysRequest
- A request to get information about the current ApiKeys resource.- Returns:
- Result of the GetApiKeys operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
TooManyRequestsException
-
getAuthorizer
GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
- Parameters:
getAuthorizerRequest
- Request to describe an existing Authorizer resource.- Returns:
- Result of the GetAuthorizer operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getAuthorizers
GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
- Parameters:
getAuthorizersRequest
- Request to describe an existing Authorizers resource.- Returns:
- Result of the GetAuthorizers operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getBasePathMapping
GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
- Parameters:
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.- Returns:
- Result of the GetBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getBasePathMappings
GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
- Parameters:
getBasePathMappingsRequest
- A request to get information about a collection of BasePathMapping resources.- Returns:
- Result of the GetBasePathMappings operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getClientCertificate
GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
- Parameters:
getClientCertificateRequest
- A request to get information about the current ClientCertificate resource.- Returns:
- Result of the GetClientCertificate operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getClientCertificates
GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
- Parameters:
getClientCertificatesRequest
- A request to get information about a collection of ClientCertificate resources.- Returns:
- Result of the GetClientCertificates operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
TooManyRequestsException
-
getDeployment
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
- Parameters:
getDeploymentRequest
- Requests Amazon API Gateway to get information about a Deployment resource.- Returns:
- Result of the GetDeployment operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
ServiceUnavailableException
-
getDeployments
GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
- Parameters:
getDeploymentsRequest
- Requests Amazon API Gateway to get information about a Deployments collection.- Returns:
- Result of the GetDeployments operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
TooManyRequestsException
ServiceUnavailableException
-
getDomainName
GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
- Parameters:
getDomainNameRequest
- Request to get the name of a DomainName resource.- Returns:
- Result of the GetDomainName operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ServiceUnavailableException
TooManyRequestsException
-
getDomainNames
GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
- Parameters:
getDomainNamesRequest
- Request to describe a collection of DomainName resources.- Returns:
- Result of the GetDomainNames operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
TooManyRequestsException
-
getExport
GetExportResult getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
- Parameters:
getExportRequest
- Request a new export of a RestApi for a particular Stage.- Returns:
- Result of the GetExport operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
getIntegration
GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
- Parameters:
getIntegrationRequest
- Represents a get integration request.- Returns:
- Result of the GetIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getIntegrationResponse
GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
- Parameters:
getIntegrationResponseRequest
- Represents a get integration response request.- Returns:
- Result of the GetIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getMethod
GetMethodResult getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
- Parameters:
getMethodRequest
- Request to describe an existing Method resource.- Returns:
- Result of the GetMethod operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getMethodResponse
GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
- Parameters:
getMethodResponseRequest
- Request to describe a MethodResponse resource.- Returns:
- Result of the GetMethodResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getModel
GetModelResult getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
- Parameters:
getModelRequest
- Request to list information about a model in an existing RestApi resource.- Returns:
- Result of the GetModel operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getModelTemplate
GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
- Parameters:
getModelTemplateRequest
- Request to generate a sample mapping template used to transform the payload.- Returns:
- Result of the GetModelTemplate operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
getModels
GetModelsResult getModels(GetModelsRequest getModelsRequest)
- Parameters:
getModelsRequest
- Request to list existing Models defined for a RestApi resource.- Returns:
- Result of the GetModels operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getResource
GetResourceResult getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
- Parameters:
getResourceRequest
- Request to list information about a resource.- Returns:
- Result of the GetResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getResources
GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
- Parameters:
getResourcesRequest
- Request to list information about a collection of resources.- Returns:
- Result of the GetResources operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getRestApi
GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
- Parameters:
getRestApiRequest
- The GET request to list an existing RestApi defined for your collection.- Returns:
- Result of the GetRestApi operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getRestApis
GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
- Parameters:
getRestApisRequest
- The GET request to list existing RestApis defined for your collection.- Returns:
- Result of the GetRestApis operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
TooManyRequestsException
-
getSdk
GetSdkResult getSdk(GetSdkRequest getSdkRequest)
- Parameters:
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.- Returns:
- Result of the GetSdk operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
getStage
GetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
- Parameters:
getStageRequest
- Requests Amazon API Gateway to get information about a Stage resource.- Returns:
- Result of the GetStage operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getStages
GetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
- Parameters:
getStagesRequest
- Requests Amazon API Gateway to get information about one or more Stage resources.- Returns:
- Result of the GetStages operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
importRestApi
ImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
- Parameters:
importRestApiRequest
- A POST request to import an API to Amazon API Gateway using an input of an API definition file.- Returns:
- Result of the ImportRestApi operation returned by the service.
- Throws:
UnauthorizedException
LimitExceededException
BadRequestException
TooManyRequestsException
-
putIntegration
PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
- Parameters:
putIntegrationRequest
- Represents a put integration request.- Returns:
- Result of the PutIntegration operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
ConflictException
NotFoundException
TooManyRequestsException
-
putIntegrationResponse
PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
- Parameters:
putIntegrationResponseRequest
- Represents a put integration response request.- Returns:
- Result of the PutIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
LimitExceededException
BadRequestException
TooManyRequestsException
ConflictException
-
putMethod
PutMethodResult putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
- Parameters:
putMethodRequest
- Request to add a method to an existing Resource resource.- Returns:
- Result of the PutMethod operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
-
putMethodResponse
PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
- Parameters:
putMethodResponseRequest
- Request to add a MethodResponse to an existing Method resource.- Returns:
- Result of the PutMethodResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
-
putRestApi
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. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
- Parameters:
putRestApiRequest
- A PUT request to update an existing API, with external API definitions specified as the request body.- Returns:
- Result of the PutRestApi operation returned by the service.
- Throws:
UnauthorizedException
LimitExceededException
NotFoundException
BadRequestException
TooManyRequestsException
-
testInvokeAuthorizer
TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
- Parameters:
testInvokeAuthorizerRequest
- Make a request to simulate the execution of an Authorizer.- Returns:
- Result of the TestInvokeAuthorizer operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
-
testInvokeMethod
TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
- Parameters:
testInvokeMethodRequest
- Make a request to simulate the execution of a Method.- Returns:
- Result of the TestInvokeMethod operation returned by the service.
- Throws:
BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
-
updateAccount
UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
- Parameters:
updateAccountRequest
- Requests Amazon API Gateway to change information about the current Account resource.- Returns:
- Result of the UpdateAccount operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
NotFoundException
TooManyRequestsException
-
updateApiKey
UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
- Parameters:
updateApiKeyRequest
- A request to change information about an ApiKey resource.- Returns:
- Result of the UpdateApiKey operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
updateAuthorizer
UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
- Parameters:
updateAuthorizerRequest
- Request to update an existing Authorizer resource.- Returns:
- Result of the UpdateAuthorizer operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
-
updateBasePathMapping
UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
- Parameters:
updateBasePathMappingRequest
- A request to change information about the BasePathMapping resource.- Returns:
- Result of the UpdateBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
-
updateClientCertificate
UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
- Parameters:
updateClientCertificateRequest
- A request to change information about an ClientCertificate resource.- Returns:
- Result of the UpdateClientCertificate operation returned by the service.
- Throws:
UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
-
updateDeployment
UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
- Parameters:
updateDeploymentRequest
- Requests Amazon API Gateway to change information about a Deployment resource.- Returns:
- Result of the UpdateDeployment operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ServiceUnavailableException
-
updateDomainName
UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
- Parameters:
updateDomainNameRequest
- A request to change information about the DomainName resource.- Returns:
- Result of the UpdateDomainName operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
-
updateIntegration
UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
- Parameters:
updateIntegrationRequest
- Represents an update integration request.- Returns:
- Result of the UpdateIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ConflictException
-
updateIntegrationResponse
UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
- Parameters:
updateIntegrationResponseRequest
- Represents an update integration response request.- Returns:
- Result of the UpdateIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
-
updateMethod
UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
- Parameters:
updateMethodRequest
- Request to update an existing Method resource.- Returns:
- Result of the UpdateMethod operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
-
updateMethodResponse
UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
- Parameters:
updateMethodResponseRequest
- A request to update an existing MethodResponse resource.- Returns:
- Result of the UpdateMethodResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
-
updateModel
UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
- Parameters:
updateModelRequest
- Request to update an existing model in an existing RestApi resource.- Returns:
- Result of the UpdateModel operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
-
updateResource
UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
- Parameters:
updateResourceRequest
- Request to change information about a Resource resource.- Returns:
- Result of the UpdateResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
-
updateRestApi
UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
- Parameters:
updateRestApiRequest
- Request to update an existing RestApi resource in your collection.- Returns:
- Result of the UpdateRestApi operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
-
updateStage
UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
- Parameters:
updateStageRequest
- Requests Amazon API Gateway to change information about a Stage resource.- Returns:
- Result of the UpdateStage operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
-
shutdown
void shutdown()
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.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.
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-