@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonApiGatewayClient extends AmazonWebServiceClient implements AmazonApiGateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonApiGatewayClient()
Deprecated.
|
AmazonApiGatewayClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonApiGatewayClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
@Deprecated public AmazonApiGatewayClient()
AmazonApiGatewayClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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
@Deprecated public AmazonApiGatewayClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 static AmazonApiGatewayClientBuilder builder()
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
createApiKey
in interface AmazonApiGateway
createApiKeyRequest
- Request to create an ApiKey resource.UnauthorizedException
NotFoundException
TooManyRequestsException
LimitExceededException
BadRequestException
ConflictException
public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizer
in interface AmazonApiGateway
createAuthorizerRequest
- Request to add a new Authorizer to an existing RestApi resource.BadRequestException
UnauthorizedException
NotFoundException
LimitExceededException
TooManyRequestsException
public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
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 request)
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 CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest request)
createDocumentationPart
in interface AmazonApiGateway
createDocumentationPartRequest
- Creates a new documentation part of a given API.BadRequestException
ConflictException
UnauthorizedException
NotFoundException
LimitExceededException
TooManyRequestsException
public CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest request)
createDocumentationVersion
in interface AmazonApiGateway
createDocumentationVersionRequest
- Creates a new documentation version of a given API.BadRequestException
ConflictException
UnauthorizedException
NotFoundException
LimitExceededException
TooManyRequestsException
public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
createDomainNameRequest
- A request to create a new domain name.UnauthorizedException
BadRequestException
ConflictException
TooManyRequestsException
public CreateModelResult createModel(CreateModelRequest request)
createModel
in interface AmazonApiGateway
createModelRequest
- Request to add a new Model to an existing RestApi resource.BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest request)
Creates a ReqeustValidator of a given RestApi.
createRequestValidator
in interface AmazonApiGateway
createRequestValidatorRequest
- Creates a RequestValidator of a given RestApi.BadRequestException
UnauthorizedException
NotFoundException
LimitExceededException
TooManyRequestsException
public CreateResourceResult createResource(CreateResourceRequest request)
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 request)
Creates a new RestApi resource.
createRestApi
in interface AmazonApiGateway
createRestApiRequest
- The POST Request to add a new RestApi resource to your collection.UnauthorizedException
LimitExceededException
BadRequestException
TooManyRequestsException
public CreateStageResult createStage(CreateStageRequest request)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStage
in interface AmazonApiGateway
createStageRequest
- Requests Amazon API Gateway to create a Stage resource.UnauthorizedException
BadRequestException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest request)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
createUsagePlan
in interface AmazonApiGateway
createUsagePlanRequest
- The POST request to create a usage plan with the name, description, throttle limits and quota limits, as
well as the associated API stages, specified in the payload.BadRequestException
UnauthorizedException
TooManyRequestsException
LimitExceededException
ConflictException
NotFoundException
public CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest request)
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKey
in interface AmazonApiGateway
createUsagePlanKeyRequest
- The POST request to create a usage plan key for adding an existing API key to a usage plan.BadRequestException
ConflictException
UnauthorizedException
NotFoundException
TooManyRequestsException
public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
deleteApiKeyRequest
- A request to delete the ApiKey resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an existing Authorizer resource.
deleteAuthorizer
in interface AmazonApiGateway
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request)
Deletes the ClientCertificate resource.
deleteClientCertificate
in interface AmazonApiGateway
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)
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 DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)
deleteDocumentationPart
in interface AmazonApiGateway
deleteDocumentationPartRequest
- Deletes an existing documentation part of an API.UnauthorizedException
NotFoundException
TooManyRequestsException
ConflictException
BadRequestException
public DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
deleteDocumentationVersion
in interface AmazonApiGateway
deleteDocumentationVersionRequest
- Deletes an existing documentation version of an API.UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
deleteDomainNameRequest
- A request to delete the DomainName resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
deleteIntegrationRequest
- Represents a delete integration request.UnauthorizedException
NotFoundException
TooManyRequestsException
ConflictException
public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
deleteIntegrationResponseRequest
- Represents a delete integration response request.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
public DeleteMethodResult deleteMethod(DeleteMethodRequest request)
Deletes an existing Method resource.
deleteMethod
in interface AmazonApiGateway
deleteMethodRequest
- Request to delete an existing Method resource.UnauthorizedException
NotFoundException
TooManyRequestsException
ConflictException
public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest request)
Deletes an existing MethodResponse resource.
deleteMethodResponse
in interface AmazonApiGateway
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
public DeleteModelResult deleteModel(DeleteModelRequest request)
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 DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest request)
Deletes a RequestValidator of a given RestApi.
deleteRequestValidator
in interface AmazonApiGateway
deleteRequestValidatorRequest
- Deletes a specified RequestValidator of a given RestApi.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
ConflictException
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
Deletes a Resource resource.
deleteResource
in interface AmazonApiGateway
deleteResourceRequest
- Request to delete a Resource.UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest request)
Deletes the specified API.
deleteRestApi
in interface AmazonApiGateway
deleteRestApiRequest
- Request to delete the specified API from your collection.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
public DeleteStageResult deleteStage(DeleteStageRequest request)
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
deleteStageRequest
- Requests Amazon API Gateway to delete a Stage resource.UnauthorizedException
NotFoundException
TooManyRequestsException
BadRequestException
public DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest request)
Deletes a usage plan of a given plan Id.
deleteUsagePlan
in interface AmazonApiGateway
deleteUsagePlanRequest
- The DELETE request to delete a uasge plan of a given plan Id.UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKey
in interface AmazonApiGateway
deleteUsagePlanKeyRequest
- The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.BadRequestException
ConflictException
UnauthorizedException
NotFoundException
TooManyRequestsException
public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCache
in interface AmazonApiGateway
flushStageAuthorizersCacheRequest
- Request to flush authorizer cache entries on a specified stage.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)
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 request)
Generates a ClientCertificate resource.
generateClientCertificate
in interface AmazonApiGateway
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.UnauthorizedException
TooManyRequestsException
LimitExceededException
public GetAccountResult getAccount(GetAccountRequest request)
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 request)
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 request)
Gets information about the current ApiKeys resource.
getApiKeys
in interface AmazonApiGateway
getApiKeysRequest
- A request to get information about the current ApiKeys resource.BadRequestException
UnauthorizedException
TooManyRequestsException
public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
Describe an existing Authorizer resource.
getAuthorizer
in interface AmazonApiGateway
getAuthorizerRequest
- Request to describe an existing Authorizer resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
Describe an existing Authorizers resource.
getAuthorizers
in interface AmazonApiGateway
getAuthorizersRequest
- Request to describe an existing Authorizers resource.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)
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 request)
Gets information about the current ClientCertificate resource.
getClientCertificate
in interface AmazonApiGateway
getClientCertificateRequest
- A request to get information about the current ClientCertificate resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)
Gets a collection of ClientCertificate resources.
getClientCertificates
in interface AmazonApiGateway
getClientCertificatesRequest
- A request to get information about a collection of ClientCertificate resources.BadRequestException
UnauthorizedException
TooManyRequestsException
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
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 request)
Gets information about a Deployments collection.
getDeployments
in interface AmazonApiGateway
getDeploymentsRequest
- Requests Amazon API Gateway to get information about a Deployments collection.BadRequestException
UnauthorizedException
TooManyRequestsException
ServiceUnavailableException
public GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest request)
getDocumentationPart
in interface AmazonApiGateway
getDocumentationPartRequest
- Gets a specified documentation part of a given API.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest request)
getDocumentationParts
in interface AmazonApiGateway
getDocumentationPartsRequest
- Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest request)
getDocumentationVersion
in interface AmazonApiGateway
getDocumentationVersionRequest
- Gets a documentation snapshot of an API.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest request)
getDocumentationVersions
in interface AmazonApiGateway
getDocumentationVersionsRequest
- Gets the documentation versions of an API.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetDomainNameResult getDomainName(GetDomainNameRequest request)
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 request)
Represents a collection of DomainName resources.
getDomainNames
in interface AmazonApiGateway
getDomainNamesRequest
- Request to describe a collection of DomainName resources.BadRequestException
UnauthorizedException
TooManyRequestsException
public GetExportResult getExport(GetExportRequest request)
Exports a deployed version of a RestApi in a specified format.
getExport
in interface AmazonApiGateway
getExportRequest
- Request a new export of a RestApi for a particular Stage.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public GetIntegrationResult getIntegration(GetIntegrationRequest request)
Represents a get integration.
getIntegration
in interface AmazonApiGateway
getIntegrationRequest
- Represents a get integration request.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
getIntegrationResponseRequest
- Represents a get integration response request.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetMethodResult getMethod(GetMethodRequest request)
Describe an existing Method resource.
getMethod
in interface AmazonApiGateway
getMethodRequest
- Request to describe an existing Method resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
Describes a MethodResponse resource.
getMethodResponse
in interface AmazonApiGateway
getMethodResponseRequest
- Request to describe a MethodResponse resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetModelResult getModel(GetModelRequest request)
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 request)
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 request)
getModels
in interface AmazonApiGateway
getModelsRequest
- Request to list existing Models defined for a RestApi resource.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRequestValidatorResult getRequestValidator(GetRequestValidatorRequest request)
Gets a RequestValidator of a given RestApi.
getRequestValidator
in interface AmazonApiGateway
getRequestValidatorRequest
- Gets a RequestValidator of a given RestApi.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRequestValidatorsResult getRequestValidators(GetRequestValidatorsRequest request)
Gets the RequestValidators collection of a given RestApi.
getRequestValidators
in interface AmazonApiGateway
getRequestValidatorsRequest
- Gets the RequestValidators collection of a given RestApi.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetResourceResult getResource(GetResourceRequest request)
Lists information about a resource.
getResource
in interface AmazonApiGateway
getResourceRequest
- Request to list information about a resource.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetResourcesResult getResources(GetResourcesRequest request)
Lists information about a collection of Resource resources.
getResources
in interface AmazonApiGateway
getResourcesRequest
- Request to list information about a collection of resources.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRestApiResult getRestApi(GetRestApiRequest request)
Lists the RestApi resource in the collection.
getRestApi
in interface AmazonApiGateway
getRestApiRequest
- The GET request to list an existing RestApi defined for your collection.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetRestApisResult getRestApis(GetRestApisRequest request)
Lists the RestApis resources for your collection.
getRestApis
in interface AmazonApiGateway
getRestApisRequest
- The GET request to list existing RestApis defined for your collection.BadRequestException
UnauthorizedException
TooManyRequestsException
public GetSdkResult getSdk(GetSdkRequest request)
getSdk
in interface AmazonApiGateway
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public GetSdkTypeResult getSdkType(GetSdkTypeRequest request)
getSdkType
in interface AmazonApiGateway
getSdkTypeRequest
- Get an SdkType instance.UnauthorizedException
NotFoundException
TooManyRequestsException
public GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)
getSdkTypes
in interface AmazonApiGateway
getSdkTypesRequest
- Get the SdkTypes collection.UnauthorizedException
TooManyRequestsException
public GetStageResult getStage(GetStageRequest request)
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 request)
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 GetUsageResult getUsage(GetUsageRequest request)
Gets the usage data of a usage plan in a specified time interval.
getUsage
in interface AmazonApiGateway
getUsageRequest
- The GET request to get the usage data of a usage plan in a specified time interval.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetUsagePlanResult getUsagePlan(GetUsagePlanRequest request)
Gets a usage plan of a given plan identifier.
getUsagePlan
in interface AmazonApiGateway
getUsagePlanRequest
- The GET request to get a usage plan of a given plan identifier.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest request)
Gets a usage plan key of a given key identifier.
getUsagePlanKey
in interface AmazonApiGateway
getUsagePlanKeyRequest
- The GET request to get a usage plan key of a given key identifier.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest request)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeys
in interface AmazonApiGateway
getUsagePlanKeysRequest
- The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public GetUsagePlansResult getUsagePlans(GetUsagePlansRequest request)
Gets all the usage plans of the caller's account.
getUsagePlans
in interface AmazonApiGateway
getUsagePlansRequest
- The GET request to get all the usage plans of the caller's account.BadRequestException
UnauthorizedException
TooManyRequestsException
ConflictException
NotFoundException
public ImportApiKeysResult importApiKeys(ImportApiKeysRequest request)
Import API keys from an external source, such as a CSV-formatted file.
importApiKeys
in interface AmazonApiGateway
importApiKeysRequest
- The POST request to import API keys from an external source, such as a CSV-formatted file.UnauthorizedException
NotFoundException
TooManyRequestsException
LimitExceededException
BadRequestException
ConflictException
public ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)
importDocumentationParts
in interface AmazonApiGateway
importDocumentationPartsRequest
- Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedException
NotFoundException
BadRequestException
LimitExceededException
TooManyRequestsException
public ImportRestApiResult importRestApi(ImportRestApiRequest request)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
importRestApi
in interface AmazonApiGateway
importRestApiRequest
- A POST request to import an API to Amazon API Gateway using an input of an API definition file.UnauthorizedException
LimitExceededException
BadRequestException
TooManyRequestsException
ConflictException
public PutIntegrationResult putIntegration(PutIntegrationRequest request)
Represents a put integration.
putIntegration
in interface AmazonApiGateway
putIntegrationRequest
- Represents a put integration request.UnauthorizedException
BadRequestException
ConflictException
NotFoundException
TooManyRequestsException
public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
putIntegrationResponseRequest
- Represents a put integration response request.UnauthorizedException
NotFoundException
LimitExceededException
BadRequestException
TooManyRequestsException
ConflictException
public PutMethodResult putMethod(PutMethodRequest request)
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 request)
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 PutRestApiResult putRestApi(PutRestApiRequest request)
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.
putRestApi
in interface AmazonApiGateway
putRestApiRequest
- A PUT request to update an existing API, with external API definitions specified as the request body.UnauthorizedException
LimitExceededException
NotFoundException
BadRequestException
TooManyRequestsException
ConflictException
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizer
in interface AmazonApiGateway
testInvokeAuthorizerRequest
- Make a request to simulate the execution of an Authorizer.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethod
in interface AmazonApiGateway
testInvokeMethodRequest
- Make a request to simulate the execution of a Method.BadRequestException
UnauthorizedException
NotFoundException
TooManyRequestsException
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
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 request)
Changes information about an ApiKey resource.
updateApiKey
in interface AmazonApiGateway
updateApiKeyRequest
- A request to change information about an ApiKey resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ConflictException
public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
Updates an existing Authorizer resource.
updateAuthorizer
in interface AmazonApiGateway
updateAuthorizerRequest
- Request to update an existing Authorizer resource.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
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 request)
Changes information about an ClientCertificate resource.
updateClientCertificate
in interface AmazonApiGateway
updateClientCertificateRequest
- A request to change information about an ClientCertificate resource.UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
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 UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest request)
updateDocumentationPart
in interface AmazonApiGateway
updateDocumentationPartRequest
- Updates an existing documentation part of a given API.BadRequestException
UnauthorizedException
NotFoundException
ConflictException
LimitExceededException
TooManyRequestsException
public UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest request)
updateDocumentationVersion
in interface AmazonApiGateway
updateDocumentationVersionRequest
- Updates an existing documentation version of an API.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
Changes information about the DomainName resource.
updateDomainName
in interface AmazonApiGateway
updateDomainNameRequest
- A request to change information about the DomainName resource.UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
updateIntegrationRequest
- Represents an update integration request.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
ConflictException
public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
updateIntegrationResponseRequest
- Represents an update integration response request.UnauthorizedException
NotFoundException
ConflictException
BadRequestException
TooManyRequestsException
public UpdateMethodResult updateMethod(UpdateMethodRequest request)
Updates an existing Method resource.
updateMethod
in interface AmazonApiGateway
updateMethodRequest
- Request to update an existing Method resource.UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
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 request)
Changes information about a model.
updateModel
in interface AmazonApiGateway
updateModelRequest
- Request to update an existing model in an existing RestApi resource.UnauthorizedException
NotFoundException
BadRequestException
ConflictException
TooManyRequestsException
public UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest request)
Updates a RequestValidator of a given RestApi.
updateRequestValidator
in interface AmazonApiGateway
updateRequestValidatorRequest
- Updates a RequestValidator of a given RestApi.UnauthorizedException
NotFoundException
BadRequestException
TooManyRequestsException
public UpdateResourceResult updateResource(UpdateResourceRequest request)
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 request)
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 request)
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 UpdateUsageResult updateUsage(UpdateUsageRequest request)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
updateUsage
in interface AmazonApiGateway
updateUsageRequest
- The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a
specified API key.UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
public UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest request)
Updates a usage plan of a given plan Id.
updateUsagePlan
in interface AmazonApiGateway
updateUsagePlanRequest
- The PATCH request to update a usage plan of a given plan Id.UnauthorizedException
TooManyRequestsException
BadRequestException
NotFoundException
ConflictException
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 © 2017. All rights reserved.