public class AmazonApiGatewayClient extends AmazonWebServiceClient implements AmazonApiGateway
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.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Amazon API Gateway exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonApiGatewayClient()
Constructs 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(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(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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon API Gateway.
|
Modifier and Type | Method and Description |
---|---|
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest createApiKeyRequest) |
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 Stage resource.
|
void |
deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
|
void |
deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
|
void |
deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest) |
void |
deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource.
|
void |
deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
|
void |
deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
|
void |
deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
|
void |
deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
|
void |
deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
|
void |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
void |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
|
void |
deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
|
void |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
|
void |
flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
|
GenerateClientCertificateResult |
generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest) |
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.
|
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) |
GetClientCertificatesResult |
getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest) |
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.
|
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.
|
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.
|
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.
|
UpdateBasePathMappingResult |
updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
|
UpdateClientCertificateResult |
updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest) |
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.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AmazonApiGatewayClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon API Gateway (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChain
public AmazonApiGatewayClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
createApiKey
in interface AmazonApiGateway
createApiKeyRequest
- UnauthorizedException
NotFoundException
TooManyRequestsException
LimitExceededException
BadRequestException
public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
createBasePathMapping
in interface AmazonApiGateway
createBasePathMappingRequest
- Requests Amazon API Gateway to create a new BasePathMapping
resource.UnauthorizedException
ConflictException
BadRequestException
NotFoundException
TooManyRequestsException
public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment
in interface AmazonApiGateway
createDeploymentRequest
- Requests Amazon API Gateway to create a Deployment
resource.UnauthorizedException
BadRequestException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
ServiceUnavailableException
public CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
createDomainNameRequest
- A request to create a new domain name.UnauthorizedException
BadRequestException
TooManyRequestsException
public CreateModelResult createModel(CreateModelRequest createModelRequest)
createModel
in interface AmazonApiGateway
createModelRequest
- Request to add a new Model to an existing RestApi
resource.BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
createResource
in interface AmazonApiGateway
createResourceRequest
- Requests Amazon API Gateway to create a Resource resource.UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
public CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
createRestApi
in interface AmazonApiGateway
createRestApiRequest
- Request to add a new RestApi resource to your collection.UnauthorizedException
LimitExceededException
BadRequestException
TooManyRequestsException
public CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a Stage resource.
createStage
in interface AmazonApiGateway
createStageRequest
- Requests Amazon API Gateway to create a Stage resource.UnauthorizedException
BadRequestException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public void deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
deleteApiKeyRequest
- A request to delete the ApiKey resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
deleteClientCertificate
in interface AmazonApiGateway
deleteClientCertificateRequest
- UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public void deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeployment
in interface AmazonApiGateway
deleteDeploymentRequest
- Requests Amazon API Gateway to delete a Deployment
resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public void deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
deleteDomainNameRequest
- A request to delete the DomainName resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
deleteIntegrationRequest
- Represents a delete integration request.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
deleteIntegrationResponseRequest
- Represents a delete integration response request.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
deleteMethod
in interface AmazonApiGateway
deleteMethodRequest
- Request to delete an existing Method resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
deleteMethodResponse
in interface AmazonApiGateway
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
deleteModel
in interface AmazonApiGateway
deleteModelRequest
- Request to delete an existing model in an existing RestApi
resource.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
public void deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
deleteResource
in interface AmazonApiGateway
deleteResourceRequest
- Request to delete a Resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public void deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
deleteRestApi
in interface AmazonApiGateway
deleteRestApiRequest
- Request to delete the specified API from your collection.UnauthorizedException
NotFoundException
TooManyRequestsException
public void deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
deleteStageRequest
- Requests Amazon API Gateway to delete a Stage resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public void flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
flushStageCache
in interface AmazonApiGateway
flushStageCacheRequest
- Requests Amazon API Gateway to flush a stage's cache.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
generateClientCertificate
in interface AmazonApiGateway
generateClientCertificateRequest
- UnauthorizedException
TooManyRequestsException
LimitExceededException
public GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
getAccount
in interface AmazonApiGateway
getAccountRequest
- Requests Amazon API Gateway to get information about the current
Account resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
getApiKey
in interface AmazonApiGateway
getApiKeyRequest
- A request to get information about the current ApiKey
resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
getApiKeys
in interface AmazonApiGateway
getApiKeysRequest
- A request to get information about the current ApiKeys
resource.UnauthorizedException
TooManyRequestsException
public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
getBasePathMappings
in interface AmazonApiGateway
getBasePathMappingsRequest
- A request to get information about a collection of
BasePathMapping resources.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
getClientCertificate
in interface AmazonApiGateway
getClientCertificateRequest
- UnauthorizedException
NotFoundException
TooManyRequestsException
public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
getClientCertificates
in interface AmazonApiGateway
getClientCertificatesRequest
- UnauthorizedException
TooManyRequestsException
public GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
getDeployment
in interface AmazonApiGateway
getDeploymentRequest
- Requests Amazon API Gateway to get information about a
Deployment resource.UnauthorizedException
NotFoundException
TooManyRequestsException
ServiceUnavailableException
public GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
getDeployments
in interface AmazonApiGateway
getDeploymentsRequest
- Requests Amazon API Gateway to get information about a
Deployments collection.UnauthorizedException
TooManyRequestsException
ServiceUnavailableException
public GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainName
in interface AmazonApiGateway
getDomainNameRequest
- Request to get the name of a DomainName resource.UnauthorizedException
NotFoundException
ServiceUnavailableException
TooManyRequestsException
public GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
getDomainNames
in interface AmazonApiGateway
getDomainNamesRequest
- Request to describe a collection of DomainName resources.UnauthorizedException
TooManyRequestsException
public GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
getIntegration
in interface AmazonApiGateway
getIntegrationRequest
- Represents a get integration request.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
getIntegrationResponseRequest
- Represents a get integration response request.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetMethodResult getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
getMethod
in interface AmazonApiGateway
getMethodRequest
- Request to describe an existing Method resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
getMethodResponse
in interface AmazonApiGateway
getMethodResponseRequest
- Request to describe a MethodResponse resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetModelResult getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
getModel
in interface AmazonApiGateway
getModelRequest
- Request to list information about a model in an existing
RestApi resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplate
in interface AmazonApiGateway
getModelTemplateRequest
- Request to generate a sample mapping template used to transform
the payload.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public GetModelsResult getModels(GetModelsRequest getModelsRequest)
getModels
in interface AmazonApiGateway
getModelsRequest
- Request to list existing Models defined for a
RestApi resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetResourceResult getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
getResource
in interface AmazonApiGateway
getResourceRequest
- Request to list information about a resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
getResources
in interface AmazonApiGateway
getResourcesRequest
- Request to list information about a collection of resources.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
getRestApi
in interface AmazonApiGateway
getRestApiRequest
- Request to list an existing RestApi defined for your
collection.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
getRestApis
in interface AmazonApiGateway
getRestApisRequest
- Request to list existing RestApis defined for your
collection.UnauthorizedException
TooManyRequestsException
public GetSdkResult getSdk(GetSdkRequest getSdkRequest)
getSdk
in interface AmazonApiGateway
getSdkRequest
- UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public GetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
getStage
in interface AmazonApiGateway
getStageRequest
- Requests Amazon API Gateway to get information about a
Stage resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
getStages
in interface AmazonApiGateway
getStagesRequest
- Requests Amazon API Gateway to get information about one or more
Stage resources.UnauthorizedException
NotFoundException
TooManyRequestsException
public PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
putIntegration
in interface AmazonApiGateway
putIntegrationRequest
- Represents a put integration request.UnauthorizedException
BadRequestException
NotFoundException
TooManyRequestsException
public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
putIntegrationResponseRequest
- Represents a put integration response request.UnauthorizedException
NotFoundException
LimitExceededException
BadRequestException
TooManyRequestsException
public PutMethodResult putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
putMethod
in interface AmazonApiGateway
putMethodRequest
- Request to add a method to an existing Resource resource.BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
putMethodResponse
in interface AmazonApiGateway
putMethodResponseRequest
- Request to add a MethodResponse to an existing
Method resource.UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
testInvokeMethod
in interface AmazonApiGateway
testInvokeMethodRequest
- BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
updateAccount
in interface AmazonApiGateway
updateAccountRequest
- Requests Amazon API Gateway to change information about the
current Account resource.UnauthorizedException
BadRequestException
NotFoundException
TooManyRequestsException
public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
updateApiKey
in interface AmazonApiGateway
updateApiKeyRequest
- A request to change information about an ApiKey resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
updateBasePathMapping
in interface AmazonApiGateway
updateBasePathMappingRequest
- A request to change information about the BasePathMapping
resource.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
updateClientCertificate
in interface AmazonApiGateway
updateClientCertificateRequest
- UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
updateDeployment
in interface AmazonApiGateway
updateDeploymentRequest
- Requests Amazon API Gateway to change information about a
Deployment resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ServiceUnavailableException
public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
updateDomainName
in interface AmazonApiGateway
updateDomainNameRequest
- A request to change information about the DomainName
resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
updateIntegrationRequest
- Represents an update integration request.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
updateIntegrationResponseRequest
- Represents an update integration response request.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
updateMethod
in interface AmazonApiGateway
updateMethodRequest
- Request to update an existing Method resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
updateMethodResponse
in interface AmazonApiGateway
updateMethodResponseRequest
- A request to update an existing MethodResponse resource.UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
BadRequestException
TooManyRequestsException
public UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
updateModel
in interface AmazonApiGateway
updateModelRequest
- Request to update an existing model in an existing RestApi
resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
updateResource
in interface AmazonApiGateway
updateResourceRequest
- Request to change information about a Resource resource.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
updateRestApi
in interface AmazonApiGateway
updateRestApiRequest
- Request to update an existing RestApi resource in your
collection.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
updateStage
in interface AmazonApiGateway
updateStageRequest
- Requests Amazon API Gateway to change information about a
Stage resource.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonApiGateway
request
- The originally executed requestCopyright © 2015. All rights reserved.