@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonApiGateway
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonApiGateway
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
|
CreateBasePathMappingResult |
createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
|
CreateDocumentationPartResult |
createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
Creates a documentation part.
|
CreateDocumentationVersionResult |
createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
Creates a documentation version
|
CreateDomainNameResult |
createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
|
CreateModelResult |
createModel(CreateModelRequest createModelRequest)
Adds a new Model resource to an existing RestApi resource.
|
CreateRequestValidatorResult |
createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
Creates a RequestValidator of a given RestApi.
|
CreateResourceResult |
createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
|
CreateRestApiResult |
createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
|
CreateStageResult |
createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
|
CreateUsagePlanResult |
createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the
payload.
|
CreateUsagePlanKeyResult |
createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
|
CreateVpcLinkResult |
createVpcLink(CreateVpcLinkRequest 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.
|
DeleteApiKeyResult |
deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
|
DeleteBasePathMappingResult |
deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
|
DeleteClientCertificateResult |
deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
|
DeleteDeploymentResult |
deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource.
|
DeleteDocumentationPartResult |
deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
Deletes a documentation part
|
DeleteDocumentationVersionResult |
deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
Deletes a documentation version.
|
DeleteDomainNameResult |
deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
|
DeleteGatewayResponseResult |
deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
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 deleteIntegrationRequest)
Represents a delete integration.
|
DeleteIntegrationResponseResult |
deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
|
DeleteMethodResult |
deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
|
DeleteMethodResponseResult |
deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
|
DeleteModelResult |
deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
|
DeleteRequestValidatorResult |
deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
|
DeleteResourceResult |
deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
|
DeleteRestApiResult |
deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
|
DeleteStageResult |
deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
|
DeleteUsagePlanResult |
deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
|
DeleteUsagePlanKeyResult |
deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
|
DeleteVpcLinkResult |
deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
|
FlushStageAuthorizersCacheResult |
flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
|
FlushStageCacheResult |
flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
|
GenerateClientCertificateResult |
generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
|
GetAccountResult |
getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
|
GetApiKeyResult |
getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
|
GetApiKeysResult |
getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
|
GetAuthorizerResult |
getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
|
GetAuthorizersResult |
getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
|
GetBasePathMappingResult |
getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
|
GetBasePathMappingsResult |
getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetClientCertificateResult |
getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
|
GetClientCertificatesResult |
getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
|
GetDeploymentResult |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
|
GetDeploymentsResult |
getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
|
GetDocumentationPartResult |
getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
Gets a documentation part.
|
GetDocumentationPartsResult |
getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
Gets documentation parts.
|
GetDocumentationVersionResult |
getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
Gets a documentation version.
|
GetDocumentationVersionsResult |
getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
Gets documentation versions.
|
GetDomainNameResult |
getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
GetDomainNamesResult |
getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
|
GetExportResult |
getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
|
GetGatewayResponseResult |
getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
|
GetGatewayResponsesResult |
getGatewayResponses(GetGatewayResponsesRequest getGatewayResponsesRequest)
Gets the GatewayResponses collection on the given RestApi.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Get the integration settings.
|
GetIntegrationResponseResult |
getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
|
GetMethodResult |
getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
|
GetMethodResponseResult |
getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
|
GetModelResult |
getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
|
GetModelsResult |
getModels(GetModelsRequest getModelsRequest)
Describes existing Models defined for a RestApi resource.
|
GetModelTemplateResult |
getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
GetRequestValidatorResult |
getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
|
GetRequestValidatorsResult |
getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
|
GetResourceResult |
getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
|
GetResourcesResult |
getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
|
GetRestApiResult |
getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
|
GetRestApisResult |
getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
|
GetSdkResult |
getSdk(GetSdkRequest getSdkRequest)
Generates a client SDK for a RestApi and Stage.
|
GetSdkTypeResult |
getSdkType(GetSdkTypeRequest getSdkTypeRequest)
Gets an SDK type.
|
GetSdkTypesResult |
getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
Gets SDK types
|
GetStageResult |
getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
|
GetStagesResult |
getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
|
GetTagsResult |
getTags(GetTagsRequest getTagsRequest)
Gets the Tags collection for a given resource.
|
GetUsageResult |
getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
|
GetUsagePlanResult |
getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
|
GetUsagePlanKeyResult |
getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
|
GetUsagePlanKeysResult |
getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
|
GetUsagePlansResult |
getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
|
GetVpcLinkResult |
getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
|
GetVpcLinksResult |
getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
|
ImportApiKeysResult |
importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
|
ImportDocumentationPartsResult |
importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
Imports documentation parts
|
ImportRestApiResult |
importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the API Gateway control service for creating a new API from an external API definition file.
|
PutGatewayResponseResult |
putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest putIntegrationRequest)
Sets up a method's integration.
|
PutIntegrationResponseResult |
putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
|
PutMethodResult |
putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
|
PutMethodResponseResult |
putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
|
PutRestApiResult |
putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the API Gateway control service for updating an existing API with an input of external API
definitions.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates a tag on a given resource.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
|
TestInvokeMethodResult |
testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a given resource.
|
UpdateAccountResult |
updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
|
UpdateApiKeyResult |
updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
|
UpdateBasePathMappingResult |
updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
|
UpdateClientCertificateResult |
updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
|
UpdateDeploymentResult |
updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
|
UpdateDocumentationPartResult |
updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
Updates a documentation part.
|
UpdateDocumentationVersionResult |
updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
Updates a documentation version.
|
UpdateDomainNameResult |
updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
|
UpdateGatewayResponseResult |
updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
|
UpdateIntegrationResult |
updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
|
UpdateIntegrationResponseResult |
updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
|
UpdateMethodResult |
updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
|
UpdateMethodResponseResult |
updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
|
UpdateModelResult |
updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
|
UpdateRequestValidatorResult |
updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
|
UpdateRestApiResult |
updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
|
UpdateStageResult |
updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
|
UpdateUsageResult |
updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
|
UpdateUsagePlanResult |
updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
|
UpdateVpcLinkResult |
updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://apigateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
Create an ApiKey resource.
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.CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
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.CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
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.CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
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.CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
Creates a documentation part.
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.CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
Creates a documentation version
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.CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
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.CreateModelResult createModel(CreateModelRequest createModelRequest)
Adds a new Model resource to an existing RestApi resource.
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.CreateRequestValidatorResult createRequestValidator(CreateRequestValidatorRequest createRequestValidatorRequest)
Creates a RequestValidator of a given RestApi.
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.CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
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.CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
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.CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
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.CreateUsagePlanResult createUsagePlan(CreateUsagePlanRequest createUsagePlanRequest)
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
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.CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
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.CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest 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.
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.DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
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.DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
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.DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
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.DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
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.DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
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.DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
Deletes a documentation part
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.DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
Deletes a documentation version.
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.DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
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.DeleteGatewayResponseResult deleteGatewayResponse(DeleteGatewayResponseRequest deleteGatewayResponseRequest)
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
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.DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
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.DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
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.DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
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.DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
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.DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
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.DeleteRequestValidatorResult deleteRequestValidator(DeleteRequestValidatorRequest deleteRequestValidatorRequest)
Deletes a RequestValidator of a given RestApi.
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.DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
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.DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
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.DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
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.DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
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.DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
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.DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes an existing VpcLink of a specified identifier.
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.FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
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.FlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
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.GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
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.GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
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.GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
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.GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
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.GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
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.GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
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.GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
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.GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
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.GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
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.GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
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.GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
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.GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
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.GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
Gets a documentation part.
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.GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
Gets documentation parts.
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.GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
Gets a documentation version.
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.GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
Gets documentation versions.
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.GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
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.GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
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.GetExportResult getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
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.GetGatewayResponseResult getGatewayResponse(GetGatewayResponseRequest getGatewayResponseRequest)
Gets a GatewayResponse of a specified response type on the given RestApi.
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.GetGatewayResponsesResult getGatewayResponses(GetGatewayResponsesRequest 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.
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.GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Get the integration settings.
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.GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
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.GetMethodResult getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
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.GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
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.GetModelResult getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
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.GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
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.GetModelsResult getModels(GetModelsRequest getModelsRequest)
Describes existing Models defined for a RestApi resource.
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.GetRequestValidatorResult getRequestValidator(GetRequestValidatorRequest getRequestValidatorRequest)
Gets a RequestValidator of a given RestApi.
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.GetRequestValidatorsResult getRequestValidators(GetRequestValidatorsRequest getRequestValidatorsRequest)
Gets the RequestValidators collection of a given RestApi.
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.GetResourceResult getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
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.GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
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.GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
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.GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
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.GetSdkResult getSdk(GetSdkRequest getSdkRequest)
Generates a client SDK for a RestApi and Stage.
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.GetSdkTypeResult getSdkType(GetSdkTypeRequest getSdkTypeRequest)
Gets an SDK type.
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.GetSdkTypesResult getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
Gets SDK types
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.GetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
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.GetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
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.GetTagsResult getTags(GetTagsRequest getTagsRequest)
Gets the Tags collection for a given resource.
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.GetUsageResult getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
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.GetUsagePlanResult getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
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.GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
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.GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
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.GetUsagePlansResult getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
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.GetVpcLinkResult getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
Gets a specified VPC link under the caller's account in a region.
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.GetVpcLinksResult getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
Gets the VpcLinks collection under the caller's account in a selected region.
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.ImportApiKeysResult importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
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.ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
Imports documentation parts
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.ImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the API Gateway control service for creating a new API from an external API definition file.
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.PutGatewayResponseResult putGatewayResponse(PutGatewayResponseRequest putGatewayResponseRequest)
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
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.PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Sets up a method's integration.
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.PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
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.PutMethodResult putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
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.PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
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.PutRestApiResult putRestApi(PutRestApiRequest putRestApiRequest)
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.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or updates a tag on a given resource.
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.TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
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.TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a given resource.
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.UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
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.UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
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.UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
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.UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
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.UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
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.UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
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.UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
Updates a documentation part.
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.UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
Updates a documentation version.
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.UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
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.UpdateGatewayResponseResult updateGatewayResponse(UpdateGatewayResponseRequest updateGatewayResponseRequest)
Updates a GatewayResponse of a specified response type on the given RestApi.
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.UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
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.UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
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.UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
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.UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
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.UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model. The maximum size of the model is 400 KB.
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.UpdateRequestValidatorResult updateRequestValidator(UpdateRequestValidatorRequest updateRequestValidatorRequest)
Updates a RequestValidator of a given RestApi.
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.UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
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.UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
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.UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
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.UpdateUsageResult updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
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.UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
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.UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates an existing VpcLink of a specified identifier.
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.void shutdown()
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 a request.
request
- The originally executed request.