public class AbstractAmazonApiGateway extends Object implements AmazonApiGateway
AmazonApiGateway. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.public void setEndpoint(String endpoint)
AmazonApiGateway
Callers can pass in just the endpoint (ex:
"apigateway.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://apigateway.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonApiGatewayendpoint - The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex:
"https://apigateway.us-east-1.amazonaws.com") of the region
specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonApiGatewayAmazonApiGateway.setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonApiGatewayregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
createApiKey in interface AmazonApiGatewaypublic CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
AmazonApiGatewayCreates a new BasePathMapping resource.
createBasePathMapping in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to create a new BasePathMapping
resource.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AmazonApiGatewayCreates a Deployment resource, which makes a specified RestApi callable over the internet.
createDeployment in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to create a Deployment
resource.public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
AmazonApiGatewayCreates a new domain name.
createDomainName in interface AmazonApiGatewayrequest - A request to create a new domain name.public CreateModelResult createModel(CreateModelRequest request)
AmazonApiGatewaycreateModel in interface AmazonApiGatewayrequest - Request to add a new Model to an existing RestApi
resource.public CreateResourceResult createResource(CreateResourceRequest request)
AmazonApiGatewayCreates a Resource resource.
createResource in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to create a Resource resource.public CreateRestApiResult createRestApi(CreateRestApiRequest request)
AmazonApiGatewayCreates a new RestApi resource.
createRestApi in interface AmazonApiGatewayrequest - Request to add a new RestApi resource to your collection.public CreateStageResult createStage(CreateStageRequest request)
AmazonApiGatewayCreates a Stage resource.
createStage in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to create a Stage resource.public void deleteApiKey(DeleteApiKeyRequest request)
AmazonApiGatewayDeletes the ApiKey resource.
deleteApiKey in interface AmazonApiGatewayrequest - A request to delete the ApiKey resource.public void deleteBasePathMapping(DeleteBasePathMappingRequest request)
AmazonApiGatewayDeletes the BasePathMapping resource.
deleteBasePathMapping in interface AmazonApiGatewayrequest - A request to delete the BasePathMapping resource.public void deleteClientCertificate(DeleteClientCertificateRequest request)
deleteClientCertificate in interface AmazonApiGatewaypublic void deleteDeployment(DeleteDeploymentRequest request)
AmazonApiGatewayDeletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
deleteDeployment in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to delete a Deployment
resource.public void deleteDomainName(DeleteDomainNameRequest request)
AmazonApiGatewayDeletes the DomainName resource.
deleteDomainName in interface AmazonApiGatewayrequest - A request to delete the DomainName resource.public void deleteIntegration(DeleteIntegrationRequest request)
AmazonApiGatewayRepresents a delete integration.
deleteIntegration in interface AmazonApiGatewayrequest - Represents a delete integration request.public void deleteIntegrationResponse(DeleteIntegrationResponseRequest request)
AmazonApiGatewayRepresents a delete integration response.
deleteIntegrationResponse in interface AmazonApiGatewayrequest - Represents a delete integration response request.public void deleteMethod(DeleteMethodRequest request)
AmazonApiGatewayDeletes an existing Method resource.
deleteMethod in interface AmazonApiGatewayrequest - Request to delete an existing Method resource.public void deleteMethodResponse(DeleteMethodResponseRequest request)
AmazonApiGatewayDeletes an existing MethodResponse resource.
deleteMethodResponse in interface AmazonApiGatewayrequest - A request to delete an existing MethodResponse resource.public void deleteModel(DeleteModelRequest request)
AmazonApiGatewayDeletes a model.
deleteModel in interface AmazonApiGatewayrequest - Request to delete an existing model in an existing RestApi
resource.public void deleteResource(DeleteResourceRequest request)
AmazonApiGatewayDeletes a Resource resource.
deleteResource in interface AmazonApiGatewayrequest - Request to delete a Resource.public void deleteRestApi(DeleteRestApiRequest request)
AmazonApiGatewayDeletes the specified API.
deleteRestApi in interface AmazonApiGatewayrequest - Request to delete the specified API from your collection.public void deleteStage(DeleteStageRequest request)
AmazonApiGatewayDeletes a Stage resource.
deleteStage in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to delete a Stage resource.public void flushStageCache(FlushStageCacheRequest request)
AmazonApiGatewayFlushes a stage's cache.
flushStageCache in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to flush a stage's cache.public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request)
generateClientCertificate in interface AmazonApiGatewaypublic GetAccountResult getAccount(GetAccountRequest request)
AmazonApiGatewayGets information about the current Account resource.
getAccount in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to get information about the current
Account resource.public GetApiKeyResult getApiKey(GetApiKeyRequest request)
AmazonApiGatewayGets information about the current ApiKey resource.
getApiKey in interface AmazonApiGatewayrequest - A request to get information about the current ApiKey
resource.public GetApiKeysResult getApiKeys(GetApiKeysRequest request)
AmazonApiGatewayGets information about the current ApiKeys resource.
getApiKeys in interface AmazonApiGatewayrequest - A request to get information about the current ApiKeys
resource.public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
AmazonApiGatewayDescribe a BasePathMapping resource.
getBasePathMapping in interface AmazonApiGatewayrequest - Request to describe a BasePathMapping resource.public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)
AmazonApiGatewayRepresents a collection of BasePathMapping resources.
getBasePathMappings in interface AmazonApiGatewayrequest - A request to get information about a collection of
BasePathMapping resources.public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest request)
getClientCertificate in interface AmazonApiGatewaypublic GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)
getClientCertificates in interface AmazonApiGatewaypublic GetDeploymentResult getDeployment(GetDeploymentRequest request)
AmazonApiGatewayGets information about a Deployment resource.
getDeployment in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to get information about a
Deployment resource.public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
AmazonApiGatewayGets information about a Deployments collection.
getDeployments in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to get information about a
Deployments collection.public GetDomainNameResult getDomainName(GetDomainNameRequest request)
AmazonApiGatewayRepresents a domain name that is contained in a simpler, more intuitive URL that can be called.
getDomainName in interface AmazonApiGatewayrequest - Request to get the name of a DomainName resource.public GetDomainNamesResult getDomainNames(GetDomainNamesRequest request)
AmazonApiGatewayRepresents a collection of DomainName resources.
getDomainNames in interface AmazonApiGatewayrequest - Request to describe a collection of DomainName resources.public GetIntegrationResult getIntegration(GetIntegrationRequest request)
AmazonApiGatewayRepresents a get integration.
getIntegration in interface AmazonApiGatewayrequest - Represents a get integration request.public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
AmazonApiGatewayRepresents a get integration response.
getIntegrationResponse in interface AmazonApiGatewayrequest - Represents a get integration response request.public GetMethodResult getMethod(GetMethodRequest request)
AmazonApiGatewayDescribe an existing Method resource.
getMethod in interface AmazonApiGatewayrequest - Request to describe an existing Method resource.public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
AmazonApiGatewayDescribes a MethodResponse resource.
getMethodResponse in interface AmazonApiGatewayrequest - Request to describe a MethodResponse resource.public GetModelResult getModel(GetModelRequest request)
AmazonApiGatewayDescribes an existing model defined for a RestApi resource.
getModel in interface AmazonApiGatewayrequest - Request to list information about a model in an existing
RestApi resource.public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest request)
AmazonApiGatewayGenerates a sample mapping template that can be used to transform a payload into the structure of a model.
getModelTemplate in interface AmazonApiGatewayrequest - Request to generate a sample mapping template used to transform
the payload.public GetModelsResult getModels(GetModelsRequest request)
AmazonApiGatewaygetModels in interface AmazonApiGatewayrequest - Request to list existing Models defined for a
RestApi resource.public GetResourceResult getResource(GetResourceRequest request)
AmazonApiGatewayLists information about a resource.
getResource in interface AmazonApiGatewayrequest - Request to list information about a resource.public GetResourcesResult getResources(GetResourcesRequest request)
AmazonApiGatewayLists information about a collection of Resource resources.
getResources in interface AmazonApiGatewayrequest - Request to list information about a collection of resources.public GetRestApiResult getRestApi(GetRestApiRequest request)
AmazonApiGatewayLists the RestApi resource in the collection.
getRestApi in interface AmazonApiGatewayrequest - Request to list an existing RestApi defined for your
collection.public GetRestApisResult getRestApis(GetRestApisRequest request)
AmazonApiGatewayLists the RestApis resources for your collection.
getRestApis in interface AmazonApiGatewayrequest - Request to list existing RestApis defined for your
collection.public GetSdkResult getSdk(GetSdkRequest request)
getSdk in interface AmazonApiGatewaypublic GetStageResult getStage(GetStageRequest request)
AmazonApiGatewayGets information about a Stage resource.
getStage in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to get information about a
Stage resource.public GetStagesResult getStages(GetStagesRequest request)
AmazonApiGatewayGets information about one or more Stage resources.
getStages in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to get information about one or more
Stage resources.public PutIntegrationResult putIntegration(PutIntegrationRequest request)
AmazonApiGatewayRepresents a put integration.
putIntegration in interface AmazonApiGatewayrequest - Represents a put integration request.public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
AmazonApiGatewayRepresents a put integration.
putIntegrationResponse in interface AmazonApiGatewayrequest - Represents a put integration response request.public PutMethodResult putMethod(PutMethodRequest request)
AmazonApiGatewayAdd a method to an existing Resource resource.
putMethod in interface AmazonApiGatewayrequest - Request to add a method to an existing Resource resource.public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest request)
AmazonApiGatewayAdds a MethodResponse to an existing Method resource.
putMethodResponse in interface AmazonApiGatewayrequest - Request to add a MethodResponse to an existing
Method resource.public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
testInvokeMethod in interface AmazonApiGatewaypublic UpdateAccountResult updateAccount(UpdateAccountRequest request)
AmazonApiGatewayChanges information about the current Account resource.
updateAccount in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to change information about the
current Account resource.public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
AmazonApiGatewayChanges information about an ApiKey resource.
updateApiKey in interface AmazonApiGatewayrequest - A request to change information about an ApiKey resource.public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
AmazonApiGatewayChanges information about the BasePathMapping resource.
updateBasePathMapping in interface AmazonApiGatewayrequest - A request to change information about the BasePathMapping
resource.public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request)
updateClientCertificate in interface AmazonApiGatewaypublic UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
AmazonApiGatewayChanges information about a Deployment resource.
updateDeployment in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to change information about a
Deployment resource.public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
AmazonApiGatewayChanges information about the DomainName resource.
updateDomainName in interface AmazonApiGatewayrequest - A request to change information about the DomainName
resource.public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
AmazonApiGatewayRepresents an update integration.
updateIntegration in interface AmazonApiGatewayrequest - Represents an update integration request.public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request)
AmazonApiGatewayRepresents an update integration response.
updateIntegrationResponse in interface AmazonApiGatewayrequest - Represents an update integration response request.public UpdateMethodResult updateMethod(UpdateMethodRequest request)
AmazonApiGatewayUpdates an existing Method resource.
updateMethod in interface AmazonApiGatewayrequest - Request to update an existing Method resource.public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
AmazonApiGatewayUpdates an existing MethodResponse resource.
updateMethodResponse in interface AmazonApiGatewayrequest - A request to update an existing MethodResponse resource.public UpdateModelResult updateModel(UpdateModelRequest request)
AmazonApiGatewayChanges information about a model.
updateModel in interface AmazonApiGatewayrequest - Request to update an existing model in an existing RestApi
resource.public UpdateResourceResult updateResource(UpdateResourceRequest request)
AmazonApiGatewayChanges information about a Resource resource.
updateResource in interface AmazonApiGatewayrequest - Request to change information about a Resource resource.public UpdateRestApiResult updateRestApi(UpdateRestApiRequest request)
AmazonApiGatewayChanges information about the specified API.
updateRestApi in interface AmazonApiGatewayrequest - Request to update an existing RestApi resource in your
collection.public UpdateStageResult updateStage(UpdateStageRequest request)
AmazonApiGatewayChanges information about a Stage resource.
updateStage in interface AmazonApiGatewayrequest - Requests Amazon API Gateway to change information about a
Stage resource.public void shutdown()
AmazonApiGatewayshutdown in interface AmazonApiGatewaypublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonApiGatewayResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonApiGatewayrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.