@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. API Gateway allows developers to securely connect mobile and web applications to APIs that run on 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.
|
Modifier and Type | Method and Description |
---|---|
static AmazonApiGatewayClientBuilder |
builder() |
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest request)
Create an ApiKey resource.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest request)
Adds a new Authorizer resource to an existing RestApi resource.
|
CreateBasePathMappingResult |
createBasePathMapping(CreateBasePathMappingRequest request)
Creates a new BasePathMapping resource.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
CreateDocumentationPartResult |
createDocumentationPart(CreateDocumentationPartRequest request)
Creates a documentation part.
|
CreateDocumentationVersionResult |
createDocumentationVersion(CreateDocumentationVersionRequest request)
Creates a documentation version
|
CreateDomainNameResult |
createDomainName(CreateDomainNameRequest request)
Creates a new domain name.
|
CreateModelResult |
createModel(CreateModelRequest request)
Adds a new Model resource to an existing RestApi resource.
|
CreateRequestValidatorResult |
createRequestValidator(CreateRequestValidatorRequest request)
Creates a RequestValidator of a given RestApi.
|
CreateResourceResult |
createResource(CreateResourceRequest request)
Creates a Resource resource.
|
CreateRestApiResult |
createRestApi(CreateRestApiRequest request)
Creates a new RestApi resource.
|
CreateStageResult |
createStage(CreateStageRequest request)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
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.
|
CreateUsagePlanKeyResult |
createUsagePlanKey(CreateUsagePlanKeyRequest request)
Creates a usage plan key for adding an existing API key to a usage plan.
|
CreateVpcLinkResult |
createVpcLink(CreateVpcLinkRequest request)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically
takes 2-4 minutes to complete and become operational.
|
DeleteApiKeyResult |
deleteApiKey(DeleteApiKeyRequest request)
Deletes the ApiKey resource.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an existing Authorizer resource.
|
DeleteBasePathMappingResult |
deleteBasePathMapping(DeleteBasePathMappingRequest request)
Deletes the BasePathMapping resource.
|
DeleteClientCertificateResult |
deleteClientCertificate(DeleteClientCertificateRequest request)
Deletes the ClientCertificate resource.
|
DeleteDeploymentResult |
deleteDeployment(DeleteDeploymentRequest request)
Deletes a Deployment resource.
|
DeleteDocumentationPartResult |
deleteDocumentationPart(DeleteDocumentationPartRequest request)
Deletes a documentation part
|
DeleteDocumentationVersionResult |
deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
Deletes a documentation version.
|
DeleteDomainNameResult |
deleteDomainName(DeleteDomainNameRequest request)
Deletes the DomainName resource.
|
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.
|
DeleteIntegrationResult |
deleteIntegration(DeleteIntegrationRequest request)
Represents a delete integration.
|
DeleteIntegrationResponseResult |
deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
Represents a delete integration response.
|
DeleteMethodResult |
deleteMethod(DeleteMethodRequest request)
Deletes an existing Method resource.
|
DeleteMethodResponseResult |
deleteMethodResponse(DeleteMethodResponseRequest request)
Deletes an existing MethodResponse resource.
|
DeleteModelResult |
deleteModel(DeleteModelRequest request)
Deletes a model.
|
DeleteRequestValidatorResult |
deleteRequestValidator(DeleteRequestValidatorRequest request)
Deletes a RequestValidator of a given RestApi.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest request)
Deletes a Resource resource.
|
DeleteRestApiResult |
deleteRestApi(DeleteRestApiRequest request)
Deletes the specified API.
|
DeleteStageResult |
deleteStage(DeleteStageRequest request)
Deletes a Stage resource.
|
DeleteUsagePlanResult |
deleteUsagePlan(DeleteUsagePlanRequest request)
Deletes a usage plan of a given plan Id.
|
DeleteUsagePlanKeyResult |
deleteUsagePlanKey(DeleteUsagePlanKeyRequest request)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
DeleteVpcLinkResult |
deleteVpcLink(DeleteVpcLinkRequest request)
Deletes an existing VpcLink of a specified identifier.
|
FlushStageAuthorizersCacheResult |
flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)
Flushes all authorizer cache entries on a stage.
|
FlushStageCacheResult |
flushStageCache(FlushStageCacheRequest request)
Flushes a stage's cache.
|
GenerateClientCertificateResult |
generateClientCertificate(GenerateClientCertificateRequest request)
Generates a ClientCertificate resource.
|
GetAccountResult |
getAccount(GetAccountRequest request)
Gets information about the current Account resource.
|
GetApiKeyResult |
getApiKey(GetApiKeyRequest request)
Gets information about the current ApiKey resource.
|
GetApiKeysResult |
getApiKeys(GetApiKeysRequest request)
Gets information about the current ApiKeys resource.
|
GetAuthorizerResult |
getAuthorizer(GetAuthorizerRequest request)
Describe an existing Authorizer resource.
|
GetAuthorizersResult |
getAuthorizers(GetAuthorizersRequest request)
Describe an existing Authorizers resource.
|
GetBasePathMappingResult |
getBasePathMapping(GetBasePathMappingRequest request)
Describe a BasePathMapping resource.
|
GetBasePathMappingsResult |
getBasePathMappings(GetBasePathMappingsRequest request)
Represents a collection of BasePathMapping resources.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetClientCertificateResult |
getClientCertificate(GetClientCertificateRequest request)
Gets information about the current ClientCertificate resource.
|
GetClientCertificatesResult |
getClientCertificates(GetClientCertificatesRequest request)
Gets a collection of ClientCertificate resources.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest request)
Gets information about a Deployment resource.
|
GetDeploymentsResult |
getDeployments(GetDeploymentsRequest request)
Gets information about a Deployments collection.
|
GetDocumentationPartResult |
getDocumentationPart(GetDocumentationPartRequest request)
Gets a documentation part.
|
GetDocumentationPartsResult |
getDocumentationParts(GetDocumentationPartsRequest request)
Gets documentation parts.
|
GetDocumentationVersionResult |
getDocumentationVersion(GetDocumentationVersionRequest request)
Gets a documentation version.
|
GetDocumentationVersionsResult |
getDocumentationVersions(GetDocumentationVersionsRequest request)
Gets documentation versions.
|
GetDomainNameResult |
getDomainName(GetDomainNameRequest request)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
GetDomainNamesResult |
getDomainNames(GetDomainNamesRequest request)
Represents a collection of DomainName resources.
|
GetExportResult |
getExport(GetExportRequest request)
Exports a deployed version of a RestApi in a specified format.
|
GetGatewayResponseResult |
getGatewayResponse(GetGatewayResponseRequest request)
Gets a GatewayResponse of a specified response type on the given RestApi.
|
GetGatewayResponsesResult |
getGatewayResponses(GetGatewayResponsesRequest request)
Gets the GatewayResponses collection on the given RestApi.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest request)
Get the integration settings.
|
GetIntegrationResponseResult |
getIntegrationResponse(GetIntegrationResponseRequest request)
Represents a get integration response.
|
GetMethodResult |
getMethod(GetMethodRequest request)
Describe an existing Method resource.
|
GetMethodResponseResult |
getMethodResponse(GetMethodResponseRequest request)
Describes a MethodResponse resource.
|
GetModelResult |
getModel(GetModelRequest request)
Describes an existing model defined for a RestApi resource.
|
GetModelsResult |
getModels(GetModelsRequest request)
Describes existing Models defined for a RestApi resource.
|
GetModelTemplateResult |
getModelTemplate(GetModelTemplateRequest request)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
GetRequestValidatorResult |
getRequestValidator(GetRequestValidatorRequest request)
Gets a RequestValidator of a given RestApi.
|
GetRequestValidatorsResult |
getRequestValidators(GetRequestValidatorsRequest request)
Gets the RequestValidators collection of a given RestApi.
|
GetResourceResult |
getResource(GetResourceRequest request)
Lists information about a resource.
|
GetResourcesResult |
getResources(GetResourcesRequest request)
Lists information about a collection of Resource resources.
|
GetRestApiResult |
getRestApi(GetRestApiRequest request)
Lists the RestApi resource in the collection.
|
GetRestApisResult |
getRestApis(GetRestApisRequest request)
Lists the RestApis resources for your collection.
|
GetSdkResult |
getSdk(GetSdkRequest request)
Generates a client SDK for a RestApi and Stage.
|
GetSdkTypeResult |
getSdkType(GetSdkTypeRequest request)
Gets an SDK type.
|
GetSdkTypesResult |
getSdkTypes(GetSdkTypesRequest request)
Gets SDK types
|
GetStageResult |
getStage(GetStageRequest request)
Gets information about a Stage resource.
|
GetStagesResult |
getStages(GetStagesRequest request)
Gets information about one or more Stage resources.
|
GetTagsResult |
getTags(GetTagsRequest request)
Gets the Tags collection for a given resource.
|
GetUsageResult |
getUsage(GetUsageRequest request)
Gets the usage data of a usage plan in a specified time interval.
|
GetUsagePlanResult |
getUsagePlan(GetUsagePlanRequest request)
Gets a usage plan of a given plan identifier.
|
GetUsagePlanKeyResult |
getUsagePlanKey(GetUsagePlanKeyRequest request)
Gets a usage plan key of a given key identifier.
|
GetUsagePlanKeysResult |
getUsagePlanKeys(GetUsagePlanKeysRequest request)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
GetUsagePlansResult |
getUsagePlans(GetUsagePlansRequest request)
Gets all the usage plans of the caller's account.
|
GetVpcLinkResult |
getVpcLink(GetVpcLinkRequest request)
Gets a specified VPC link under the caller's account in a region.
|
GetVpcLinksResult |
getVpcLinks(GetVpcLinksRequest request)
Gets the VpcLinks collection under the caller's account in a selected region.
|
ImportApiKeysResult |
importApiKeys(ImportApiKeysRequest request)
Import API keys from an external source, such as a CSV-formatted file.
|
ImportDocumentationPartsResult |
importDocumentationParts(ImportDocumentationPartsRequest request)
Imports documentation parts
|
ImportRestApiResult |
importRestApi(ImportRestApiRequest request)
A feature of the API Gateway control service for creating a new API from an external API definition file.
|
PutGatewayResponseResult |
putGatewayResponse(PutGatewayResponseRequest request)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest request)
Sets up a method's integration.
|
PutIntegrationResponseResult |
putIntegrationResponse(PutIntegrationResponseRequest request)
Represents a put integration.
|
PutMethodResult |
putMethod(PutMethodRequest request)
Add a method to an existing Resource resource.
|
PutMethodResponseResult |
putMethodResponse(PutMethodResponseRequest request)
Adds a MethodResponse to an existing Method resource.
|
PutRestApiResult |
putRestApi(PutRestApiRequest request)
A feature of the API Gateway control service for updating an existing API with an input of external API
definitions.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds or updates a tag on a given resource.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
|
TestInvokeMethodResult |
testInvokeMethod(TestInvokeMethodRequest request)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from a given resource.
|
UpdateAccountResult |
updateAccount(UpdateAccountRequest request)
Changes information about the current Account resource.
|
UpdateApiKeyResult |
updateApiKey(UpdateApiKeyRequest request)
Changes information about an ApiKey resource.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest request)
Updates an existing Authorizer resource.
|
UpdateBasePathMappingResult |
updateBasePathMapping(UpdateBasePathMappingRequest request)
Changes information about the BasePathMapping resource.
|
UpdateClientCertificateResult |
updateClientCertificate(UpdateClientCertificateRequest request)
Changes information about an ClientCertificate resource.
|
UpdateDeploymentResult |
updateDeployment(UpdateDeploymentRequest request)
Changes information about a Deployment resource.
|
UpdateDocumentationPartResult |
updateDocumentationPart(UpdateDocumentationPartRequest request)
Updates a documentation part.
|
UpdateDocumentationVersionResult |
updateDocumentationVersion(UpdateDocumentationVersionRequest request)
Updates a documentation version.
|
UpdateDomainNameResult |
updateDomainName(UpdateDomainNameRequest request)
Changes information about the DomainName resource.
|
UpdateGatewayResponseResult |
updateGatewayResponse(UpdateGatewayResponseRequest request)
Updates a GatewayResponse of a specified response type on the given RestApi.
|
UpdateIntegrationResult |
updateIntegration(UpdateIntegrationRequest request)
Represents an update integration.
|
UpdateIntegrationResponseResult |
updateIntegrationResponse(UpdateIntegrationResponseRequest request)
Represents an update integration response.
|
UpdateMethodResult |
updateMethod(UpdateMethodRequest request)
Updates an existing Method resource.
|
UpdateMethodResponseResult |
updateMethodResponse(UpdateMethodResponseRequest request)
Updates an existing MethodResponse resource.
|
UpdateModelResult |
updateModel(UpdateModelRequest request)
Changes information about a model.
|
UpdateRequestValidatorResult |
updateRequestValidator(UpdateRequestValidatorRequest request)
Updates a RequestValidator of a given RestApi.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest request)
Changes information about a Resource resource.
|
UpdateRestApiResult |
updateRestApi(UpdateRestApiRequest request)
Changes information about the specified API.
|
UpdateStageResult |
updateStage(UpdateStageRequest request)
Changes information about a Stage resource.
|
UpdateUsageResult |
updateUsage(UpdateUsageRequest request)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
|
UpdateUsagePlanResult |
updateUsagePlan(UpdateUsagePlanRequest request)
Updates a usage plan of a given plan Id.
|
UpdateVpcLinkResult |
updateVpcLink(UpdateVpcLinkRequest request)
Updates an existing VpcLink of a specified identifier.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@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)
Create an ApiKey resource.
createApiKey
in interface AmazonApiGateway
createApiKeyRequest
- Request to create an ApiKey resource.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.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.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 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
Creates a new BasePathMapping resource.
createBasePathMapping
in interface AmazonApiGateway
createBasePathMappingRequest
- Requests API Gateway to create a new BasePathMapping resource.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.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.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 CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment
in interface AmazonApiGateway
createDeploymentRequest
- Requests API Gateway to create a Deployment resource.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.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.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 CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest request)
Creates a documentation part.
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.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.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 CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest request)
Creates a documentation version
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.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.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 CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
Creates a new domain name.
createDomainName
in interface AmazonApiGateway
createDomainNameRequest
- A request to create a new domain name.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.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.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 CreateModelResult createModel(CreateModelRequest request)
Adds a new Model resource to an existing RestApi resource.
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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest request)
Creates a RequestValidator 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 CreateResourceResult createResource(CreateResourceRequest request)
Creates a Resource resource.
createResource
in interface AmazonApiGateway
createResourceRequest
- Requests 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.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.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.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 CreateStageResult createStage(CreateStageRequest request)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStage
in interface AmazonApiGateway
createStageRequest
- Requests 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.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.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 CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest request)
Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
createVpcLink
in interface AmazonApiGateway
createVpcLinkRequest
- Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create
and update VPC Endpoint services.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.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.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 DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
Deletes the ApiKey resource.
deleteApiKey
in interface AmazonApiGateway
deleteApiKeyRequest
- A request to delete the ApiKey resource.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.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 DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
Deletes an existing Authorizer resource.
deleteAuthorizer
in interface AmazonApiGateway
deleteAuthorizerRequest
- Request to delete an existing Authorizer resource.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.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 DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)
Deletes the BasePathMapping resource.
deleteBasePathMapping
in interface AmazonApiGateway
deleteBasePathMappingRequest
- A request to delete the BasePathMapping resource.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.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 DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request)
Deletes the ClientCertificate resource.
deleteClientCertificate
in interface AmazonApiGateway
deleteClientCertificateRequest
- A request to delete the ClientCertificate resource.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.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 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 API Gateway to delete a Deployment resource.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.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.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 DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest request)
Deletes a documentation part
deleteDocumentationPart
in interface AmazonApiGateway
deleteDocumentationPartRequest
- Deletes an existing documentation part 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.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.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 DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest request)
Deletes a documentation version.
deleteDocumentationVersion
in interface AmazonApiGateway
deleteDocumentationVersionRequest
- Deletes an existing documentation version 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.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.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 DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
Deletes the DomainName resource.
deleteDomainName
in interface AmazonApiGateway
deleteDomainNameRequest
- A request to delete the DomainName resource.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.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 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.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.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 DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
Represents a delete integration.
deleteIntegration
in interface AmazonApiGateway
deleteIntegrationRequest
- Represents a delete integration request.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.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 DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
Represents a delete integration response.
deleteIntegrationResponse
in interface AmazonApiGateway
deleteIntegrationResponseRequest
- Represents a delete integration response request.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.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 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.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.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 DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest request)
Deletes a RequestValidator of a given RestApi.
deleteRequestValidator
in interface AmazonApiGateway
deleteRequestValidatorRequest
- Deletes a specified 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.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.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 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.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.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 DeleteStageResult deleteStage(DeleteStageRequest request)
Deletes a Stage resource.
deleteStage
in interface AmazonApiGateway
deleteStageRequest
- Requests API Gateway to delete a Stage resource.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.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.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 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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest request)
Deletes an existing VpcLink of a specified identifier.
deleteVpcLink
in interface AmazonApiGateway
deleteVpcLinkRequest
- Deletes an existing VpcLink of a specified identifier.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.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 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.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.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.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 FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)
Flushes a stage's cache.
flushStageCache
in interface AmazonApiGateway
flushStageCacheRequest
- Requests API Gateway to flush a stage's cache.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.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.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 GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
Generates a ClientCertificate resource.
generateClientCertificate
in interface AmazonApiGateway
generateClientCertificateRequest
- A request to generate a ClientCertificate resource.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.LimitExceededException
- The request exceeded the rate limit. Retry after the specified time period.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 GetAccountResult getAccount(GetAccountRequest request)
Gets information about the current Account resource.
getAccount
in interface AmazonApiGateway
getAccountRequest
- Requests API Gateway to get information about the current Account resource.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.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 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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
Describe a BasePathMapping resource.
getBasePathMapping
in interface AmazonApiGateway
getBasePathMappingRequest
- Request to describe a BasePathMapping resource.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.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 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.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.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 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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 API Gateway to get information about a Deployment resource.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.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 GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
Gets information about a Deployments collection.
getDeployments
in interface AmazonApiGateway
getDeploymentsRequest
- Requests 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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)
Gets a documentation part.
getDocumentationPart
in interface AmazonApiGateway
getDocumentationPartRequest
- Gets a specified 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest request)
Gets documentation parts.
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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest request)
Gets a documentation version.
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)
Gets documentation versions.
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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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.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.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.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 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.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.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 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 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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 GetIntegrationResult getIntegration(GetIntegrationRequest request)
Get the integration settings.
getIntegration
in interface AmazonApiGateway
getIntegrationRequest
- Represents a request to get the integration configuration.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.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 GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
Represents a get integration response.
getIntegrationResponse
in interface AmazonApiGateway
getIntegrationResponseRequest
- Represents a get integration response request.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.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 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.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.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 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)
Describes existing Models defined for a RestApi resource.
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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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)
Generates a client SDK for a RestApi and Stage.
getSdk
in interface AmazonApiGateway
getSdkRequest
- Request a new generated client SDK for a RestApi and Stage.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.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.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 GetSdkTypeResult getSdkType(GetSdkTypeRequest request)
Gets an SDK type.
getSdkType
in interface AmazonApiGateway
getSdkTypeRequest
- Get an SdkType instance.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.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 GetSdkTypesResult getSdkTypes(GetSdkTypesRequest request)
Gets SDK types
getSdkTypes
in interface AmazonApiGateway
getSdkTypesRequest
- Get the SdkTypes collection.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.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 API Gateway to get information about a Stage resource.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.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.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 GetStagesResult getStages(GetStagesRequest request)
Gets information about one or more Stage resources.
getStages
in interface AmazonApiGateway
getStagesRequest
- Requests API Gateway to get information about one or more Stage resources.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.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.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 GetTagsResult getTags(GetTagsRequest request)
Gets the Tags collection for a given resource.
getTags
in interface AmazonApiGateway
getTagsRequest
- Gets the Tags collection for a given resource.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.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 GetVpcLinkResult getVpcLink(GetVpcLinkRequest request)
Gets a specified VPC link under the caller's account in a region.
getVpcLink
in interface AmazonApiGateway
getVpcLinkRequest
- Gets a specified VPC link under the caller's account in a region.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.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 GetVpcLinksResult getVpcLinks(GetVpcLinksRequest request)
Gets the VpcLinks collection under the caller's account in a selected region.
getVpcLinks
in interface AmazonApiGateway
getVpcLinksRequest
- Gets the VpcLinks collection under the caller's account in a selected region.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.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 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.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.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.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 ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest request)
Imports documentation parts
importDocumentationParts
in interface AmazonApiGateway
importDocumentationPartsRequest
- Import documentation parts from an external (e.g., OpenAPI) definition file.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.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.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 ImportRestApiResult importRestApi(ImportRestApiRequest request)
A feature of the 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 API Gateway using an input of an API definition file.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.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.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 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 PutIntegrationResult putIntegration(PutIntegrationRequest request)
Sets up a method's integration.
putIntegration
in interface AmazonApiGateway
putIntegrationRequest
- Sets up a method's integration.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.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.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 PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
Represents a put integration.
putIntegrationResponse
in interface AmazonApiGateway
putIntegrationResponseRequest
- Represents a put integration response request.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.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.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 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 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.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.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.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 TagResourceResult tagResource(TagResourceRequest request)
Adds or updates a tag on a given resource.
tagResource
in interface AmazonApiGateway
tagResourceRequest
- Adds or updates a tag on a given resource.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.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.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 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 invocation 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 invocation 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 invocation 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 UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from a given resource.
untagResource
in interface AmazonApiGateway
untagResourceRequest
- Removes a tag from a given resource.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.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.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 UpdateAccountResult updateAccount(UpdateAccountRequest request)
Changes information about the current Account resource.
updateAccount
in interface AmazonApiGateway
updateAccountRequest
- Requests API Gateway to change information about the current Account resource.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.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.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 UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
Changes information about an ApiKey resource.
updateApiKey
in interface AmazonApiGateway
updateApiKeyRequest
- A request to change information about an ApiKey resource.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.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.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 UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
Updates an existing Authorizer resource.
updateAuthorizer
in interface AmazonApiGateway
updateAuthorizerRequest
- Request to update an existing Authorizer resource.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.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.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 UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
Changes information about the BasePathMapping resource.
updateBasePathMapping
in interface AmazonApiGateway
updateBasePathMappingRequest
- A request to change information about the BasePathMapping resource.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.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.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 UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request)
Changes information about an ClientCertificate resource.
updateClientCertificate
in interface AmazonApiGateway
updateClientCertificateRequest
- A request to change information about an ClientCertificate resource.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.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.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 UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
Changes information about a Deployment resource.
updateDeployment
in interface AmazonApiGateway
updateDeploymentRequest
- Requests API Gateway to change information about a Deployment resource.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.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.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 UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest request)
Updates a documentation part.
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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest request)
Updates a documentation version.
updateDocumentationVersion
in interface AmazonApiGateway
updateDocumentationVersionRequest
- Updates an existing documentation version 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
Changes information about the DomainName resource.
updateDomainName
in interface AmazonApiGateway
updateDomainNameRequest
- A request to change information about the DomainName resource.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.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.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 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.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.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.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 UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
Represents an update integration.
updateIntegration
in interface AmazonApiGateway
updateIntegrationRequest
- Represents an update integration request.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.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.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 UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
Represents an update integration response.
updateIntegrationResponse
in interface AmazonApiGateway
updateIntegrationResponseRequest
- Represents an update integration response request.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.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.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 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. The maximum size of the model is 400 KB.
updateModel
in interface AmazonApiGateway
updateModelRequest
- Request to update an existing model in 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest request)
Updates a RequestValidator of a given RestApi.
updateRequestValidator
in interface AmazonApiGateway
updateRequestValidatorRequest
- Updates 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.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.NotFoundException
- The requested resource is not found. Make sure that the request URI is correct.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 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.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.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.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 UpdateStageResult updateStage(UpdateStageRequest request)
Changes information about a Stage resource.
updateStage
in interface AmazonApiGateway
updateStageRequest
- Requests API Gateway to change information about a Stage resource.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.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.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 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.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.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.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 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.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.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.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 UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest request)
Updates an existing VpcLink of a specified identifier.
updateVpcLink
in interface AmazonApiGateway
updateVpcLinkRequest
- Updates an existing VpcLink of a specified identifier.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.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.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 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 requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonApiGateway
shutdown
in class AmazonWebServiceClient