Class AbstractAmazonApiGateway
- All Implemented Interfaces:
AmazonApiGateway
- Direct Known Subclasses:
AbstractAmazonApiGatewayAsync
AmazonApiGateway
. Convenient method forms
pass through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateApiKey
(CreateApiKeyRequest request) Create an ApiKey resource.createAuthorizer
(CreateAuthorizerRequest request) Adds a new Authorizer resource to an existing RestApi resource.Creates a new BasePathMapping resource.createDeployment
(CreateDeploymentRequest request) Creates a Deployment resource, which makes a specified RestApi callable over the internet.createDomainName
(CreateDomainNameRequest request) Creates a new domain name.createModel
(CreateModelRequest request) createResource
(CreateResourceRequest request) Creates a Resource resource.createRestApi
(CreateRestApiRequest request) Creates a new RestApi resource.createStage
(CreateStageRequest request) Creates a new Stage resource that references a pre-existing Deployment for the API.deleteApiKey
(DeleteApiKeyRequest request) Deletes the ApiKey resource.deleteAuthorizer
(DeleteAuthorizerRequest request) Deletes an existing Authorizer resource.Deletes the BasePathMapping resource.Deletes the ClientCertificate resource.deleteDeployment
(DeleteDeploymentRequest request) Deletes a Deployment resource.deleteDomainName
(DeleteDomainNameRequest request) Deletes the DomainName resource.Represents a delete integration.Represents a delete integration response.deleteMethod
(DeleteMethodRequest request) Deletes an existing Method resource.Deletes an existing MethodResponse resource.deleteModel
(DeleteModelRequest request) Deletes a model.deleteResource
(DeleteResourceRequest request) Deletes a Resource resource.deleteRestApi
(DeleteRestApiRequest request) Deletes the specified API.deleteStage
(DeleteStageRequest request) Deletes a Stage resource.Flushes all authorizer cache entries on a stage.flushStageCache
(FlushStageCacheRequest request) Flushes a stage's cache.Generates a ClientCertificate resource.getAccount
(GetAccountRequest request) Gets information about the current Account resource.getApiKey
(GetApiKeyRequest request) Gets information about the current ApiKey resource.getApiKeys
(GetApiKeysRequest request) Gets information about the current ApiKeys resource.getAuthorizer
(GetAuthorizerRequest request) Describe an existing Authorizer resource.getAuthorizers
(GetAuthorizersRequest request) Describe an existing Authorizers resource.Describe a BasePathMapping resource.Represents a collection of BasePathMapping resources.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Gets information about the current ClientCertificate resource.Gets a collection of ClientCertificate resources.getDeployment
(GetDeploymentRequest request) Gets information about a Deployment resource.getDeployments
(GetDeploymentsRequest request) Gets information about a Deployments collection.getDomainName
(GetDomainNameRequest request) Represents a domain name that is contained in a simpler, more intuitive URL that can be called.getDomainNames
(GetDomainNamesRequest request) Represents a collection of DomainName resources.getExport
(GetExportRequest request) Exports a deployed version of a RestApi in a specified format.getIntegration
(GetIntegrationRequest request) Represents a get integration.Represents a get integration response.getMethod
(GetMethodRequest request) Describe an existing Method resource.Describes a MethodResponse resource.getModel
(GetModelRequest request) Describes an existing model defined for a RestApi resource.getModels
(GetModelsRequest request) getModelTemplate
(GetModelTemplateRequest request) Generates a sample mapping template that can be used to transform a payload into the structure of a model.getResource
(GetResourceRequest request) Lists information about a resource.getResources
(GetResourcesRequest request) Lists information about a collection of Resource resources.getRestApi
(GetRestApiRequest request) Lists the RestApi resource in the collection.getRestApis
(GetRestApisRequest request) Lists the RestApis resources for your collection.getSdk
(GetSdkRequest request) getStage
(GetStageRequest request) Gets information about a Stage resource.getStages
(GetStagesRequest request) Gets information about one or more Stage resources.importRestApi
(ImportRestApiRequest request) A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.putIntegration
(PutIntegrationRequest request) Represents a put integration.Represents a put integration.putMethod
(PutMethodRequest request) Add a method to an existing Resource resource.Adds a MethodResponse to an existing Method resource.putRestApi
(PutRestApiRequest request) A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com").void
An alternative toAmazonApiGateway.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.testInvokeMethod
(TestInvokeMethodRequest request) updateAccount
(UpdateAccountRequest request) Changes information about the current Account resource.updateApiKey
(UpdateApiKeyRequest request) Changes information about an ApiKey resource.updateAuthorizer
(UpdateAuthorizerRequest request) Updates an existing Authorizer resource.Changes information about the BasePathMapping resource.Changes information about an ClientCertificate resource.updateDeployment
(UpdateDeploymentRequest request) Changes information about a Deployment resource.updateDomainName
(UpdateDomainNameRequest request) Changes information about the DomainName resource.Represents an update integration.Represents an update integration response.updateMethod
(UpdateMethodRequest request) Updates an existing Method resource.Updates an existing MethodResponse resource.updateModel
(UpdateModelRequest request) Changes information about a model.updateResource
(UpdateResourceRequest request) Changes information about a Resource resource.updateRestApi
(UpdateRestApiRequest request) Changes information about the specified API.updateStage
(UpdateStageRequest request) Changes information about a Stage resource.
-
Constructor Details
-
AbstractAmazonApiGateway
protected AbstractAmazonApiGateway()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonApiGateway
Overrides the default endpoint for this client ("https://apigateway.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.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.
- Specified by:
setEndpoint
in interfaceAmazonApiGateway
- Parameters:
endpoint
- The endpoint (ex: "apigateway.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://apigateway.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AmazonApiGateway
An alternative toAmazonApiGateway.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.
- Specified by:
setRegion
in interfaceAmazonApiGateway
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
createApiKey
Description copied from interface:AmazonApiGateway
Create an ApiKey resource.
- Specified by:
createApiKey
in interfaceAmazonApiGateway
- Parameters:
request
- Request to create an ApiKey resource.- Returns:
- Result of the CreateApiKey operation returned by the service.
-
createAuthorizer
Description copied from interface:AmazonApiGateway
Adds a new Authorizer resource to an existing RestApi resource.
- Specified by:
createAuthorizer
in interfaceAmazonApiGateway
- Parameters:
request
- Request to add a new Authorizer to an existing RestApi resource.- Returns:
- Result of the CreateAuthorizer operation returned by the service.
-
createBasePathMapping
Description copied from interface:AmazonApiGateway
Creates a new BasePathMapping resource.
- Specified by:
createBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to create a new BasePathMapping resource.- Returns:
- Result of the CreateBasePathMapping operation returned by the service.
-
createDeployment
Description copied from interface:AmazonApiGateway
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
- Specified by:
createDeployment
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to create a Deployment resource.- Returns:
- Result of the CreateDeployment operation returned by the service.
-
createDomainName
Description copied from interface:AmazonApiGateway
Creates a new domain name.
- Specified by:
createDomainName
in interfaceAmazonApiGateway
- Parameters:
request
- A request to create a new domain name.- Returns:
- Result of the CreateDomainName operation returned by the service.
-
createModel
Description copied from interface:AmazonApiGateway
- Specified by:
createModel
in interfaceAmazonApiGateway
- Parameters:
request
- Request to add a new Model to an existing RestApi resource.- Returns:
- Result of the CreateModel operation returned by the service.
-
createResource
Description copied from interface:AmazonApiGateway
Creates a Resource resource.
- Specified by:
createResource
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to create a Resource resource.- Returns:
- Result of the CreateResource operation returned by the service.
-
createRestApi
Description copied from interface:AmazonApiGateway
Creates a new RestApi resource.
- Specified by:
createRestApi
in interfaceAmazonApiGateway
- Parameters:
request
- The POST Request to add a new RestApi resource to your collection.- Returns:
- Result of the CreateRestApi operation returned by the service.
-
createStage
Description copied from interface:AmazonApiGateway
Creates a new Stage resource that references a pre-existing Deployment for the API.
- Specified by:
createStage
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to create a Stage resource.- Returns:
- Result of the CreateStage operation returned by the service.
-
deleteApiKey
Description copied from interface:AmazonApiGateway
Deletes the ApiKey resource.
- Specified by:
deleteApiKey
in interfaceAmazonApiGateway
- Parameters:
request
- A request to delete the ApiKey resource.- Returns:
- Result of the DeleteApiKey operation returned by the service.
-
deleteAuthorizer
Description copied from interface:AmazonApiGateway
Deletes an existing Authorizer resource.
- Specified by:
deleteAuthorizer
in interfaceAmazonApiGateway
- Parameters:
request
- Request to delete an existing Authorizer resource.- Returns:
- Result of the DeleteAuthorizer operation returned by the service.
-
deleteBasePathMapping
Description copied from interface:AmazonApiGateway
Deletes the BasePathMapping resource.
- Specified by:
deleteBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
request
- A request to delete the BasePathMapping resource.- Returns:
- Result of the DeleteBasePathMapping operation returned by the service.
-
deleteClientCertificate
public DeleteClientCertificateResult deleteClientCertificate(DeleteClientCertificateRequest request) Description copied from interface:AmazonApiGateway
Deletes the ClientCertificate resource.
- Specified by:
deleteClientCertificate
in interfaceAmazonApiGateway
- Parameters:
request
- A request to delete the ClientCertificate resource.- Returns:
- Result of the DeleteClientCertificate operation returned by the service.
-
deleteDeployment
Description copied from interface:AmazonApiGateway
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
- Specified by:
deleteDeployment
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to delete a Deployment resource.- Returns:
- Result of the DeleteDeployment operation returned by the service.
-
deleteDomainName
Description copied from interface:AmazonApiGateway
Deletes the DomainName resource.
- Specified by:
deleteDomainName
in interfaceAmazonApiGateway
- Parameters:
request
- A request to delete the DomainName resource.- Returns:
- Result of the DeleteDomainName operation returned by the service.
-
deleteIntegration
Description copied from interface:AmazonApiGateway
Represents a delete integration.
- Specified by:
deleteIntegration
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a delete integration request.- Returns:
- Result of the DeleteIntegration operation returned by the service.
-
deleteIntegrationResponse
public DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest request) Description copied from interface:AmazonApiGateway
Represents a delete integration response.
- Specified by:
deleteIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a delete integration response request.- Returns:
- Result of the DeleteIntegrationResponse operation returned by the service.
-
deleteMethod
Description copied from interface:AmazonApiGateway
Deletes an existing Method resource.
- Specified by:
deleteMethod
in interfaceAmazonApiGateway
- Parameters:
request
- Request to delete an existing Method resource.- Returns:
- Result of the DeleteMethod operation returned by the service.
-
deleteMethodResponse
Description copied from interface:AmazonApiGateway
Deletes an existing MethodResponse resource.
- Specified by:
deleteMethodResponse
in interfaceAmazonApiGateway
- Parameters:
request
- A request to delete an existing MethodResponse resource.- Returns:
- Result of the DeleteMethodResponse operation returned by the service.
-
deleteModel
Description copied from interface:AmazonApiGateway
Deletes a model.
- Specified by:
deleteModel
in interfaceAmazonApiGateway
- Parameters:
request
- Request to delete an existing model in an existing RestApi resource.- Returns:
- Result of the DeleteModel operation returned by the service.
-
deleteResource
Description copied from interface:AmazonApiGateway
Deletes a Resource resource.
- Specified by:
deleteResource
in interfaceAmazonApiGateway
- Parameters:
request
- Request to delete a Resource.- Returns:
- Result of the DeleteResource operation returned by the service.
-
deleteRestApi
Description copied from interface:AmazonApiGateway
Deletes the specified API.
- Specified by:
deleteRestApi
in interfaceAmazonApiGateway
- Parameters:
request
- Request to delete the specified API from your collection.- Returns:
- Result of the DeleteRestApi operation returned by the service.
-
deleteStage
Description copied from interface:AmazonApiGateway
Deletes a Stage resource.
- Specified by:
deleteStage
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to delete a Stage resource.- Returns:
- Result of the DeleteStage operation returned by the service.
-
flushStageAuthorizersCache
public FlushStageAuthorizersCacheResult flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request) Description copied from interface:AmazonApiGateway
Flushes all authorizer cache entries on a stage.
- Specified by:
flushStageAuthorizersCache
in interfaceAmazonApiGateway
- Parameters:
request
- Request to flush authorizer cache entries on a specified stage.- Returns:
- Result of the FlushStageAuthorizersCache operation returned by the service.
-
flushStageCache
Description copied from interface:AmazonApiGateway
Flushes a stage's cache.
- Specified by:
flushStageCache
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to flush a stage's cache.- Returns:
- Result of the FlushStageCache operation returned by the service.
-
generateClientCertificate
public GenerateClientCertificateResult generateClientCertificate(GenerateClientCertificateRequest request) Description copied from interface:AmazonApiGateway
Generates a ClientCertificate resource.
- Specified by:
generateClientCertificate
in interfaceAmazonApiGateway
- Parameters:
request
- A request to generate a ClientCertificate resource.- Returns:
- Result of the GenerateClientCertificate operation returned by the service.
-
getAccount
Description copied from interface:AmazonApiGateway
Gets information about the current Account resource.
- Specified by:
getAccount
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to get information about the current Account resource.- Returns:
- Result of the GetAccount operation returned by the service.
-
getApiKey
Description copied from interface:AmazonApiGateway
Gets information about the current ApiKey resource.
- Specified by:
getApiKey
in interfaceAmazonApiGateway
- Parameters:
request
- A request to get information about the current ApiKey resource.- Returns:
- Result of the GetApiKey operation returned by the service.
-
getApiKeys
Description copied from interface:AmazonApiGateway
Gets information about the current ApiKeys resource.
- Specified by:
getApiKeys
in interfaceAmazonApiGateway
- Parameters:
request
- A request to get information about the current ApiKeys resource.- Returns:
- Result of the GetApiKeys operation returned by the service.
-
getAuthorizer
Description copied from interface:AmazonApiGateway
Describe an existing Authorizer resource.
- Specified by:
getAuthorizer
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe an existing Authorizer resource.- Returns:
- Result of the GetAuthorizer operation returned by the service.
-
getAuthorizers
Description copied from interface:AmazonApiGateway
Describe an existing Authorizers resource.
- Specified by:
getAuthorizers
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe an existing Authorizers resource.- Returns:
- Result of the GetAuthorizers operation returned by the service.
-
getBasePathMapping
Description copied from interface:AmazonApiGateway
Describe a BasePathMapping resource.
- Specified by:
getBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe a BasePathMapping resource.- Returns:
- Result of the GetBasePathMapping operation returned by the service.
-
getBasePathMappings
Description copied from interface:AmazonApiGateway
Represents a collection of BasePathMapping resources.
- Specified by:
getBasePathMappings
in interfaceAmazonApiGateway
- Parameters:
request
- A request to get information about a collection of BasePathMapping resources.- Returns:
- Result of the GetBasePathMappings operation returned by the service.
-
getClientCertificate
Description copied from interface:AmazonApiGateway
Gets information about the current ClientCertificate resource.
- Specified by:
getClientCertificate
in interfaceAmazonApiGateway
- Parameters:
request
- A request to get information about the current ClientCertificate resource.- Returns:
- Result of the GetClientCertificate operation returned by the service.
-
getClientCertificates
Description copied from interface:AmazonApiGateway
Gets a collection of ClientCertificate resources.
- Specified by:
getClientCertificates
in interfaceAmazonApiGateway
- Parameters:
request
- A request to get information about a collection of ClientCertificate resources.- Returns:
- Result of the GetClientCertificates operation returned by the service.
-
getDeployment
Description copied from interface:AmazonApiGateway
Gets information about a Deployment resource.
- Specified by:
getDeployment
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to get information about a Deployment resource.- Returns:
- Result of the GetDeployment operation returned by the service.
-
getDeployments
Description copied from interface:AmazonApiGateway
Gets information about a Deployments collection.
- Specified by:
getDeployments
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to get information about a Deployments collection.- Returns:
- Result of the GetDeployments operation returned by the service.
-
getDomainName
Description copied from interface:AmazonApiGateway
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
- Specified by:
getDomainName
in interfaceAmazonApiGateway
- Parameters:
request
- Request to get the name of a DomainName resource.- Returns:
- Result of the GetDomainName operation returned by the service.
-
getDomainNames
Description copied from interface:AmazonApiGateway
Represents a collection of DomainName resources.
- Specified by:
getDomainNames
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe a collection of DomainName resources.- Returns:
- Result of the GetDomainNames operation returned by the service.
-
getExport
Description copied from interface:AmazonApiGateway
Exports a deployed version of a RestApi in a specified format.
- Specified by:
getExport
in interfaceAmazonApiGateway
- Parameters:
request
- Request a new export of a RestApi for a particular Stage.- Returns:
- Result of the GetExport operation returned by the service.
-
getIntegration
Description copied from interface:AmazonApiGateway
Represents a get integration.
- Specified by:
getIntegration
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a get integration request.- Returns:
- Result of the GetIntegration operation returned by the service.
-
getIntegrationResponse
Description copied from interface:AmazonApiGateway
Represents a get integration response.
- Specified by:
getIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a get integration response request.- Returns:
- Result of the GetIntegrationResponse operation returned by the service.
-
getMethod
Description copied from interface:AmazonApiGateway
Describe an existing Method resource.
- Specified by:
getMethod
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe an existing Method resource.- Returns:
- Result of the GetMethod operation returned by the service.
-
getMethodResponse
Description copied from interface:AmazonApiGateway
Describes a MethodResponse resource.
- Specified by:
getMethodResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Request to describe a MethodResponse resource.- Returns:
- Result of the GetMethodResponse operation returned by the service.
-
getModel
Description copied from interface:AmazonApiGateway
Describes an existing model defined for a RestApi resource.
- Specified by:
getModel
in interfaceAmazonApiGateway
- Parameters:
request
- Request to list information about a model in an existing RestApi resource.- Returns:
- Result of the GetModel operation returned by the service.
-
getModelTemplate
Description copied from interface:AmazonApiGateway
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
- Specified by:
getModelTemplate
in interfaceAmazonApiGateway
- Parameters:
request
- Request to generate a sample mapping template used to transform the payload.- Returns:
- Result of the GetModelTemplate operation returned by the service.
-
getModels
Description copied from interface:AmazonApiGateway
- Specified by:
getModels
in interfaceAmazonApiGateway
- Parameters:
request
- Request to list existing Models defined for a RestApi resource.- Returns:
- Result of the GetModels operation returned by the service.
-
getResource
Description copied from interface:AmazonApiGateway
Lists information about a resource.
- Specified by:
getResource
in interfaceAmazonApiGateway
- Parameters:
request
- Request to list information about a resource.- Returns:
- Result of the GetResource operation returned by the service.
-
getResources
Description copied from interface:AmazonApiGateway
Lists information about a collection of Resource resources.
- Specified by:
getResources
in interfaceAmazonApiGateway
- Parameters:
request
- Request to list information about a collection of resources.- Returns:
- Result of the GetResources operation returned by the service.
-
getRestApi
Description copied from interface:AmazonApiGateway
Lists the RestApi resource in the collection.
- Specified by:
getRestApi
in interfaceAmazonApiGateway
- Parameters:
request
- The GET request to list an existing RestApi defined for your collection.- Returns:
- Result of the GetRestApi operation returned by the service.
-
getRestApis
Description copied from interface:AmazonApiGateway
Lists the RestApis resources for your collection.
- Specified by:
getRestApis
in interfaceAmazonApiGateway
- Parameters:
request
- The GET request to list existing RestApis defined for your collection.- Returns:
- Result of the GetRestApis operation returned by the service.
-
getSdk
Description copied from interface:AmazonApiGateway
- Specified by:
getSdk
in interfaceAmazonApiGateway
- Parameters:
request
- Request a new generated client SDK for a RestApi and Stage.- Returns:
- Result of the GetSdk operation returned by the service.
-
getStage
Description copied from interface:AmazonApiGateway
Gets information about a Stage resource.
- Specified by:
getStage
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to get information about a Stage resource.- Returns:
- Result of the GetStage operation returned by the service.
-
getStages
Description copied from interface:AmazonApiGateway
Gets information about one or more Stage resources.
- Specified by:
getStages
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to get information about one or more Stage resources.- Returns:
- Result of the GetStages operation returned by the service.
-
importRestApi
Description copied from interface:AmazonApiGateway
A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
- Specified by:
importRestApi
in interfaceAmazonApiGateway
- Parameters:
request
- 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.
-
putIntegration
Description copied from interface:AmazonApiGateway
Represents a put integration.
- Specified by:
putIntegration
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a put integration request.- Returns:
- Result of the PutIntegration operation returned by the service.
-
putIntegrationResponse
Description copied from interface:AmazonApiGateway
Represents a put integration.
- Specified by:
putIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Represents a put integration response request.- Returns:
- Result of the PutIntegrationResponse operation returned by the service.
-
putMethod
Description copied from interface:AmazonApiGateway
Add a method to an existing Resource resource.
- Specified by:
putMethod
in interfaceAmazonApiGateway
- Parameters:
request
- Request to add a method to an existing Resource resource.- Returns:
- Result of the PutMethod operation returned by the service.
-
putMethodResponse
Description copied from interface:AmazonApiGateway
Adds a MethodResponse to an existing Method resource.
- Specified by:
putMethodResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Request to add a MethodResponse to an existing Method resource.- Returns:
- Result of the PutMethodResponse operation returned by the service.
-
putRestApi
Description copied from interface:AmazonApiGateway
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 interfaceAmazonApiGateway
- Parameters:
request
- 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.
-
testInvokeAuthorizer
Description copied from interface:AmazonApiGateway
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
- Specified by:
testInvokeAuthorizer
in interfaceAmazonApiGateway
- Parameters:
request
- Make a request to simulate the execution of an Authorizer.- Returns:
- Result of the TestInvokeAuthorizer operation returned by the service.
-
testInvokeMethod
Description copied from interface:AmazonApiGateway
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
- Specified by:
testInvokeMethod
in interfaceAmazonApiGateway
- Parameters:
request
- Make a request to simulate the execution of a Method.- Returns:
- Result of the TestInvokeMethod operation returned by the service.
-
updateAccount
Description copied from interface:AmazonApiGateway
Changes information about the current Account resource.
- Specified by:
updateAccount
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to change information about the current Account resource.- Returns:
- Result of the UpdateAccount operation returned by the service.
-
updateApiKey
Description copied from interface:AmazonApiGateway
Changes information about an ApiKey resource.
- Specified by:
updateApiKey
in interfaceAmazonApiGateway
- Parameters:
request
- A request to change information about an ApiKey resource.- Returns:
- Result of the UpdateApiKey operation returned by the service.
-
updateAuthorizer
Description copied from interface:AmazonApiGateway
Updates an existing Authorizer resource.
- Specified by:
updateAuthorizer
in interfaceAmazonApiGateway
- Parameters:
request
- Request to update an existing Authorizer resource.- Returns:
- Result of the UpdateAuthorizer operation returned by the service.
-
updateBasePathMapping
Description copied from interface:AmazonApiGateway
Changes information about the BasePathMapping resource.
- Specified by:
updateBasePathMapping
in interfaceAmazonApiGateway
- Parameters:
request
- A request to change information about the BasePathMapping resource.- Returns:
- Result of the UpdateBasePathMapping operation returned by the service.
-
updateClientCertificate
public UpdateClientCertificateResult updateClientCertificate(UpdateClientCertificateRequest request) Description copied from interface:AmazonApiGateway
Changes information about an ClientCertificate resource.
- Specified by:
updateClientCertificate
in interfaceAmazonApiGateway
- Parameters:
request
- A request to change information about an ClientCertificate resource.- Returns:
- Result of the UpdateClientCertificate operation returned by the service.
-
updateDeployment
Description copied from interface:AmazonApiGateway
Changes information about a Deployment resource.
- Specified by:
updateDeployment
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to change information about a Deployment resource.- Returns:
- Result of the UpdateDeployment operation returned by the service.
-
updateDomainName
Description copied from interface:AmazonApiGateway
Changes information about the DomainName resource.
- Specified by:
updateDomainName
in interfaceAmazonApiGateway
- Parameters:
request
- A request to change information about the DomainName resource.- Returns:
- Result of the UpdateDomainName operation returned by the service.
-
updateIntegration
Description copied from interface:AmazonApiGateway
Represents an update integration.
- Specified by:
updateIntegration
in interfaceAmazonApiGateway
- Parameters:
request
- Represents an update integration request.- Returns:
- Result of the UpdateIntegration operation returned by the service.
-
updateIntegrationResponse
public UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest request) Description copied from interface:AmazonApiGateway
Represents an update integration response.
- Specified by:
updateIntegrationResponse
in interfaceAmazonApiGateway
- Parameters:
request
- Represents an update integration response request.- Returns:
- Result of the UpdateIntegrationResponse operation returned by the service.
-
updateMethod
Description copied from interface:AmazonApiGateway
Updates an existing Method resource.
- Specified by:
updateMethod
in interfaceAmazonApiGateway
- Parameters:
request
- Request to update an existing Method resource.- Returns:
- Result of the UpdateMethod operation returned by the service.
-
updateMethodResponse
Description copied from interface:AmazonApiGateway
Updates an existing MethodResponse resource.
- Specified by:
updateMethodResponse
in interfaceAmazonApiGateway
- Parameters:
request
- A request to update an existing MethodResponse resource.- Returns:
- Result of the UpdateMethodResponse operation returned by the service.
-
updateModel
Description copied from interface:AmazonApiGateway
Changes information about a model.
- Specified by:
updateModel
in interfaceAmazonApiGateway
- Parameters:
request
- Request to update an existing model in an existing RestApi resource.- Returns:
- Result of the UpdateModel operation returned by the service.
-
updateResource
Description copied from interface:AmazonApiGateway
Changes information about a Resource resource.
- Specified by:
updateResource
in interfaceAmazonApiGateway
- Parameters:
request
- Request to change information about a Resource resource.- Returns:
- Result of the UpdateResource operation returned by the service.
-
updateRestApi
Description copied from interface:AmazonApiGateway
Changes information about the specified API.
- Specified by:
updateRestApi
in interfaceAmazonApiGateway
- Parameters:
request
- Request to update an existing RestApi resource in your collection.- Returns:
- Result of the UpdateRestApi operation returned by the service.
-
updateStage
Description copied from interface:AmazonApiGateway
Changes information about a Stage resource.
- Specified by:
updateStage
in interfaceAmazonApiGateway
- Parameters:
request
- Requests Amazon API Gateway to change information about a Stage resource.- Returns:
- Result of the UpdateStage operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonApiGateway
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAmazonApiGateway
-
getCachedResponseMetadata
Description copied from interface:AmazonApiGateway
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 a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonApiGateway
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-