Class AmazonApiGatewayClient
- All Implemented Interfaces:
AmazonApiGateway
- Direct Known Subclasses:
AmazonApiGatewayAsyncClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on Amazon API Gateway.AmazonApiGatewayClient
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials.AmazonApiGatewayClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider.AmazonApiGatewayClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider and client configuration options.AmazonApiGatewayClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonApiGatewayClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials and client configuration options.AmazonApiGatewayClient
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway. -
Method Summary
Modifier and TypeMethodDescriptioncreateApiKey
(CreateApiKeyRequest createApiKeyRequest) Create an ApiKey resource.createAuthorizer
(CreateAuthorizerRequest createAuthorizerRequest) Adds a new Authorizer resource to an existing RestApi resource.createBasePathMapping
(CreateBasePathMappingRequest createBasePathMappingRequest) Creates a new BasePathMapping resource.createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates a Deployment resource, which makes a specified RestApi callable over the internet.createDomainName
(CreateDomainNameRequest createDomainNameRequest) Creates a new domain name.createModel
(CreateModelRequest createModelRequest) createResource
(CreateResourceRequest createResourceRequest) Creates a Resource resource.createRestApi
(CreateRestApiRequest createRestApiRequest) Creates a new RestApi resource.createStage
(CreateStageRequest createStageRequest) Creates a new Stage resource that references a pre-existing Deployment for the API.deleteApiKey
(DeleteApiKeyRequest deleteApiKeyRequest) Deletes the ApiKey resource.deleteAuthorizer
(DeleteAuthorizerRequest deleteAuthorizerRequest) Deletes an existing Authorizer resource.deleteBasePathMapping
(DeleteBasePathMappingRequest deleteBasePathMappingRequest) Deletes the BasePathMapping resource.deleteClientCertificate
(DeleteClientCertificateRequest deleteClientCertificateRequest) Deletes the ClientCertificate resource.deleteDeployment
(DeleteDeploymentRequest deleteDeploymentRequest) Deletes a Deployment resource.deleteDomainName
(DeleteDomainNameRequest deleteDomainNameRequest) Deletes the DomainName resource.deleteIntegration
(DeleteIntegrationRequest deleteIntegrationRequest) Represents a delete integration.deleteIntegrationResponse
(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest) Represents a delete integration response.deleteMethod
(DeleteMethodRequest deleteMethodRequest) Deletes an existing Method resource.deleteMethodResponse
(DeleteMethodResponseRequest deleteMethodResponseRequest) Deletes an existing MethodResponse resource.deleteModel
(DeleteModelRequest deleteModelRequest) Deletes a model.deleteResource
(DeleteResourceRequest deleteResourceRequest) Deletes a Resource resource.deleteRestApi
(DeleteRestApiRequest deleteRestApiRequest) Deletes the specified API.deleteStage
(DeleteStageRequest deleteStageRequest) Deletes a Stage resource.flushStageAuthorizersCache
(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest) Flushes all authorizer cache entries on a stage.flushStageCache
(FlushStageCacheRequest flushStageCacheRequest) Flushes a stage's cache.generateClientCertificate
(GenerateClientCertificateRequest generateClientCertificateRequest) Generates a ClientCertificate resource.getAccount
(GetAccountRequest getAccountRequest) Gets information about the current Account resource.getApiKey
(GetApiKeyRequest getApiKeyRequest) Gets information about the current ApiKey resource.getApiKeys
(GetApiKeysRequest getApiKeysRequest) Gets information about the current ApiKeys resource.getAuthorizer
(GetAuthorizerRequest getAuthorizerRequest) Describe an existing Authorizer resource.getAuthorizers
(GetAuthorizersRequest getAuthorizersRequest) Describe an existing Authorizers resource.getBasePathMapping
(GetBasePathMappingRequest getBasePathMappingRequest) Describe a BasePathMapping resource.getBasePathMappings
(GetBasePathMappingsRequest getBasePathMappingsRequest) Represents a collection of BasePathMapping resources.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.getClientCertificate
(GetClientCertificateRequest getClientCertificateRequest) Gets information about the current ClientCertificate resource.getClientCertificates
(GetClientCertificatesRequest getClientCertificatesRequest) Gets a collection of ClientCertificate resources.getDeployment
(GetDeploymentRequest getDeploymentRequest) Gets information about a Deployment resource.getDeployments
(GetDeploymentsRequest getDeploymentsRequest) Gets information about a Deployments collection.getDomainName
(GetDomainNameRequest getDomainNameRequest) Represents a domain name that is contained in a simpler, more intuitive URL that can be called.getDomainNames
(GetDomainNamesRequest getDomainNamesRequest) Represents a collection of DomainName resources.getExport
(GetExportRequest getExportRequest) Exports a deployed version of a RestApi in a specified format.getIntegration
(GetIntegrationRequest getIntegrationRequest) Represents a get integration.getIntegrationResponse
(GetIntegrationResponseRequest getIntegrationResponseRequest) Represents a get integration response.getMethod
(GetMethodRequest getMethodRequest) Describe an existing Method resource.getMethodResponse
(GetMethodResponseRequest getMethodResponseRequest) Describes a MethodResponse resource.getModel
(GetModelRequest getModelRequest) Describes an existing model defined for a RestApi resource.getModels
(GetModelsRequest getModelsRequest) getModelTemplate
(GetModelTemplateRequest getModelTemplateRequest) Generates a sample mapping template that can be used to transform a payload into the structure of a model.getResource
(GetResourceRequest getResourceRequest) Lists information about a resource.getResources
(GetResourcesRequest getResourcesRequest) Lists information about a collection of Resource resources.getRestApi
(GetRestApiRequest getRestApiRequest) Lists the RestApi resource in the collection.getRestApis
(GetRestApisRequest getRestApisRequest) Lists the RestApis resources for your collection.getSdk
(GetSdkRequest getSdkRequest) getStage
(GetStageRequest getStageRequest) Gets information about a Stage resource.getStages
(GetStagesRequest getStagesRequest) Gets information about one or more Stage resources.importRestApi
(ImportRestApiRequest importRestApiRequest) A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.putIntegration
(PutIntegrationRequest putIntegrationRequest) Represents a put integration.putIntegrationResponse
(PutIntegrationResponseRequest putIntegrationResponseRequest) Represents a put integration.putMethod
(PutMethodRequest putMethodRequest) Add a method to an existing Resource resource.putMethodResponse
(PutMethodResponseRequest putMethodResponseRequest) Adds a MethodResponse to an existing Method resource.putRestApi
(PutRestApiRequest putRestApiRequest) A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions.testInvokeAuthorizer
(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.testInvokeMethod
(TestInvokeMethodRequest testInvokeMethodRequest) updateAccount
(UpdateAccountRequest updateAccountRequest) Changes information about the current Account resource.updateApiKey
(UpdateApiKeyRequest updateApiKeyRequest) Changes information about an ApiKey resource.updateAuthorizer
(UpdateAuthorizerRequest updateAuthorizerRequest) Updates an existing Authorizer resource.updateBasePathMapping
(UpdateBasePathMappingRequest updateBasePathMappingRequest) Changes information about the BasePathMapping resource.updateClientCertificate
(UpdateClientCertificateRequest updateClientCertificateRequest) Changes information about an ClientCertificate resource.updateDeployment
(UpdateDeploymentRequest updateDeploymentRequest) Changes information about a Deployment resource.updateDomainName
(UpdateDomainNameRequest updateDomainNameRequest) Changes information about the DomainName resource.updateIntegration
(UpdateIntegrationRequest updateIntegrationRequest) Represents an update integration.updateIntegrationResponse
(UpdateIntegrationResponseRequest updateIntegrationResponseRequest) Represents an update integration response.updateMethod
(UpdateMethodRequest updateMethodRequest) Updates an existing Method resource.updateMethodResponse
(UpdateMethodResponseRequest updateMethodResponseRequest) Updates an existing MethodResponse resource.updateModel
(UpdateModelRequest updateModelRequest) Changes information about a model.updateResource
(UpdateResourceRequest updateResourceRequest) Changes information about a Resource resource.updateRestApi
(UpdateRestApiRequest updateRestApiRequest) Changes information about the specified API.updateStage
(UpdateStageRequest updateStageRequest) Changes information about a Stage resource.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Details
-
AmazonApiGatewayClient
public AmazonApiGatewayClient()Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AmazonApiGatewayClient
Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).- See Also:
-
AmazonApiGatewayClient
Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonApiGatewayClient
public AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).
-
AmazonApiGatewayClient
Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonApiGatewayClient
public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).
-
AmazonApiGatewayClient
public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
createApiKey
Create an ApiKey resource.
- Specified by:
createApiKey
in interfaceAmazonApiGateway
- 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
Adds a new Authorizer resource to an existing RestApi resource.
- Specified by:
createAuthorizer
in interfaceAmazonApiGateway
- 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
public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest) Creates a new BasePathMapping resource.
- Specified by:
createBasePathMapping
in interfaceAmazonApiGateway
- 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
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
- Specified by:
createDeployment
in interfaceAmazonApiGateway
- 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
Creates a new domain name.
- Specified by:
createDomainName
in interfaceAmazonApiGateway
- 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
- Specified by:
createModel
in interfaceAmazonApiGateway
- 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
Creates a Resource resource.
- Specified by:
createResource
in interfaceAmazonApiGateway
- 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
Creates a new RestApi resource.
- Specified by:
createRestApi
in interfaceAmazonApiGateway
- 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
Creates a new Stage resource that references a pre-existing Deployment for the API.
- Specified by:
createStage
in interfaceAmazonApiGateway
- 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
Deletes the ApiKey resource.
- Specified by:
deleteApiKey
in interfaceAmazonApiGateway
- Parameters:
deleteApiKeyRequest
- A request to delete the ApiKey resource.- Returns:
- Result of the DeleteApiKey operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteAuthorizer
Deletes an existing Authorizer resource.
- Specified by:
deleteAuthorizer
in interfaceAmazonApiGateway
- 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
public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest) Deletes the BasePathMapping resource.
- Specified by:
deleteBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.- Returns:
- Result of the DeleteBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteClientCertificate
public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest) Deletes the ClientCertificate resource.
- Specified by:
deleteClientCertificate
in interfaceAmazonApiGateway
- 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
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
- Specified by:
deleteDeployment
in interfaceAmazonApiGateway
- 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
Deletes the DomainName resource.
- Specified by:
deleteDomainName
in interfaceAmazonApiGateway
- Parameters:
deleteDomainNameRequest
- A request to delete the DomainName resource.- Returns:
- Result of the DeleteDomainName operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteIntegration
Represents a delete integration.
- Specified by:
deleteIntegration
in interfaceAmazonApiGateway
- Parameters:
deleteIntegrationRequest
- Represents a delete integration request.- Returns:
- Result of the DeleteIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteIntegrationResponse
public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest) Represents a delete integration response.
- Specified by:
deleteIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
deleteIntegrationResponseRequest
- Represents a delete integration response request.- Returns:
- Result of the DeleteIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteMethod
Deletes an existing Method resource.
- Specified by:
deleteMethod
in interfaceAmazonApiGateway
- Parameters:
deleteMethodRequest
- Request to delete an existing Method resource.- Returns:
- Result of the DeleteMethod operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
deleteMethodResponse
public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest) Deletes an existing MethodResponse resource.
- Specified by:
deleteMethodResponse
in interfaceAmazonApiGateway
- 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
Deletes a model.
- Specified by:
deleteModel
in interfaceAmazonApiGateway
- 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
Deletes a Resource resource.
- Specified by:
deleteResource
in interfaceAmazonApiGateway
- Parameters:
deleteResourceRequest
- Request to delete a Resource.- Returns:
- Result of the DeleteResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
-
deleteRestApi
Deletes the specified API.
- Specified by:
deleteRestApi
in interfaceAmazonApiGateway
- 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
Deletes a Stage resource.
- Specified by:
deleteStage
in interfaceAmazonApiGateway
- 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
public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest) Flushes all authorizer cache entries on a stage.
- Specified by:
flushStageAuthorizersCache
in interfaceAmazonApiGateway
- 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
Flushes a stage's cache.
- Specified by:
flushStageCache
in interfaceAmazonApiGateway
- 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
public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest) Generates a ClientCertificate resource.
- Specified by:
generateClientCertificate
in interfaceAmazonApiGateway
- Parameters:
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.- Returns:
- Result of the GenerateClientCertificate operation returned by the service.
- Throws:
UnauthorizedException
TooManyRequestsException
LimitExceededException
-
getAccount
Gets information about the current Account resource.
- Specified by:
getAccount
in interfaceAmazonApiGateway
- 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
Gets information about the current ApiKey resource.
- Specified by:
getApiKey
in interfaceAmazonApiGateway
- 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
Gets information about the current ApiKeys resource.
- Specified by:
getApiKeys
in interfaceAmazonApiGateway
- 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
Describe an existing Authorizer resource.
- Specified by:
getAuthorizer
in interfaceAmazonApiGateway
- Parameters:
getAuthorizerRequest
- Request to describe an existing Authorizer resource.- Returns:
- Result of the GetAuthorizer operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getAuthorizers
Describe an existing Authorizers resource.
- Specified by:
getAuthorizers
in interfaceAmazonApiGateway
- 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
public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest) Describe a BasePathMapping resource.
- Specified by:
getBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.- Returns:
- Result of the GetBasePathMapping operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getBasePathMappings
public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest) Represents a collection of BasePathMapping resources.
- Specified by:
getBasePathMappings
in interfaceAmazonApiGateway
- 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
public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest) Gets information about the current ClientCertificate resource.
- Specified by:
getClientCertificate
in interfaceAmazonApiGateway
- 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
public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest) Gets a collection of ClientCertificate resources.
- Specified by:
getClientCertificates
in interfaceAmazonApiGateway
- 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
Gets information about a Deployment resource.
- Specified by:
getDeployment
in interfaceAmazonApiGateway
- 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
Gets information about a Deployments collection.
- Specified by:
getDeployments
in interfaceAmazonApiGateway
- 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
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
- Specified by:
getDomainName
in interfaceAmazonApiGateway
- 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
Represents a collection of DomainName resources.
- Specified by:
getDomainNames
in interfaceAmazonApiGateway
- 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
Exports a deployed version of a RestApi in a specified format.
- Specified by:
getExport
in interfaceAmazonApiGateway
- 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
Represents a get integration.
- Specified by:
getIntegration
in interfaceAmazonApiGateway
- Parameters:
getIntegrationRequest
- Represents a get integration request.- Returns:
- Result of the GetIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getIntegrationResponse
public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest) Represents a get integration response.
- Specified by:
getIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
getIntegrationResponseRequest
- Represents a get integration response request.- Returns:
- Result of the GetIntegrationResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getMethod
Describe an existing Method resource.
- Specified by:
getMethod
in interfaceAmazonApiGateway
- Parameters:
getMethodRequest
- Request to describe an existing Method resource.- Returns:
- Result of the GetMethod operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getMethodResponse
Describes a MethodResponse resource.
- Specified by:
getMethodResponse
in interfaceAmazonApiGateway
- Parameters:
getMethodResponseRequest
- Request to describe a MethodResponse resource.- Returns:
- Result of the GetMethodResponse operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getModel
Describes an existing model defined for a RestApi resource.
- Specified by:
getModel
in interfaceAmazonApiGateway
- 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
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
- Specified by:
getModelTemplate
in interfaceAmazonApiGateway
- 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
- Specified by:
getModels
in interfaceAmazonApiGateway
- 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
Lists information about a resource.
- Specified by:
getResource
in interfaceAmazonApiGateway
- Parameters:
getResourceRequest
- Request to list information about a resource.- Returns:
- Result of the GetResource operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
TooManyRequestsException
-
getResources
Lists information about a collection of Resource resources.
- Specified by:
getResources
in interfaceAmazonApiGateway
- 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
Lists the RestApi resource in the collection.
- Specified by:
getRestApi
in interfaceAmazonApiGateway
- 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
Lists the RestApis resources for your collection.
- Specified by:
getRestApis
in interfaceAmazonApiGateway
- 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
- Specified by:
getSdk
in interfaceAmazonApiGateway
- 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
Gets information about a Stage resource.
- Specified by:
getStage
in interfaceAmazonApiGateway
- 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
Gets information about one or more Stage resources.
- Specified by:
getStages
in interfaceAmazonApiGateway
- 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
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
- Specified by:
importRestApi
in interfaceAmazonApiGateway
- 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
Represents a put integration.
- Specified by:
putIntegration
in interfaceAmazonApiGateway
- Parameters:
putIntegrationRequest
- Represents a put integration request.- Returns:
- Result of the PutIntegration operation returned by the service.
- Throws:
UnauthorizedException
BadRequestException
ConflictException
NotFoundException
TooManyRequestsException
-
putIntegrationResponse
public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest) Represents a put integration.
- Specified by:
putIntegrationResponse
in interfaceAmazonApiGateway
- 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
Add a method to an existing Resource resource.
- Specified by:
putMethod
in interfaceAmazonApiGateway
- 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
Adds a MethodResponse to an existing Method resource.
- Specified by:
putMethodResponse
in interfaceAmazonApiGateway
- 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
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.
- Specified by:
putRestApi
in interfaceAmazonApiGateway
- 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
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
- Specified by:
testInvokeAuthorizer
in interfaceAmazonApiGateway
- 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
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
- Specified by:
testInvokeMethod
in interfaceAmazonApiGateway
- 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
Changes information about the current Account resource.
- Specified by:
updateAccount
in interfaceAmazonApiGateway
- 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
Changes information about an ApiKey resource.
- Specified by:
updateApiKey
in interfaceAmazonApiGateway
- 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
Updates an existing Authorizer resource.
- Specified by:
updateAuthorizer
in interfaceAmazonApiGateway
- 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
public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest) Changes information about the BasePathMapping resource.
- Specified by:
updateBasePathMapping
in interfaceAmazonApiGateway
- 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
public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest) Changes information about an ClientCertificate resource.
- Specified by:
updateClientCertificate
in interfaceAmazonApiGateway
- 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
Changes information about a Deployment resource.
- Specified by:
updateDeployment
in interfaceAmazonApiGateway
- 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
Changes information about the DomainName resource.
- Specified by:
updateDomainName
in interfaceAmazonApiGateway
- 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
Represents an update integration.
- Specified by:
updateIntegration
in interfaceAmazonApiGateway
- Parameters:
updateIntegrationRequest
- Represents an update integration request.- Returns:
- Result of the UpdateIntegration operation returned by the service.
- Throws:
UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ConflictException
-
updateIntegrationResponse
public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest) Represents an update integration response.
- Specified by:
updateIntegrationResponse
in interfaceAmazonApiGateway
- 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
Updates an existing Method resource.
- Specified by:
updateMethod
in interfaceAmazonApiGateway
- 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
public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest) Updates an existing MethodResponse resource.
- Specified by:
updateMethodResponse
in interfaceAmazonApiGateway
- 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
Changes information about a model.
- Specified by:
updateModel
in interfaceAmazonApiGateway
- 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
Changes information about a Resource resource.
- Specified by:
updateResource
in interfaceAmazonApiGateway
- 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
Changes information about the specified API.
- Specified by:
updateRestApi
in interfaceAmazonApiGateway
- 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
Changes information about a Stage resource.
- Specified by:
updateStage
in interfaceAmazonApiGateway
- 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
-
getCachedResponseMetadata
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 the request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonApiGateway
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-