@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonApiGatewayClient extends AmazonWebServiceClient implements AmazonApiGateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonApiGatewayClient()
Deprecated.
|
AmazonApiGatewayClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonApiGatewayClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonApiGatewayClientBuilder |
builder() |
CreateApiKeyResult |
createApiKey(CreateApiKeyRequest 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) |
CreateDocumentationVersionResult |
createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest) |
CreateDomainNameResult |
createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
|
CreateModelResult |
createModel(CreateModelRequest createModelRequest)
|
CreateResourceResult |
createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
|
CreateRestApiResult |
createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
|
CreateStageResult |
createStage(CreateStageRequest createStageRequest)
Creates a 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.
|
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) |
DeleteDocumentationVersionResult |
deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest) |
DeleteDomainNameResult |
deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
|
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.
|
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.
|
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) |
GetDocumentationPartsResult |
getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest) |
GetDocumentationVersionResult |
getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest) |
GetDocumentationVersionsResult |
getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest) |
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.
|
GetIntegrationResult |
getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
|
GetIntegrationResponseResult |
getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
|
GetMethodResult |
getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
|
GetMethodResponseResult |
getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
|
GetModelResult |
getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
|
GetModelsResult |
getModels(GetModelsRequest getModelsRequest)
|
GetModelTemplateResult |
getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
|
GetResourceResult |
getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
|
GetResourcesResult |
getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
|
GetRestApiResult |
getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
|
GetRestApisResult |
getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
|
GetSdkResult |
getSdk(GetSdkRequest getSdkRequest)
|
GetSdkTypeResult |
getSdkType(GetSdkTypeRequest getSdkTypeRequest) |
GetSdkTypesResult |
getSdkTypes(GetSdkTypesRequest getSdkTypesRequest) |
GetStageResult |
getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
|
GetStagesResult |
getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
|
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.
|
ImportApiKeysResult |
importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
|
ImportDocumentationPartsResult |
importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest) |
ImportRestApiResult |
importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
|
PutIntegrationResult |
putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
|
PutIntegrationResponseResult |
putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
|
PutMethodResult |
putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
|
PutMethodResponseResult |
putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
|
PutRestApiResult |
putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API
definitions.
|
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)
|
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) |
UpdateDocumentationVersionResult |
updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest) |
UpdateDomainNameResult |
updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
|
UpdateIntegrationResult |
updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
|
UpdateIntegrationResponseResult |
updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
|
UpdateMethodResult |
updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
|
UpdateMethodResponseResult |
updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
|
UpdateModelResult |
updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
|
UpdateResourceResult |
updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
|
UpdateRestApiResult |
updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
|
UpdateStageResult |
updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
|
UpdateUsageResult |
updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
|
UpdateUsagePlanResult |
updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AmazonApiGatewayClient()
AmazonApiGatewayClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonApiGatewayClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonApiGatewayClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonApiGatewayClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy
settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonApiGatewayClientBuilder builder()
public CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)
createApiKey in interface AmazonApiGatewaycreateApiKeyRequest - Request to create an ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionBadRequestExceptionConflictExceptionpublic CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Adds a new Authorizer resource to an existing RestApi resource.
createAuthorizer in interface AmazonApiGatewaycreateAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionpublic CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)
Creates a new BasePathMapping resource.
createBasePathMapping in interface AmazonApiGatewaycreateBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.UnauthorizedExceptionConflictExceptionBadRequestExceptionNotFoundExceptionTooManyRequestsExceptionpublic CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment in interface AmazonApiGatewaycreateDeploymentRequest - Requests Amazon API Gateway to create a Deployment resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionServiceUnavailableExceptionpublic CreateDocumentationPartResult createDocumentationPart(CreateDocumentationPartRequest createDocumentationPartRequest)
createDocumentationPart in interface AmazonApiGatewaycreateDocumentationPartRequest - Creates a new documentation part of a given API.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionpublic CreateDocumentationVersionResult createDocumentationVersion(CreateDocumentationVersionRequest createDocumentationVersionRequest)
createDocumentationVersion in interface AmazonApiGatewaycreateDocumentationVersionRequest - Creates a new documentation version of a given API.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionLimitExceededExceptionTooManyRequestsExceptionpublic CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a new domain name.
createDomainName in interface AmazonApiGatewaycreateDomainNameRequest - A request to create a new domain name.UnauthorizedExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic CreateModelResult createModel(CreateModelRequest createModelRequest)
createModel in interface AmazonApiGatewaycreateModelRequest - Request to add a new Model to an existing RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionpublic CreateResourceResult createResource(CreateResourceRequest createResourceRequest)
Creates a Resource resource.
createResource in interface AmazonApiGatewaycreateResourceRequest - Requests Amazon API Gateway to create a Resource resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionpublic CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)
Creates a new RestApi resource.
createRestApi in interface AmazonApiGatewaycreateRestApiRequest - The POST Request to add a new RestApi resource to your collection.UnauthorizedExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionpublic CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a new Stage resource that references a pre-existing Deployment for the API.
createStage in interface AmazonApiGatewaycreateStageRequest - Requests Amazon API Gateway to create a Stage resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionpublic 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.
createUsagePlan in interface AmazonApiGatewaycreateUsagePlanRequest - 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.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionConflictExceptionNotFoundExceptionpublic CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)
Creates a usage plan key for adding an existing API key to a usage plan.
createUsagePlanKey in interface AmazonApiGatewaycreateUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)
Deletes the ApiKey resource.
deleteApiKey in interface AmazonApiGatewaydeleteApiKeyRequest - A request to delete the ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an existing Authorizer resource.
deleteAuthorizer in interface AmazonApiGatewaydeleteAuthorizerRequest - Request to delete an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionpublic DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)
Deletes the BasePathMapping resource.
deleteBasePathMapping in interface AmazonApiGatewaydeleteBasePathMappingRequest - A request to delete the BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)
Deletes the ClientCertificate resource.
deleteClientCertificate in interface AmazonApiGatewaydeleteClientCertificateRequest - A request to delete the ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionpublic DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeployment in interface AmazonApiGatewaydeleteDeploymentRequest - Requests Amazon API Gateway to delete a Deployment resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic DeleteDocumentationPartResult deleteDocumentationPart(DeleteDocumentationPartRequest deleteDocumentationPartRequest)
deleteDocumentationPart in interface AmazonApiGatewaydeleteDocumentationPartRequest - Deletes an existing documentation part of an API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionBadRequestExceptionpublic DeleteDocumentationVersionResult deleteDocumentationVersion(DeleteDocumentationVersionRequest deleteDocumentationVersionRequest)
deleteDocumentationVersion in interface AmazonApiGatewaydeleteDocumentationVersionRequest - Deletes an existing documentation version of an API.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes the DomainName resource.
deleteDomainName in interface AmazonApiGatewaydeleteDomainNameRequest - A request to delete the DomainName resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Represents a delete integration.
deleteIntegration in interface AmazonApiGatewaydeleteIntegrationRequest - Represents a delete integration request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionpublic DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Represents a delete integration response.
deleteIntegrationResponse in interface AmazonApiGatewaydeleteIntegrationResponseRequest - Represents a delete integration response request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionpublic DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)
Deletes an existing Method resource.
deleteMethod in interface AmazonApiGatewaydeleteMethodRequest - Request to delete an existing Method resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionConflictExceptionpublic DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)
Deletes an existing MethodResponse resource.
deleteMethodResponse in interface AmazonApiGatewaydeleteMethodResponseRequest - A request to delete an existing MethodResponse resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionpublic DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a model.
deleteModel in interface AmazonApiGatewaydeleteModelRequest - Request to delete an existing model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionConflictExceptionpublic DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)
Deletes a Resource resource.
deleteResource in interface AmazonApiGatewaydeleteResourceRequest - Request to delete a Resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)
Deletes the specified API.
deleteRestApi in interface AmazonApiGatewaydeleteRestApiRequest - Request to delete the specified API from your collection.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionpublic DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage resource.
deleteStage in interface AmazonApiGatewaydeleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionBadRequestExceptionpublic DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)
Deletes a usage plan of a given plan Id.
deleteUsagePlan in interface AmazonApiGatewaydeleteUsagePlanRequest - The DELETE request to delete a uasge plan of a given plan Id.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionpublic DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
deleteUsagePlanKey in interface AmazonApiGatewaydeleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage
plan.BadRequestExceptionConflictExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)
Flushes all authorizer cache entries on a stage.
flushStageAuthorizersCache in interface AmazonApiGatewayflushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic FlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)
Flushes a stage's cache.
flushStageCache in interface AmazonApiGatewayflushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)
Generates a ClientCertificate resource.
generateClientCertificate in interface AmazonApiGatewaygenerateClientCertificateRequest - A request to generate a ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionLimitExceededExceptionpublic GetAccountResult getAccount(GetAccountRequest getAccountRequest)
Gets information about the current Account resource.
getAccount in interface AmazonApiGatewaygetAccountRequest - Requests Amazon API Gateway to get information about the current Account resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)
Gets information about the current ApiKey resource.
getApiKey in interface AmazonApiGatewaygetApiKeyRequest - A request to get information about the current ApiKey resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)
Gets information about the current ApiKeys resource.
getApiKeys in interface AmazonApiGatewaygetApiKeysRequest - A request to get information about the current ApiKeys resource.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionpublic GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Describe an existing Authorizer resource.
getAuthorizer in interface AmazonApiGatewaygetAuthorizerRequest - Request to describe an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Describe an existing Authorizers resource.
getAuthorizers in interface AmazonApiGatewaygetAuthorizersRequest - Request to describe an existing Authorizers resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)
Describe a BasePathMapping resource.
getBasePathMapping in interface AmazonApiGatewaygetBasePathMappingRequest - Request to describe a BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)
Represents a collection of BasePathMapping resources.
getBasePathMappings in interface AmazonApiGatewaygetBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)
Gets information about the current ClientCertificate resource.
getClientCertificate in interface AmazonApiGatewaygetClientCertificateRequest - A request to get information about the current ClientCertificate resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)
Gets a collection of ClientCertificate resources.
getClientCertificates in interface AmazonApiGatewaygetClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionpublic GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets information about a Deployment resource.
getDeployment in interface AmazonApiGatewaygetDeploymentRequest - Requests Amazon API Gateway to get information about a Deployment resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionServiceUnavailableExceptionpublic GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets information about a Deployments collection.
getDeployments in interface AmazonApiGatewaygetDeploymentsRequest - Requests Amazon API Gateway to get information about a Deployments collection.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionServiceUnavailableExceptionpublic GetDocumentationPartResult getDocumentationPart(GetDocumentationPartRequest getDocumentationPartRequest)
getDocumentationPart in interface AmazonApiGatewaygetDocumentationPartRequest - Gets a specified documentation part of a given API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetDocumentationPartsResult getDocumentationParts(GetDocumentationPartsRequest getDocumentationPartsRequest)
getDocumentationParts in interface AmazonApiGatewaygetDocumentationPartsRequest - Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API
entities (targets).BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetDocumentationVersionResult getDocumentationVersion(GetDocumentationVersionRequest getDocumentationVersionRequest)
getDocumentationVersion in interface AmazonApiGatewaygetDocumentationVersionRequest - Gets a documentation snapshot of an API.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetDocumentationVersionsResult getDocumentationVersions(GetDocumentationVersionsRequest getDocumentationVersionsRequest)
getDocumentationVersions in interface AmazonApiGatewaygetDocumentationVersionsRequest - Gets the documentation versions of an API.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainName in interface AmazonApiGatewaygetDomainNameRequest - Request to get the name of a DomainName resource.UnauthorizedExceptionNotFoundExceptionServiceUnavailableExceptionTooManyRequestsExceptionpublic GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Represents a collection of DomainName resources.
getDomainNames in interface AmazonApiGatewaygetDomainNamesRequest - Request to describe a collection of DomainName resources.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionpublic GetExportResult getExport(GetExportRequest getExportRequest)
Exports a deployed version of a RestApi in a specified format.
getExport in interface AmazonApiGatewaygetExportRequest - Request a new export of a RestApi for a particular Stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Represents a get integration.
getIntegration in interface AmazonApiGatewaygetIntegrationRequest - Represents a get integration request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Represents a get integration response.
getIntegrationResponse in interface AmazonApiGatewaygetIntegrationResponseRequest - Represents a get integration response request.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetMethodResult getMethod(GetMethodRequest getMethodRequest)
Describe an existing Method resource.
getMethod in interface AmazonApiGatewaygetMethodRequest - Request to describe an existing Method resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)
Describes a MethodResponse resource.
getMethodResponse in interface AmazonApiGatewaygetMethodResponseRequest - Request to describe a MethodResponse resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetModelResult getModel(GetModelRequest getModelRequest)
Describes an existing model defined for a RestApi resource.
getModel in interface AmazonApiGatewaygetModelRequest - Request to list information about a model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplate in interface AmazonApiGatewaygetModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic GetModelsResult getModels(GetModelsRequest getModelsRequest)
getModels in interface AmazonApiGatewaygetModelsRequest - Request to list existing Models defined for a RestApi resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetResourceResult getResource(GetResourceRequest getResourceRequest)
Lists information about a resource.
getResource in interface AmazonApiGatewaygetResourceRequest - Request to list information about a resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)
Lists information about a collection of Resource resources.
getResources in interface AmazonApiGatewaygetResourcesRequest - Request to list information about a collection of resources.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)
Lists the RestApi resource in the collection.
getRestApi in interface AmazonApiGatewaygetRestApiRequest - The GET request to list an existing RestApi defined for your collection.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)
Lists the RestApis resources for your collection.
getRestApis in interface AmazonApiGatewaygetRestApisRequest - The GET request to list existing RestApis defined for your collection.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionpublic GetSdkResult getSdk(GetSdkRequest getSdkRequest)
getSdk in interface AmazonApiGatewaygetSdkRequest - Request a new generated client SDK for a RestApi and Stage.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic GetSdkTypeResult getSdkType(GetSdkTypeRequest getSdkTypeRequest)
getSdkType in interface AmazonApiGatewaygetSdkTypeRequest - Get an SdkType instance.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetSdkTypesResult getSdkTypes(GetSdkTypesRequest getSdkTypesRequest)
getSdkTypes in interface AmazonApiGatewaygetSdkTypesRequest - Get the SdkTypes collection.UnauthorizedExceptionTooManyRequestsExceptionpublic GetStageResult getStage(GetStageRequest getStageRequest)
Gets information about a Stage resource.
getStage in interface AmazonApiGatewaygetStageRequest - Requests Amazon API Gateway to get information about a Stage resource.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets information about one or more Stage resources.
getStages in interface AmazonApiGatewaygetStagesRequest - Requests Amazon API Gateway to get information about one or more Stage resources.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetUsageResult getUsage(GetUsageRequest getUsageRequest)
Gets the usage data of a usage plan in a specified time interval.
getUsage in interface AmazonApiGatewaygetUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetUsagePlanResult getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)
Gets a usage plan of a given plan identifier.
getUsagePlan in interface AmazonApiGatewaygetUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)
Gets a usage plan key of a given key identifier.
getUsagePlanKey in interface AmazonApiGatewaygetUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)
Gets all the usage plan keys representing the API keys added to a specified usage plan.
getUsagePlanKeys in interface AmazonApiGatewaygetUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic GetUsagePlansResult getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)
Gets all the usage plans of the caller's account.
getUsagePlans in interface AmazonApiGatewaygetUsagePlansRequest - The GET request to get all the usage plans of the caller's account.BadRequestExceptionUnauthorizedExceptionTooManyRequestsExceptionConflictExceptionNotFoundExceptionpublic ImportApiKeysResult importApiKeys(ImportApiKeysRequest importApiKeysRequest)
Import API keys from an external source, such as a CSV-formatted file.
importApiKeys in interface AmazonApiGatewayimportApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.UnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionLimitExceededExceptionBadRequestExceptionConflictExceptionpublic ImportDocumentationPartsResult importDocumentationParts(ImportDocumentationPartsRequest importDocumentationPartsRequest)
importDocumentationParts in interface AmazonApiGatewayimportDocumentationPartsRequest - Import documentation parts from an external (e.g., Swagger) definition file.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionLimitExceededExceptionTooManyRequestsExceptionpublic ImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
importRestApi in interface AmazonApiGatewayimportRestApiRequest - A POST request to import an API to Amazon API Gateway using an input of an API definition file.UnauthorizedExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionpublic PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)
Represents a put integration.
putIntegration in interface AmazonApiGatewayputIntegrationRequest - Represents a put integration request.UnauthorizedExceptionBadRequestExceptionConflictExceptionNotFoundExceptionTooManyRequestsExceptionpublic PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)
Represents a put integration.
putIntegrationResponse in interface AmazonApiGatewayputIntegrationResponseRequest - Represents a put integration response request.UnauthorizedExceptionNotFoundExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionpublic PutMethodResult putMethod(PutMethodRequest putMethodRequest)
Add a method to an existing Resource resource.
putMethod in interface AmazonApiGatewayputMethodRequest - Request to add a method to an existing Resource resource.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionpublic PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)
Adds a MethodResponse to an existing Method resource.
putMethodResponse in interface AmazonApiGatewayputMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionpublic PutRestApiResult putRestApi(PutRestApiRequest putRestApiRequest)
A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
putRestApi in interface AmazonApiGatewayputRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.UnauthorizedExceptionLimitExceededExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionpublic TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
testInvokeAuthorizer in interface AmazonApiGatewaytestInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
testInvokeMethod in interface AmazonApiGatewaytestInvokeMethodRequest - Make a request to simulate the execution of a Method.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionTooManyRequestsExceptionpublic UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)
Changes information about the current Account resource.
updateAccount in interface AmazonApiGatewayupdateAccountRequest - Requests Amazon API Gateway to change information about the current Account resource.UnauthorizedExceptionBadRequestExceptionNotFoundExceptionTooManyRequestsExceptionpublic UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)
Changes information about an ApiKey resource.
updateApiKey in interface AmazonApiGatewayupdateApiKeyRequest - A request to change information about an ApiKey resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionpublic UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an existing Authorizer resource.
updateAuthorizer in interface AmazonApiGatewayupdateAuthorizerRequest - Request to update an existing Authorizer resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)
Changes information about the BasePathMapping resource.
updateBasePathMapping in interface AmazonApiGatewayupdateBasePathMappingRequest - A request to change information about the BasePathMapping resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)
Changes information about an ClientCertificate resource.
updateClientCertificate in interface AmazonApiGatewayupdateClientCertificateRequest - A request to change information about an ClientCertificate resource.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionpublic UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Changes information about a Deployment resource.
updateDeployment in interface AmazonApiGatewayupdateDeploymentRequest - Requests Amazon API Gateway to change information about a Deployment resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionServiceUnavailableExceptionpublic UpdateDocumentationPartResult updateDocumentationPart(UpdateDocumentationPartRequest updateDocumentationPartRequest)
updateDocumentationPart in interface AmazonApiGatewayupdateDocumentationPartRequest - Updates an existing documentation part of a given API.BadRequestExceptionUnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionTooManyRequestsExceptionpublic UpdateDocumentationVersionResult updateDocumentationVersion(UpdateDocumentationVersionRequest updateDocumentationVersionRequest)
updateDocumentationVersion in interface AmazonApiGatewayupdateDocumentationVersionRequest - Updates an existing documentation version of an API.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Changes information about the DomainName resource.
updateDomainName in interface AmazonApiGatewayupdateDomainNameRequest - A request to change information about the DomainName resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Represents an update integration.
updateIntegration in interface AmazonApiGatewayupdateIntegrationRequest - Represents an update integration request.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionTooManyRequestsExceptionConflictExceptionpublic UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Represents an update integration response.
updateIntegrationResponse in interface AmazonApiGatewayupdateIntegrationResponseRequest - Represents an update integration response request.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)
Updates an existing Method resource.
updateMethod in interface AmazonApiGatewayupdateMethodRequest - Request to update an existing Method resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)
Updates an existing MethodResponse resource.
updateMethodResponse in interface AmazonApiGatewayupdateMethodResponseRequest - A request to update an existing MethodResponse resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionLimitExceededExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Changes information about a model.
updateModel in interface AmazonApiGatewayupdateModelRequest - Request to update an existing model in an existing RestApi resource.UnauthorizedExceptionNotFoundExceptionBadRequestExceptionConflictExceptionTooManyRequestsExceptionpublic UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)
Changes information about a Resource resource.
updateResource in interface AmazonApiGatewayupdateResourceRequest - Request to change information about a Resource resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)
Changes information about the specified API.
updateRestApi in interface AmazonApiGatewayupdateRestApiRequest - Request to update an existing RestApi resource in your collection.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Changes information about a Stage resource.
updateStage in interface AmazonApiGatewayupdateStageRequest - Requests Amazon API Gateway to change information about a Stage resource.UnauthorizedExceptionNotFoundExceptionConflictExceptionBadRequestExceptionTooManyRequestsExceptionpublic UpdateUsageResult updateUsage(UpdateUsageRequest updateUsageRequest)
Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.
updateUsage in interface AmazonApiGatewayupdateUsageRequest - The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a
specified API key.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionpublic UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)
Updates a usage plan of a given plan Id.
updateUsagePlan in interface AmazonApiGatewayupdateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.UnauthorizedExceptionTooManyRequestsExceptionBadRequestExceptionNotFoundExceptionConflictExceptionpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonApiGatewayrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.