com.amazonaws.services.apigateway

Class AmazonApiGatewayClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.apigateway.AmazonApiGatewayClient

All Implemented Interfaces:

AmazonApiGateway

Direct Known Subclasses:

AmazonApiGatewayAsyncClient

@ThreadSafe
public class AmazonApiGatewayClient
extends AmazonWebServiceClient
implements AmazonApiGateway

Client for accessing Amazon API Gateway. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon API Gateway

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonApiGatewayClient() Constructs a new client to invoke service methods on Amazon API Gateway.
AmazonApiGatewayClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials.
AmazonApiGatewayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials and client configuration options.
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider.
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider and client configuration options.
AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonApiGatewayClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon API Gateway.

Method Summary

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.
CreateDomainNameResult	createDomainName(CreateDomainNameRequest createDomainNameRequest) Creates a new domain name.
CreateModelResult	createModel(CreateModelRequest createModelRequest) Adds a new Model resource to an existing RestApi resource.
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.
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.
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) 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.
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.
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.
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) Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
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.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AmazonApiGatewayClient

public AmazonApiGatewayClient()

Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonApiGatewayClient

public AmazonApiGatewayClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon API Gateway. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon API Gateway (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonApiGatewayClient

public AmazonApiGatewayClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonApiGatewayClient

public AmazonApiGatewayClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AmazonApiGatewayClient

public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonApiGatewayClient

public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AmazonApiGatewayClient

public AmazonApiGatewayClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on Amazon API Gateway using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

createApiKey

public CreateApiKeyResult createApiKey(CreateApiKeyRequest createApiKeyRequest)

Create an ApiKey resource.

AWS CLI

Specified by:

createApiKey in interface AmazonApiGateway

Parameters:

createApiKeyRequest - Request to create an ApiKey resource.

Returns:

Result of the CreateApiKey operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

LimitExceededException

BadRequestException

ConflictException

createAuthorizer

public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI

Specified by:

createAuthorizer in interface AmazonApiGateway

Parameters:

createAuthorizerRequest - Request to add a new Authorizer to an existing RestApi resource.

Returns:

Result of the CreateAuthorizer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

LimitExceededException

TooManyRequestsException

createBasePathMapping

public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest createBasePathMappingRequest)

Creates a new BasePathMapping resource.

Specified by:

createBasePathMapping in interface AmazonApiGateway

Parameters:

createBasePathMappingRequest - Requests Amazon API Gateway to create a new BasePathMapping resource.

Returns:

Result of the CreateBasePathMapping operation returned by the service.

Throws:

UnauthorizedException

ConflictException

BadRequestException

NotFoundException

TooManyRequestsException

createDeployment

public CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Specified by:

createDeployment in interface AmazonApiGateway

Parameters:

createDeploymentRequest - Requests Amazon API Gateway to create a Deployment resource.

Returns:

Result of the CreateDeployment operation returned by the service.

Throws:

UnauthorizedException

BadRequestException

NotFoundException

ConflictException

LimitExceededException

TooManyRequestsException

ServiceUnavailableException

createDomainName

public CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)

Creates a new domain name.

Specified by:

createDomainName in interface AmazonApiGateway

Parameters:

createDomainNameRequest - A request to create a new domain name.

Returns:

Result of the CreateDomainName operation returned by the service.

Throws:

UnauthorizedException

BadRequestException

ConflictException

TooManyRequestsException

createModel

public CreateModelResult createModel(CreateModelRequest createModelRequest)

Adds a new Model resource to an existing RestApi resource.

Specified by:

createModel in interface AmazonApiGateway

Parameters:

createModelRequest - Request to add a new Model to an existing RestApi resource.

Returns:

Result of the CreateModel operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

ConflictException

LimitExceededException

TooManyRequestsException

createResource

public CreateResourceResult createResource(CreateResourceRequest createResourceRequest)

Creates a Resource resource.

Specified by:

createResource in interface AmazonApiGateway

Parameters:

createResourceRequest - Requests Amazon API Gateway to create a Resource resource.

Returns:

Result of the CreateResource operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

LimitExceededException

BadRequestException

TooManyRequestsException

createRestApi

public CreateRestApiResult createRestApi(CreateRestApiRequest createRestApiRequest)

Creates a new RestApi resource.

Specified by:

createRestApi in interface AmazonApiGateway

Parameters:

createRestApiRequest - The POST Request to add a new RestApi resource to your collection.

Returns:

Result of the CreateRestApi operation returned by the service.

Throws:

UnauthorizedException

LimitExceededException

BadRequestException

TooManyRequestsException

createStage

public CreateStageResult createStage(CreateStageRequest createStageRequest)

Creates a new Stage resource that references a pre-existing Deployment for the API.

Specified by:

createStage in interface AmazonApiGateway

Parameters:

createStageRequest - Requests Amazon API Gateway to create a Stage resource.

Returns:

Result of the CreateStage operation returned by the service.

Throws:

UnauthorizedException

BadRequestException

NotFoundException

ConflictException

LimitExceededException

TooManyRequestsException

createUsagePlan

public 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.

Specified by:

createUsagePlan in interface AmazonApiGateway

Parameters:

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.

Returns:

Result of the CreateUsagePlan operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

LimitExceededException

ConflictException

createUsagePlanKey

public CreateUsagePlanKeyResult createUsagePlanKey(CreateUsagePlanKeyRequest createUsagePlanKeyRequest)

Creates a usage plan key for adding an existing API key to a usage plan.

Specified by:

createUsagePlanKey in interface AmazonApiGateway

Parameters:

createUsagePlanKeyRequest - The POST request to create a usage plan key for adding an existing API key to a usage plan.

Returns:

Result of the CreateUsagePlanKey operation returned by the service.

Throws:

BadRequestException

ConflictException

UnauthorizedException

NotFoundException

TooManyRequestsException

deleteApiKey

public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest deleteApiKeyRequest)

Deletes the ApiKey resource.

Specified by:

deleteApiKey in interface AmazonApiGateway

Parameters:

deleteApiKeyRequest - A request to delete the ApiKey resource.

Returns:

Result of the DeleteApiKey operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

deleteAuthorizer

public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)

Deletes an existing Authorizer resource.

AWS CLI

Specified by:

deleteAuthorizer in interface AmazonApiGateway

Parameters:

deleteAuthorizerRequest - Request to delete an existing Authorizer resource.

Returns:

Result of the DeleteAuthorizer operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

ConflictException

deleteBasePathMapping

public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest deleteBasePathMappingRequest)

Deletes the BasePathMapping resource.

Specified by:

deleteBasePathMapping in interface AmazonApiGateway

Parameters:

deleteBasePathMappingRequest - A request to delete the BasePathMapping resource.

Returns:

Result of the DeleteBasePathMapping operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

deleteClientCertificate

public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest deleteClientCertificateRequest)

Deletes the ClientCertificate resource.

Specified by:

deleteClientCertificate in interface AmazonApiGateway

Parameters:

deleteClientCertificateRequest - A request to delete the ClientCertificate resource.

Returns:

Result of the DeleteClientCertificate operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

deleteDeployment

public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Specified by:

deleteDeployment in interface AmazonApiGateway

Parameters:

deleteDeploymentRequest - Requests Amazon API Gateway to delete a Deployment resource.

Returns:

Result of the DeleteDeployment operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

deleteDomainName

public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)

Deletes the DomainName resource.

Specified by:

deleteDomainName in interface AmazonApiGateway

Parameters:

deleteDomainNameRequest - A request to delete the DomainName resource.

Returns:

Result of the DeleteDomainName operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

deleteIntegration

public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)

Represents a delete integration.

Specified by:

deleteIntegration in interface AmazonApiGateway

Parameters:

deleteIntegrationRequest - Represents a delete integration request.

Returns:

Result of the DeleteIntegration operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

ConflictException

deleteIntegrationResponse

public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)

Represents a delete integration response.

Specified by:

deleteIntegrationResponse in interface AmazonApiGateway

Parameters:

deleteIntegrationResponseRequest - Represents a delete integration response request.

Returns:

Result of the DeleteIntegrationResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

ConflictException

deleteMethod

public DeleteMethodResult deleteMethod(DeleteMethodRequest deleteMethodRequest)

Deletes an existing Method resource.

Specified by:

deleteMethod in interface AmazonApiGateway

Parameters:

deleteMethodRequest - Request to delete an existing Method resource.

Returns:

Result of the DeleteMethod operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

ConflictException

deleteMethodResponse

public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest deleteMethodResponseRequest)

Deletes an existing MethodResponse resource.

Specified by:

deleteMethodResponse in interface AmazonApiGateway

Parameters:

deleteMethodResponseRequest - A request to delete an existing MethodResponse resource.

Returns:

Result of the DeleteMethodResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

ConflictException

deleteModel

public DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)

Deletes a model.

Specified by:

deleteModel in interface AmazonApiGateway

Parameters:

deleteModelRequest - Request to delete an existing model in an existing RestApi resource.

Returns:

Result of the DeleteModel operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

ConflictException

deleteResource

public DeleteResourceResult deleteResource(DeleteResourceRequest deleteResourceRequest)

Deletes a Resource resource.

Specified by:

deleteResource in interface AmazonApiGateway

Parameters:

deleteResourceRequest - Request to delete a Resource.

Returns:

Result of the DeleteResource operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

ConflictException

TooManyRequestsException

deleteRestApi

public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest deleteRestApiRequest)

Deletes the specified API.

Specified by:

deleteRestApi in interface AmazonApiGateway

Parameters:

deleteRestApiRequest - Request to delete the specified API from your collection.

Returns:

Result of the DeleteRestApi operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

deleteStage

public DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)

Deletes a Stage resource.

Specified by:

deleteStage in interface AmazonApiGateway

Parameters:

deleteStageRequest - Requests Amazon API Gateway to delete a Stage resource.

Returns:

Result of the DeleteStage operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

BadRequestException

deleteUsagePlan

public DeleteUsagePlanResult deleteUsagePlan(DeleteUsagePlanRequest deleteUsagePlanRequest)

Deletes a usage plan of a given plan Id.

Specified by:

deleteUsagePlan in interface AmazonApiGateway

Parameters:

deleteUsagePlanRequest - The DELETE request to delete a uasge plan of a given plan Id.

Returns:

Result of the DeleteUsagePlan operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

deleteUsagePlanKey

public DeleteUsagePlanKeyResult deleteUsagePlanKey(DeleteUsagePlanKeyRequest deleteUsagePlanKeyRequest)

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Specified by:

deleteUsagePlanKey in interface AmazonApiGateway

Parameters:

deleteUsagePlanKeyRequest - The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

Returns:

Result of the DeleteUsagePlanKey operation returned by the service.

Throws:

BadRequestException

ConflictException

UnauthorizedException

NotFoundException

TooManyRequestsException

flushStageAuthorizersCache

public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest flushStageAuthorizersCacheRequest)

Flushes all authorizer cache entries on a stage.

Specified by:

flushStageAuthorizersCache in interface AmazonApiGateway

Parameters:

flushStageAuthorizersCacheRequest - Request to flush authorizer cache entries on a specified stage.

Returns:

Result of the FlushStageAuthorizersCache operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

flushStageCache

public FlushStageCacheResult flushStageCache(FlushStageCacheRequest flushStageCacheRequest)

Flushes a stage's cache.

Specified by:

flushStageCache in interface AmazonApiGateway

Parameters:

flushStageCacheRequest - Requests Amazon API Gateway to flush a stage's cache.

Returns:

Result of the FlushStageCache operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

generateClientCertificate

public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest generateClientCertificateRequest)

Generates a ClientCertificate resource.

Specified by:

generateClientCertificate in interface AmazonApiGateway

Parameters:

generateClientCertificateRequest - A request to generate a ClientCertificate resource.

Returns:

Result of the GenerateClientCertificate operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

LimitExceededException

getAccount

public GetAccountResult getAccount(GetAccountRequest getAccountRequest)

Gets information about the current Account resource.

Specified by:

getAccount in interface AmazonApiGateway

Parameters:

getAccountRequest - Requests Amazon API Gateway to get information about the current Account resource.

Returns:

Result of the GetAccount operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getApiKey

public GetApiKeyResult getApiKey(GetApiKeyRequest getApiKeyRequest)

Gets information about the current ApiKey resource.

Specified by:

getApiKey in interface AmazonApiGateway

Parameters:

getApiKeyRequest - A request to get information about the current ApiKey resource.

Returns:

Result of the GetApiKey operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getApiKeys

public GetApiKeysResult getApiKeys(GetApiKeysRequest getApiKeysRequest)

Gets information about the current ApiKeys resource.

Specified by:

getApiKeys in interface AmazonApiGateway

Parameters:

getApiKeysRequest - A request to get information about the current ApiKeys resource.

Returns:

Result of the GetApiKeys operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

getAuthorizer

public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)

Describe an existing Authorizer resource.

AWS CLI

Specified by:

getAuthorizer in interface AmazonApiGateway

Parameters:

getAuthorizerRequest - Request to describe an existing Authorizer resource.

Returns:

Result of the GetAuthorizer operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getAuthorizers

public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)

Describe an existing Authorizers resource.

AWS CLI

Specified by:

getAuthorizers in interface AmazonApiGateway

Parameters:

getAuthorizersRequest - Request to describe an existing Authorizers resource.

Returns:

Result of the GetAuthorizers operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getBasePathMapping

public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest getBasePathMappingRequest)

Describe a BasePathMapping resource.

Specified by:

getBasePathMapping in interface AmazonApiGateway

Parameters:

getBasePathMappingRequest - Request to describe a BasePathMapping resource.

Returns:

Result of the GetBasePathMapping operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getBasePathMappings

public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest getBasePathMappingsRequest)

Represents a collection of BasePathMapping resources.

Specified by:

getBasePathMappings in interface AmazonApiGateway

Parameters:

getBasePathMappingsRequest - A request to get information about a collection of BasePathMapping resources.

Returns:

Result of the GetBasePathMappings operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getClientCertificate

public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest getClientCertificateRequest)

Gets information about the current ClientCertificate resource.

Specified by:

getClientCertificate in interface AmazonApiGateway

Parameters:

getClientCertificateRequest - A request to get information about the current ClientCertificate resource.

Returns:

Result of the GetClientCertificate operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getClientCertificates

public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest getClientCertificatesRequest)

Gets a collection of ClientCertificate resources.

Specified by:

getClientCertificates in interface AmazonApiGateway

Parameters:

getClientCertificatesRequest - A request to get information about a collection of ClientCertificate resources.

Returns:

Result of the GetClientCertificates operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

getDeployment

public GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)

Gets information about a Deployment resource.

Specified by:

getDeployment in interface AmazonApiGateway

Parameters:

getDeploymentRequest - Requests Amazon API Gateway to get information about a Deployment resource.

Returns:

Result of the GetDeployment operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

ServiceUnavailableException

getDeployments

public GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)

Gets information about a Deployments collection.

Specified by:

getDeployments in interface AmazonApiGateway

Parameters:

getDeploymentsRequest - Requests Amazon API Gateway to get information about a Deployments collection.

Returns:

Result of the GetDeployments operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

ServiceUnavailableException

getDomainName

public GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Specified by:

getDomainName in interface AmazonApiGateway

Parameters:

getDomainNameRequest - Request to get the name of a DomainName resource.

Returns:

Result of the GetDomainName operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ServiceUnavailableException

TooManyRequestsException

getDomainNames

public GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)

Represents a collection of DomainName resources.

Specified by:

getDomainNames in interface AmazonApiGateway

Parameters:

getDomainNamesRequest - Request to describe a collection of DomainName resources.

Returns:

Result of the GetDomainNames operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

getExport

public GetExportResult getExport(GetExportRequest getExportRequest)

Exports a deployed version of a RestApi in a specified format.

Specified by:

getExport in interface AmazonApiGateway

Parameters:

getExportRequest - Request a new export of a RestApi for a particular Stage.

Returns:

Result of the GetExport operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

getIntegration

public GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)

Represents a get integration.

Specified by:

getIntegration in interface AmazonApiGateway

Parameters:

getIntegrationRequest - Represents a get integration request.

Returns:

Result of the GetIntegration operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getIntegrationResponse

public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)

Represents a get integration response.

Specified by:

getIntegrationResponse in interface AmazonApiGateway

Parameters:

getIntegrationResponseRequest - Represents a get integration response request.

Returns:

Result of the GetIntegrationResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getMethod

public GetMethodResult getMethod(GetMethodRequest getMethodRequest)

Describe an existing Method resource.

Specified by:

getMethod in interface AmazonApiGateway

Parameters:

getMethodRequest - Request to describe an existing Method resource.

Returns:

Result of the GetMethod operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getMethodResponse

public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest getMethodResponseRequest)

Describes a MethodResponse resource.

Specified by:

getMethodResponse in interface AmazonApiGateway

Parameters:

getMethodResponseRequest - Request to describe a MethodResponse resource.

Returns:

Result of the GetMethodResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getModel

public GetModelResult getModel(GetModelRequest getModelRequest)

Describes an existing model defined for a RestApi resource.

Specified by:

getModel in interface AmazonApiGateway

Parameters:

getModelRequest - Request to list information about a model in an existing RestApi resource.

Returns:

Result of the GetModel operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getModelTemplate

public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Specified by:

getModelTemplate in interface AmazonApiGateway

Parameters:

getModelTemplateRequest - Request to generate a sample mapping template used to transform the payload.

Returns:

Result of the GetModelTemplate operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

getModels

public GetModelsResult getModels(GetModelsRequest getModelsRequest)

Describes existing Models defined for a RestApi resource.

Specified by:

getModels in interface AmazonApiGateway

Parameters:

getModelsRequest - Request to list existing Models defined for a RestApi resource.

Returns:

Result of the GetModels operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getResource

public GetResourceResult getResource(GetResourceRequest getResourceRequest)

Lists information about a resource.

Specified by:

getResource in interface AmazonApiGateway

Parameters:

getResourceRequest - Request to list information about a resource.

Returns:

Result of the GetResource operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getResources

public GetResourcesResult getResources(GetResourcesRequest getResourcesRequest)

Lists information about a collection of Resource resources.

Specified by:

getResources in interface AmazonApiGateway

Parameters:

getResourcesRequest - Request to list information about a collection of resources.

Returns:

Result of the GetResources operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getRestApi

public GetRestApiResult getRestApi(GetRestApiRequest getRestApiRequest)

Lists the RestApi resource in the collection.

Specified by:

getRestApi in interface AmazonApiGateway

Parameters:

getRestApiRequest - The GET request to list an existing RestApi defined for your collection.

Returns:

Result of the GetRestApi operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getRestApis

public GetRestApisResult getRestApis(GetRestApisRequest getRestApisRequest)

Lists the RestApis resources for your collection.

Specified by:

getRestApis in interface AmazonApiGateway

Parameters:

getRestApisRequest - The GET request to list existing RestApis defined for your collection.

Returns:

Result of the GetRestApis operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

getSdk

public GetSdkResult getSdk(GetSdkRequest getSdkRequest)

Generates a client SDK for a RestApi and Stage.

Specified by:

getSdk in interface AmazonApiGateway

Parameters:

getSdkRequest - Request a new generated client SDK for a RestApi and Stage.

Returns:

Result of the GetSdk operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

getStage

public GetStageResult getStage(GetStageRequest getStageRequest)

Gets information about a Stage resource.

Specified by:

getStage in interface AmazonApiGateway

Parameters:

getStageRequest - Requests Amazon API Gateway to get information about a Stage resource.

Returns:

Result of the GetStage operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getStages

public GetStagesResult getStages(GetStagesRequest getStagesRequest)

Gets information about one or more Stage resources.

Specified by:

getStages in interface AmazonApiGateway

Parameters:

getStagesRequest - Requests Amazon API Gateway to get information about one or more Stage resources.

Returns:

Result of the GetStages operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

getUsage

public GetUsageResult getUsage(GetUsageRequest getUsageRequest)

Gets the usage data of a usage plan in a specified time interval.

Specified by:

getUsage in interface AmazonApiGateway

Parameters:

getUsageRequest - The GET request to get the usage data of a usage plan in a specified time interval.

Returns:

Result of the GetUsage operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getUsagePlan

public GetUsagePlanResult getUsagePlan(GetUsagePlanRequest getUsagePlanRequest)

Gets a usage plan of a given plan identifier.

Specified by:

getUsagePlan in interface AmazonApiGateway

Parameters:

getUsagePlanRequest - The GET request to get a usage plan of a given plan identifier.

Returns:

Result of the GetUsagePlan operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getUsagePlanKey

public GetUsagePlanKeyResult getUsagePlanKey(GetUsagePlanKeyRequest getUsagePlanKeyRequest)

Gets a usage plan key of a given key identifier.

Specified by:

getUsagePlanKey in interface AmazonApiGateway

Parameters:

getUsagePlanKeyRequest - The GET request to get a usage plan key of a given key identifier.

Returns:

Result of the GetUsagePlanKey operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getUsagePlanKeys

public GetUsagePlanKeysResult getUsagePlanKeys(GetUsagePlanKeysRequest getUsagePlanKeysRequest)

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Specified by:

getUsagePlanKeys in interface AmazonApiGateway

Parameters:

getUsagePlanKeysRequest - The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Returns:

Result of the GetUsagePlanKeys operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

getUsagePlans

public GetUsagePlansResult getUsagePlans(GetUsagePlansRequest getUsagePlansRequest)

Gets all the usage plans of the caller's account.

Specified by:

getUsagePlans in interface AmazonApiGateway

Parameters:

getUsagePlansRequest - The GET request to get all the usage plans of the caller's account.

Returns:

Result of the GetUsagePlans operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

TooManyRequestsException

ConflictException

importApiKeys

public ImportApiKeysResult importApiKeys(ImportApiKeysRequest importApiKeysRequest)

Import API keys from an external source, such as a CSV-formatted file.

Specified by:

importApiKeys in interface AmazonApiGateway

Parameters:

importApiKeysRequest - The POST request to import API keys from an external source, such as a CSV-formatted file.

Returns:

Result of the ImportApiKeys operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

TooManyRequestsException

LimitExceededException

BadRequestException

ConflictException

importRestApi

public ImportRestApiResult importRestApi(ImportRestApiRequest importRestApiRequest)

A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.

Specified by:

importRestApi in interface AmazonApiGateway

Parameters:

importRestApiRequest - A POST request to import an API to Amazon API Gateway using an input of an API definition file.

Returns:

Result of the ImportRestApi operation returned by the service.

Throws:

UnauthorizedException

LimitExceededException

BadRequestException

TooManyRequestsException

ConflictException

putIntegration

public PutIntegrationResult putIntegration(PutIntegrationRequest putIntegrationRequest)

Represents a put integration.

Specified by:

putIntegration in interface AmazonApiGateway

Parameters:

putIntegrationRequest - Represents a put integration request.

Returns:

Result of the PutIntegration operation returned by the service.

Throws:

UnauthorizedException

BadRequestException

ConflictException

NotFoundException

TooManyRequestsException

putIntegrationResponse

public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest putIntegrationResponseRequest)

Represents a put integration.

Specified by:

putIntegrationResponse in interface AmazonApiGateway

Parameters:

putIntegrationResponseRequest - Represents a put integration response request.

Returns:

Result of the PutIntegrationResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

LimitExceededException

BadRequestException

TooManyRequestsException

ConflictException

putMethod

public PutMethodResult putMethod(PutMethodRequest putMethodRequest)

Add a method to an existing Resource resource.

Specified by:

putMethod in interface AmazonApiGateway

Parameters:

putMethodRequest - Request to add a method to an existing Resource resource.

Returns:

Result of the PutMethod operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

ConflictException

LimitExceededException

TooManyRequestsException

putMethodResponse

public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest putMethodResponseRequest)

Adds a MethodResponse to an existing Method resource.

Specified by:

putMethodResponse in interface AmazonApiGateway

Parameters:

putMethodResponseRequest - Request to add a MethodResponse to an existing Method resource.

Returns:

Result of the PutMethodResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

LimitExceededException

BadRequestException

TooManyRequestsException

putRestApi

public 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.

Specified by:

putRestApi in interface AmazonApiGateway

Parameters:

putRestApiRequest - A PUT request to update an existing API, with external API definitions specified as the request body.

Returns:

Result of the PutRestApi operation returned by the service.

Throws:

UnauthorizedException

LimitExceededException

NotFoundException

BadRequestException

TooManyRequestsException

ConflictException

testInvokeAuthorizer

public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Enable custom authorizers

Specified by:

testInvokeAuthorizer in interface AmazonApiGateway

Parameters:

testInvokeAuthorizerRequest - Make a request to simulate the execution of an Authorizer.

Returns:

Result of the TestInvokeAuthorizer operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

testInvokeMethod

public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest testInvokeMethodRequest)

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

Specified by:

testInvokeMethod in interface AmazonApiGateway

Parameters:

testInvokeMethodRequest - Make a request to simulate the execution of a Method.

Returns:

Result of the TestInvokeMethod operation returned by the service.

Throws:

BadRequestException

UnauthorizedException

NotFoundException

TooManyRequestsException

updateAccount

public UpdateAccountResult updateAccount(UpdateAccountRequest updateAccountRequest)

Changes information about the current Account resource.

Specified by:

updateAccount in interface AmazonApiGateway

Parameters:

updateAccountRequest - Requests Amazon API Gateway to change information about the current Account resource.

Returns:

Result of the UpdateAccount operation returned by the service.

Throws:

UnauthorizedException

BadRequestException

NotFoundException

TooManyRequestsException

updateApiKey

public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest updateApiKeyRequest)

Changes information about an ApiKey resource.

Specified by:

updateApiKey in interface AmazonApiGateway

Parameters:

updateApiKeyRequest - A request to change information about an ApiKey resource.

Returns:

Result of the UpdateApiKey operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

ConflictException

updateAuthorizer

public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)

Updates an existing Authorizer resource.

AWS CLI

Specified by:

updateAuthorizer in interface AmazonApiGateway

Parameters:

updateAuthorizerRequest - Request to update an existing Authorizer resource.

Returns:

Result of the UpdateAuthorizer operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

updateBasePathMapping

public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest updateBasePathMappingRequest)

Changes information about the BasePathMapping resource.

Specified by:

updateBasePathMapping in interface AmazonApiGateway

Parameters:

updateBasePathMappingRequest - A request to change information about the BasePathMapping resource.

Returns:

Result of the UpdateBasePathMapping operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

BadRequestException

TooManyRequestsException

updateClientCertificate

public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest updateClientCertificateRequest)

Changes information about an ClientCertificate resource.

Specified by:

updateClientCertificate in interface AmazonApiGateway

Parameters:

updateClientCertificateRequest - A request to change information about an ClientCertificate resource.

Returns:

Result of the UpdateClientCertificate operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

updateDeployment

public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)

Changes information about a Deployment resource.

Specified by:

updateDeployment in interface AmazonApiGateway

Parameters:

updateDeploymentRequest - Requests Amazon API Gateway to change information about a Deployment resource.

Returns:

Result of the UpdateDeployment operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

ServiceUnavailableException

updateDomainName

public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)

Changes information about the DomainName resource.

Specified by:

updateDomainName in interface AmazonApiGateway

Parameters:

updateDomainNameRequest - A request to change information about the DomainName resource.

Returns:

Result of the UpdateDomainName operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

ConflictException

TooManyRequestsException

updateIntegration

public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)

Represents an update integration.

Specified by:

updateIntegration in interface AmazonApiGateway

Parameters:

updateIntegrationRequest - Represents an update integration request.

Returns:

Result of the UpdateIntegration operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

TooManyRequestsException

ConflictException

updateIntegrationResponse

public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)

Represents an update integration response.

Specified by:

updateIntegrationResponse in interface AmazonApiGateway

Parameters:

updateIntegrationResponseRequest - Represents an update integration response request.

Returns:

Result of the UpdateIntegrationResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

BadRequestException

TooManyRequestsException

updateMethod

public UpdateMethodResult updateMethod(UpdateMethodRequest updateMethodRequest)

Updates an existing Method resource.

Specified by:

updateMethod in interface AmazonApiGateway

Parameters:

updateMethodRequest - Request to update an existing Method resource.

Returns:

Result of the UpdateMethod operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

ConflictException

TooManyRequestsException

updateMethodResponse

public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest updateMethodResponseRequest)

Updates an existing MethodResponse resource.

Specified by:

updateMethodResponse in interface AmazonApiGateway

Parameters:

updateMethodResponseRequest - A request to update an existing MethodResponse resource.

Returns:

Result of the UpdateMethodResponse operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

LimitExceededException

BadRequestException

TooManyRequestsException

updateModel

public UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)

Changes information about a model.

Specified by:

updateModel in interface AmazonApiGateway

Parameters:

updateModelRequest - Request to update an existing model in an existing RestApi resource.

Returns:

Result of the UpdateModel operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

BadRequestException

ConflictException

TooManyRequestsException

updateResource

public UpdateResourceResult updateResource(UpdateResourceRequest updateResourceRequest)

Changes information about a Resource resource.

Specified by:

updateResource in interface AmazonApiGateway

Parameters:

updateResourceRequest - Request to change information about a Resource resource.

Returns:

Result of the UpdateResource operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

BadRequestException

TooManyRequestsException

updateRestApi

public UpdateRestApiResult updateRestApi(UpdateRestApiRequest updateRestApiRequest)

Changes information about the specified API.

Specified by:

updateRestApi in interface AmazonApiGateway

Parameters:

updateRestApiRequest - Request to update an existing RestApi resource in your collection.

Returns:

Result of the UpdateRestApi operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

BadRequestException

TooManyRequestsException

updateStage

public UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)

Changes information about a Stage resource.

Specified by:

updateStage in interface AmazonApiGateway

Parameters:

updateStageRequest - Requests Amazon API Gateway to change information about a Stage resource.

Returns:

Result of the UpdateStage operation returned by the service.

Throws:

UnauthorizedException

NotFoundException

ConflictException

BadRequestException

TooManyRequestsException

updateUsage

public UpdateUsageResult updateUsage(UpdateUsageRequest updateUsageRequest)

Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.

Specified by:

updateUsage in interface AmazonApiGateway

Parameters:

updateUsageRequest - The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified API key.

Returns:

Result of the UpdateUsage operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

updateUsagePlan

public UpdateUsagePlanResult updateUsagePlan(UpdateUsagePlanRequest updateUsagePlanRequest)

Updates a usage plan of a given plan Id.

Specified by:

updateUsagePlan in interface AmazonApiGateway

Parameters:

updateUsagePlanRequest - The PATCH request to update a usage plan of a given plan Id.

Returns:

Result of the UpdateUsagePlan operation returned by the service.

Throws:

UnauthorizedException

TooManyRequestsException

BadRequestException

NotFoundException

ConflictException

getCachedResponseMetadata

public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonApiGateway

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.