@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.
LOGGING_AWS_REQUEST_METRIC
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, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.public CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest request)
createDocumentationPart
in interface AmazonApiGateway
createDocumentationPartRequest
- Creates a new documentation part of a given API.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest request)
createDocumentationVersion
in interface AmazonApiGateway
createDocumentationVersionRequest
- Creates a new documentation version of a given API.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
createDomainNameRequest
- A request to create a new domain name.UnauthorizedException
- The request is denied because the caller has insufficient permissions.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public CreateModelResult createModel(CreateModelRequest request)
createModel
in interface AmazonApiGateway
createModelRequest
- Request to add a new Model to an existing RestApi resource.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public CreateResourceResult createResource(CreateResourceRequest request)
Creates a Resource resource.
createResource
in interface AmazonApiGateway
createResourceRequest
- Requests Amazon API Gateway to create a Resource resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
deleteApiKeyRequest
- A request to delete the ApiKey resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an existing Authorizer resource.
deleteAuthorizer
in interface AmazonApiGateway
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request)
Deletes the ClientCertificate resource.
deleteClientCertificate
in interface AmazonApiGateway
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)
deleteDocumentationPart
in interface AmazonApiGateway
deleteDocumentationPartRequest
- Deletes an existing documentation part of an API.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.public DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
deleteDocumentationVersion
in interface AmazonApiGateway
deleteDocumentationVersionRequest
- Deletes an existing documentation version of an API.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
deleteDomainNameRequest
- A request to delete the DomainName resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest request)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
deleteGatewayResponse
in interface AmazonApiGateway
deleteGatewayResponseRequest
- Clears any customization of a GatewayResponse of a specified response type on the given
RestApi and resets it with the default settings.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
deleteIntegrationRequest
- Represents a delete integration request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
deleteIntegrationResponseRequest
- Represents a delete integration response request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteMethodResult deleteMethod(DeleteMethodRequest request)
Deletes an existing Method resource.
deleteMethod
in interface AmazonApiGateway
deleteMethodRequest
- Request to delete an existing Method resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest request)
Deletes an existing MethodResponse resource.
deleteMethodResponse
in interface AmazonApiGateway
deleteMethodResponseRequest
- A request to delete an existing MethodResponse resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public DeleteResourceResult deleteResource(DeleteResourceRequest request)
Deletes a Resource resource.
deleteResource
in interface AmazonApiGateway
deleteResourceRequest
- Request to delete a Resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest request)
Deletes the specified API.
deleteRestApi
in interface AmazonApiGateway
deleteRestApiRequest
- Request to delete the specified API from your collection.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.public DeleteStageResult deleteStage(DeleteStageRequest request)
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
deleteStageRequest
- Requests Amazon API Gateway to delete a Stage resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.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 usage plan of a given plan Id.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
Generates a ClientCertificate resource.
generateClientCertificate
in interface AmazonApiGateway
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
Describe an existing Authorizer resource.
getAuthorizer
in interface AmazonApiGateway
getAuthorizerRequest
- Request to describe an existing Authorizer resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
Describe an existing Authorizers resource.
getAuthorizers
in interface AmazonApiGateway
getAuthorizersRequest
- Request to describe an existing Authorizers resource.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.public GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest request)
getDocumentationPart
in interface AmazonApiGateway
getDocumentationPartRequest
- Gets a specified documentation part of a given API.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest request)
getDocumentationVersion
in interface AmazonApiGateway
getDocumentationVersionRequest
- Gets a documentation snapshot of an API.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest request)
getDocumentationVersions
in interface AmazonApiGateway
getDocumentationVersionsRequest
- Gets the documentation versions of an API.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetGatewayResponseResult getGatewayResponse(GetGatewayResponseRequest request)
Gets a GatewayResponse of a specified response type on the given RestApi.
getGatewayResponse
in interface AmazonApiGateway
getGatewayResponseRequest
- Gets a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetGatewayResponsesResult getGatewayResponses(GetGatewayResponsesRequest request)
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the Amazon API Gateway-generated default GatewayResponses collection for the supported response types.
getGatewayResponses
in interface AmazonApiGateway
getGatewayResponsesRequest
- Gets the GatewayResponses collection on the given RestApi. If an API developer has not added
any definitions for gateway responses, the result will be the Amazon API Gateway-generated default
GatewayResponses collection for the supported response types.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetIntegrationResult getIntegration(GetIntegrationRequest request)
Represents a get integration.
getIntegration
in interface AmazonApiGateway
getIntegrationRequest
- Represents a get integration request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
getIntegrationResponseRequest
- Represents a get integration response request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetMethodResult getMethod(GetMethodRequest request)
Describe an existing Method resource.
getMethod
in interface AmazonApiGateway
getMethodRequest
- Request to describe an existing Method resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
Describes a MethodResponse resource.
getMethodResponse
in interface AmazonApiGateway
getMethodResponseRequest
- Request to describe a MethodResponse resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetModelsResult getModels(GetModelsRequest request)
getModels
in interface AmazonApiGateway
getModelsRequest
- Request to list existing Models defined for a RestApi resource.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetResourceResult getResource(GetResourceRequest request)
Lists information about a resource.
getResource
in interface AmazonApiGateway
getResourceRequest
- Request to list information about a resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetSdkResult getSdk(GetSdkRequest request)
getSdk
in interface AmazonApiGateway
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetSdkTypeResult getSdkType(GetSdkTypeRequest request)
getSdkType
in interface AmazonApiGateway
getSdkTypeRequest
- Get an SdkType instance.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)
getSdkTypes
in interface AmazonApiGateway
getSdkTypesRequest
- Get the SdkTypes collection.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)
importDocumentationParts
in interface AmazonApiGateway
importDocumentationPartsRequest
- Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public PutGatewayResponseResult putGatewayResponse(PutGatewayResponseRequest request)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
putGatewayResponse
in interface AmazonApiGateway
putGatewayResponseRequest
- Creates a customization of a GatewayResponse of a specified response type and status code on the
given RestApi.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public PutIntegrationResult putIntegration(PutIntegrationRequest request)
Sets up a method's integration.
putIntegration
in interface AmazonApiGateway
putIntegrationRequest
- Sets up a method's integration.UnauthorizedException
- The request is denied because the caller has insufficient permissions.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
putIntegrationResponseRequest
- Represents a put integration response request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
Updates an existing Authorizer resource.
updateAuthorizer
in interface AmazonApiGateway
updateAuthorizerRequest
- Request to update an existing Authorizer resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ServiceUnavailableException
- The requested service is not available. For details see the accompanying error message. Retry after the
specified time period.public UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest request)
updateDocumentationPart
in interface AmazonApiGateway
updateDocumentationPartRequest
- Updates an existing documentation part of a given API.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest request)
updateDocumentationVersion
in interface AmazonApiGateway
updateDocumentationVersionRequest
- Updates an existing documentation version of an API.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateGatewayResponseResult updateGatewayResponse(UpdateGatewayResponseRequest request)
Updates a GatewayResponse of a specified response type on the given RestApi.
updateGatewayResponse
in interface AmazonApiGateway
updateGatewayResponseRequest
- Updates a GatewayResponse of a specified response type on the given RestApi.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
updateIntegrationRequest
- Represents an update integration request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
updateIntegrationResponseRequest
- Represents an update integration response request.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateMethodResult updateMethod(UpdateMethodRequest request)
Updates an existing Method resource.
updateMethod
in interface AmazonApiGateway
updateMethodRequest
- Request to update an existing Method resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
Updates an existing MethodResponse resource.
updateMethodResponse
in interface AmazonApiGateway
updateMethodResponseRequest
- A request to update an existing MethodResponse resource.UnauthorizedException
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.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
- The request is denied because the caller has insufficient permissions.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.public UpdateUsageResult updateUsage(UpdateUsageRequest request)
Grants a temporary extension to the remaining 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 remaining quota of a usage plan associated with a
specified API key.UnauthorizedException
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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
- The request is denied because the caller has insufficient permissions.TooManyRequestsException
- The request has reached its throttling limit. Retry after the specified time period.BadRequestException
- The submitted request is not valid, for example, the input is incomplete or incorrect. See the
accompanying error message for details.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.ConflictException
- The request configuration has conflicts. For details, see the accompanying error message.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 © 2013 Amazon Web Services, Inc. All Rights Reserved.