AbstractAmazonApiGateway (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.AbstractAmazonApiGateway

All Implemented Interfaces:

AmazonApiGateway

Direct Known Subclasses:

AbstractAmazonApiGatewayAsync
```
public class AbstractAmazonApiGateway
extends Object
implements AmazonApiGateway
```
Abstract implementation of AmazonApiGateway. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.apigateway.AmazonApiGateway
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateApiKeyResult`	`createApiKey(CreateApiKeyRequest request)` Create an ApiKey resource.
`CreateAuthorizerResult`	`createAuthorizer(CreateAuthorizerRequest request)` Adds a new Authorizer resource to an existing RestApi resource.
`CreateBasePathMappingResult`	`createBasePathMapping(CreateBasePathMappingRequest request)` Creates a new BasePathMapping resource.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest request)` Creates a Deployment resource, which makes a specified RestApi callable over the internet.
`CreateDomainNameResult`	`createDomainName(CreateDomainNameRequest request)` Creates a new domain name.
`CreateModelResult`	`createModel(CreateModelRequest request)` Adds a new Model resource to an existing RestApi resource.
`CreateResourceResult`	`createResource(CreateResourceRequest request)` Creates a Resource resource.
`CreateRestApiResult`	`createRestApi(CreateRestApiRequest request)` Creates a new RestApi resource.
`CreateStageResult`	`createStage(CreateStageRequest request)` Creates a new Stage resource that references a pre-existing Deployment for the API.
`DeleteApiKeyResult`	`deleteApiKey(DeleteApiKeyRequest request)` Deletes the ApiKey resource.
`DeleteAuthorizerResult`	`deleteAuthorizer(DeleteAuthorizerRequest request)` Deletes an existing Authorizer resource.
`DeleteBasePathMappingResult`	`deleteBasePathMapping(DeleteBasePathMappingRequest request)` Deletes the BasePathMapping resource.
`DeleteClientCertificateResult`	`deleteClientCertificate(DeleteClientCertificateRequest request)` Deletes the ClientCertificate resource.
`DeleteDeploymentResult`	`deleteDeployment(DeleteDeploymentRequest request)` Deletes a Deployment resource.
`DeleteDomainNameResult`	`deleteDomainName(DeleteDomainNameRequest request)` Deletes the DomainName resource.
`DeleteIntegrationResult`	`deleteIntegration(DeleteIntegrationRequest request)` Represents a delete integration.
`DeleteIntegrationResponseResult`	`deleteIntegrationResponse(DeleteIntegrationResponseRequest request)` Represents a delete integration response.
`DeleteMethodResult`	`deleteMethod(DeleteMethodRequest request)` Deletes an existing Method resource.
`DeleteMethodResponseResult`	`deleteMethodResponse(DeleteMethodResponseRequest request)` Deletes an existing MethodResponse resource.
`DeleteModelResult`	`deleteModel(DeleteModelRequest request)` Deletes a model.
`DeleteResourceResult`	`deleteResource(DeleteResourceRequest request)` Deletes a Resource resource.
`DeleteRestApiResult`	`deleteRestApi(DeleteRestApiRequest request)` Deletes the specified API.
`DeleteStageResult`	`deleteStage(DeleteStageRequest request)` Deletes a Stage resource.
`FlushStageAuthorizersCacheResult`	`flushStageAuthorizersCache(FlushStageAuthorizersCacheRequest request)` Flushes all authorizer cache entries on a stage.
`FlushStageCacheResult`	`flushStageCache(FlushStageCacheRequest request)` Flushes a stage's cache.
`GenerateClientCertificateResult`	`generateClientCertificate(GenerateClientCertificateRequest request)` Generates a ClientCertificate resource.
`GetAccountResult`	`getAccount(GetAccountRequest request)` Gets information about the current Account resource.
`GetApiKeyResult`	`getApiKey(GetApiKeyRequest request)` Gets information about the current ApiKey resource.
`GetApiKeysResult`	`getApiKeys(GetApiKeysRequest request)` Gets information about the current ApiKeys resource.
`GetAuthorizerResult`	`getAuthorizer(GetAuthorizerRequest request)` Describe an existing Authorizer resource.
`GetAuthorizersResult`	`getAuthorizers(GetAuthorizersRequest request)` Describe an existing Authorizers resource.
`GetBasePathMappingResult`	`getBasePathMapping(GetBasePathMappingRequest request)` Describe a BasePathMapping resource.
`GetBasePathMappingsResult`	`getBasePathMappings(GetBasePathMappingsRequest request)` 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 request)` Gets information about the current ClientCertificate resource.
`GetClientCertificatesResult`	`getClientCertificates(GetClientCertificatesRequest request)` Gets a collection of ClientCertificate resources.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest request)` Gets information about a Deployment resource.
`GetDeploymentsResult`	`getDeployments(GetDeploymentsRequest request)` Gets information about a Deployments collection.
`GetDomainNameResult`	`getDomainName(GetDomainNameRequest request)` Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
`GetDomainNamesResult`	`getDomainNames(GetDomainNamesRequest request)` Represents a collection of DomainName resources.
`GetExportResult`	`getExport(GetExportRequest request)` Exports a deployed version of a RestApi in a specified format.
`GetIntegrationResult`	`getIntegration(GetIntegrationRequest request)` Represents a get integration.
`GetIntegrationResponseResult`	`getIntegrationResponse(GetIntegrationResponseRequest request)` Represents a get integration response.
`GetMethodResult`	`getMethod(GetMethodRequest request)` Describe an existing Method resource.
`GetMethodResponseResult`	`getMethodResponse(GetMethodResponseRequest request)` Describes a MethodResponse resource.
`GetModelResult`	`getModel(GetModelRequest request)` Describes an existing model defined for a RestApi resource.
`GetModelsResult`	`getModels(GetModelsRequest request)` Describes existing Models defined for a RestApi resource.
`GetModelTemplateResult`	`getModelTemplate(GetModelTemplateRequest request)` Generates a sample mapping template that can be used to transform a payload into the structure of a model.
`GetResourceResult`	`getResource(GetResourceRequest request)` Lists information about a resource.
`GetResourcesResult`	`getResources(GetResourcesRequest request)` Lists information about a collection of Resource resources.
`GetRestApiResult`	`getRestApi(GetRestApiRequest request)` Lists the RestApi resource in the collection.
`GetRestApisResult`	`getRestApis(GetRestApisRequest request)` Lists the RestApis resources for your collection.
`GetSdkResult`	`getSdk(GetSdkRequest request)` Generates a client SDK for a RestApi and Stage.
`GetStageResult`	`getStage(GetStageRequest request)` Gets information about a Stage resource.
`GetStagesResult`	`getStages(GetStagesRequest request)` Gets information about one or more Stage resources.
`ImportRestApiResult`	`importRestApi(ImportRestApiRequest request)` A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
`PutIntegrationResult`	`putIntegration(PutIntegrationRequest request)` Represents a put integration.
`PutIntegrationResponseResult`	`putIntegrationResponse(PutIntegrationResponseRequest request)` Represents a put integration.
`PutMethodResult`	`putMethod(PutMethodRequest request)` Add a method to an existing Resource resource.
`PutMethodResponseResult`	`putMethodResponse(PutMethodResponseRequest request)` Adds a MethodResponse to an existing Method resource.
`PutRestApiResult`	`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`	`setRegion(Region region)` An alternative to `AmazonApiGateway.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.
`TestInvokeAuthorizerResult`	`testInvokeAuthorizer(TestInvokeAuthorizerRequest request)` Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
`TestInvokeMethodResult`	`testInvokeMethod(TestInvokeMethodRequest request)` Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
`UpdateAccountResult`	`updateAccount(UpdateAccountRequest request)` Changes information about the current Account resource.
`UpdateApiKeyResult`	`updateApiKey(UpdateApiKeyRequest request)` Changes information about an ApiKey resource.
`UpdateAuthorizerResult`	`updateAuthorizer(UpdateAuthorizerRequest request)` Updates an existing Authorizer resource.
`UpdateBasePathMappingResult`	`updateBasePathMapping(UpdateBasePathMappingRequest request)` Changes information about the BasePathMapping resource.
`UpdateClientCertificateResult`	`updateClientCertificate(UpdateClientCertificateRequest request)` Changes information about an ClientCertificate resource.
`UpdateDeploymentResult`	`updateDeployment(UpdateDeploymentRequest request)` Changes information about a Deployment resource.
`UpdateDomainNameResult`	`updateDomainName(UpdateDomainNameRequest request)` Changes information about the DomainName resource.
`UpdateIntegrationResult`	`updateIntegration(UpdateIntegrationRequest request)` Represents an update integration.
`UpdateIntegrationResponseResult`	`updateIntegrationResponse(UpdateIntegrationResponseRequest request)` Represents an update integration response.
`UpdateMethodResult`	`updateMethod(UpdateMethodRequest request)` Updates an existing Method resource.
`UpdateMethodResponseResult`	`updateMethodResponse(UpdateMethodResponseRequest request)` Updates an existing MethodResponse resource.
`UpdateModelResult`	`updateModel(UpdateModelRequest request)` Changes information about a model.
`UpdateResourceResult`	`updateResource(UpdateResourceRequest request)` Changes information about a Resource resource.
`UpdateRestApiResult`	`updateRestApi(UpdateRestApiRequest request)` Changes information about the specified API.
`UpdateStageResult`	`updateStage(UpdateStageRequest request)` Changes information about a Stage resource.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    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 interface AmazonApiGateway
    
    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
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonApiGateway
    
    An alternative to AmazonApiGateway.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 interface AmazonApiGateway
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createApiKey
```
public CreateApiKeyResult createApiKey(CreateApiKeyRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Create an ApiKey resource.
    
    Specified by:
    
    createApiKey in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to create an ApiKey resource.
    
    Returns:
    
    Result of the CreateApiKey operation returned by the service.
  - createAuthorizer
```
public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Adds a new Authorizer resource to an existing RestApi resource.
    
    Specified by:
    
    createAuthorizer in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to add a new Authorizer to an existing RestApi resource.
    
    Returns:
    
    Result of the CreateAuthorizer operation returned by the service.
  - createBasePathMapping
```
public CreateBasePathMappingResult createBasePathMapping(CreateBasePathMappingRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a new BasePathMapping resource.
    
    Specified by:
    
    createBasePathMapping in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to create a new BasePathMapping resource.
    
    Returns:
    
    Result of the CreateBasePathMapping operation returned by the service.
  - createDeployment
```
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a Deployment resource, which makes a specified RestApi callable over the internet.
    
    Specified by:
    
    createDeployment in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to create a Deployment resource.
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
  - createDomainName
```
public CreateDomainNameResult createDomainName(CreateDomainNameRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a new domain name.
    
    Specified by:
    
    createDomainName in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to create a new domain name.
    
    Returns:
    
    Result of the CreateDomainName operation returned by the service.
  - createModel
```
public CreateModelResult createModel(CreateModelRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Adds a new Model resource to an existing RestApi resource.
    
    Specified by:
    
    createModel in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to add a new Model to an existing RestApi resource.
    
    Returns:
    
    Result of the CreateModel operation returned by the service.
  - createResource
```
public CreateResourceResult createResource(CreateResourceRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a Resource resource.
    
    Specified by:
    
    createResource in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to create a Resource resource.
    
    Returns:
    
    Result of the CreateResource operation returned by the service.
  - createRestApi
```
public CreateRestApiResult createRestApi(CreateRestApiRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a new RestApi resource.
    
    Specified by:
    
    createRestApi in interface AmazonApiGateway
    
    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
```
public CreateStageResult createStage(CreateStageRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Creates a new Stage resource that references a pre-existing Deployment for the API.
    
    Specified by:
    
    createStage in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to create a Stage resource.
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
  - deleteApiKey
```
public DeleteApiKeyResult deleteApiKey(DeleteApiKeyRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes the ApiKey resource.
    
    Specified by:
    
    deleteApiKey in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to delete the ApiKey resource.
    
    Returns:
    
    Result of the DeleteApiKey operation returned by the service.
  - deleteAuthorizer
```
public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes an existing Authorizer resource.
    
    Specified by:
    
    deleteAuthorizer in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to delete an existing Authorizer resource.
    
    Returns:
    
    Result of the DeleteAuthorizer operation returned by the service.
  - deleteBasePathMapping
```
public DeleteBasePathMappingResult deleteBasePathMapping(DeleteBasePathMappingRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes the BasePathMapping resource.
    
    Specified by:
    
    deleteBasePathMapping in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - A request to delete the ClientCertificate resource.
    
    Returns:
    
    Result of the DeleteClientCertificate operation returned by the service.
  - deleteDeployment
```
public DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest request)
```
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to delete a Deployment resource.
    
    Returns:
    
    Result of the DeleteDeployment operation returned by the service.
  - deleteDomainName
```
public DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes the DomainName resource.
    
    Specified by:
    
    deleteDomainName in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to delete the DomainName resource.
    
    Returns:
    
    Result of the DeleteDomainName operation returned by the service.
  - deleteIntegration
```
public DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a delete integration.
    
    Specified by:
    
    deleteIntegration in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Represents a delete integration response request.
    
    Returns:
    
    Result of the DeleteIntegrationResponse operation returned by the service.
  - deleteMethod
```
public DeleteMethodResult deleteMethod(DeleteMethodRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes an existing Method resource.
    
    Specified by:
    
    deleteMethod in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to delete an existing Method resource.
    
    Returns:
    
    Result of the DeleteMethod operation returned by the service.
  - deleteMethodResponse
```
public DeleteMethodResponseResult deleteMethodResponse(DeleteMethodResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes an existing MethodResponse resource.
    
    Specified by:
    
    deleteMethodResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to delete an existing MethodResponse resource.
    
    Returns:
    
    Result of the DeleteMethodResponse operation returned by the service.
  - deleteModel
```
public DeleteModelResult deleteModel(DeleteModelRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes a model.
    
    Specified by:
    
    deleteModel in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to delete an existing model in an existing RestApi resource.
    
    Returns:
    
    Result of the DeleteModel operation returned by the service.
  - deleteResource
```
public DeleteResourceResult deleteResource(DeleteResourceRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes a Resource resource.
    
    Specified by:
    
    deleteResource in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to delete a Resource.
    
    Returns:
    
    Result of the DeleteResource operation returned by the service.
  - deleteRestApi
```
public DeleteRestApiResult deleteRestApi(DeleteRestApiRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes the specified API.
    
    Specified by:
    
    deleteRestApi in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to delete the specified API from your collection.
    
    Returns:
    
    Result of the DeleteRestApi operation returned by the service.
  - deleteStage
```
public DeleteStageResult deleteStage(DeleteStageRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Deletes a Stage resource.
    
    Specified by:
    
    deleteStage in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Request to flush authorizer cache entries on a specified stage.
    
    Returns:
    
    Result of the FlushStageAuthorizersCache operation returned by the service.
  - flushStageCache
```
public FlushStageCacheResult flushStageCache(FlushStageCacheRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Flushes a stage's cache.
    
    Specified by:
    
    flushStageCache in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - A request to generate a ClientCertificate resource.
    
    Returns:
    
    Result of the GenerateClientCertificate operation returned by the service.
  - getAccount
```
public GetAccountResult getAccount(GetAccountRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about the current Account resource.
    
    Specified by:
    
    getAccount in interface AmazonApiGateway
    
    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
```
public GetApiKeyResult getApiKey(GetApiKeyRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about the current ApiKey resource.
    
    Specified by:
    
    getApiKey in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to get information about the current ApiKey resource.
    
    Returns:
    
    Result of the GetApiKey operation returned by the service.
  - getApiKeys
```
public GetApiKeysResult getApiKeys(GetApiKeysRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about the current ApiKeys resource.
    
    Specified by:
    
    getApiKeys in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to get information about the current ApiKeys resource.
    
    Returns:
    
    Result of the GetApiKeys operation returned by the service.
  - getAuthorizer
```
public GetAuthorizerResult getAuthorizer(GetAuthorizerRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describe an existing Authorizer resource.
    
    Specified by:
    
    getAuthorizer in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe an existing Authorizer resource.
    
    Returns:
    
    Result of the GetAuthorizer operation returned by the service.
  - getAuthorizers
```
public GetAuthorizersResult getAuthorizers(GetAuthorizersRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describe an existing Authorizers resource.
    
    Specified by:
    
    getAuthorizers in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe an existing Authorizers resource.
    
    Returns:
    
    Result of the GetAuthorizers operation returned by the service.
  - getBasePathMapping
```
public GetBasePathMappingResult getBasePathMapping(GetBasePathMappingRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describe a BasePathMapping resource.
    
    Specified by:
    
    getBasePathMapping in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe a BasePathMapping resource.
    
    Returns:
    
    Result of the GetBasePathMapping operation returned by the service.
  - getBasePathMappings
```
public GetBasePathMappingsResult getBasePathMappings(GetBasePathMappingsRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a collection of BasePathMapping resources.
    
    Specified by:
    
    getBasePathMappings in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to get information about a collection of BasePathMapping resources.
    
    Returns:
    
    Result of the GetBasePathMappings operation returned by the service.
  - getClientCertificate
```
public GetClientCertificateResult getClientCertificate(GetClientCertificateRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about the current ClientCertificate resource.
    
    Specified by:
    
    getClientCertificate in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to get information about the current ClientCertificate resource.
    
    Returns:
    
    Result of the GetClientCertificate operation returned by the service.
  - getClientCertificates
```
public GetClientCertificatesResult getClientCertificates(GetClientCertificatesRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets a collection of ClientCertificate resources.
    
    Specified by:
    
    getClientCertificates in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to get information about a collection of ClientCertificate resources.
    
    Returns:
    
    Result of the GetClientCertificates operation returned by the service.
  - getDeployment
```
public GetDeploymentResult getDeployment(GetDeploymentRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about a Deployment resource.
    
    Specified by:
    
    getDeployment in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to get information about a Deployment resource.
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
  - getDeployments
```
public GetDeploymentsResult getDeployments(GetDeploymentsRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about a Deployments collection.
    
    Specified by:
    
    getDeployments in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to get information about a Deployments collection.
    
    Returns:
    
    Result of the GetDeployments operation returned by the service.
  - getDomainName
```
public GetDomainNameResult getDomainName(GetDomainNameRequest request)
```
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Request to get the name of a DomainName resource.
    
    Returns:
    
    Result of the GetDomainName operation returned by the service.
  - getDomainNames
```
public GetDomainNamesResult getDomainNames(GetDomainNamesRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a collection of DomainName resources.
    
    Specified by:
    
    getDomainNames in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe a collection of DomainName resources.
    
    Returns:
    
    Result of the GetDomainNames operation returned by the service.
  - getExport
```
public GetExportResult getExport(GetExportRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Exports a deployed version of a RestApi in a specified format.
    
    Specified by:
    
    getExport in interface AmazonApiGateway
    
    Parameters:
    
    request - Request a new export of a RestApi for a particular Stage.
    
    Returns:
    
    Result of the GetExport operation returned by the service.
  - getIntegration
```
public GetIntegrationResult getIntegration(GetIntegrationRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a get integration.
    
    Specified by:
    
    getIntegration in interface AmazonApiGateway
    
    Parameters:
    
    request - Represents a get integration request.
    
    Returns:
    
    Result of the GetIntegration operation returned by the service.
  - getIntegrationResponse
```
public GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a get integration response.
    
    Specified by:
    
    getIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - Represents a get integration response request.
    
    Returns:
    
    Result of the GetIntegrationResponse operation returned by the service.
  - getMethod
```
public GetMethodResult getMethod(GetMethodRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describe an existing Method resource.
    
    Specified by:
    
    getMethod in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe an existing Method resource.
    
    Returns:
    
    Result of the GetMethod operation returned by the service.
  - getMethodResponse
```
public GetMethodResponseResult getMethodResponse(GetMethodResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describes a MethodResponse resource.
    
    Specified by:
    
    getMethodResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to describe a MethodResponse resource.
    
    Returns:
    
    Result of the GetMethodResponse operation returned by the service.
  - getModel
```
public GetModelResult getModel(GetModelRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describes an existing model defined for a RestApi resource.
    
    Specified by:
    
    getModel in interface AmazonApiGateway
    
    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
```
public GetModelTemplateResult getModelTemplate(GetModelTemplateRequest request)
```
    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 interface AmazonApiGateway
    
    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
```
public GetModelsResult getModels(GetModelsRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Describes existing Models defined for a RestApi resource.
    
    Specified by:
    
    getModels in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to list existing Models defined for a RestApi resource.
    
    Returns:
    
    Result of the GetModels operation returned by the service.
  - getResource
```
public GetResourceResult getResource(GetResourceRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Lists information about a resource.
    
    Specified by:
    
    getResource in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to list information about a resource.
    
    Returns:
    
    Result of the GetResource operation returned by the service.
  - getResources
```
public GetResourcesResult getResources(GetResourcesRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Lists information about a collection of Resource resources.
    
    Specified by:
    
    getResources in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to list information about a collection of resources.
    
    Returns:
    
    Result of the GetResources operation returned by the service.
  - getRestApi
```
public GetRestApiResult getRestApi(GetRestApiRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Lists the RestApi resource in the collection.
    
    Specified by:
    
    getRestApi in interface AmazonApiGateway
    
    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
```
public GetRestApisResult getRestApis(GetRestApisRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Lists the RestApis resources for your collection.
    
    Specified by:
    
    getRestApis in interface AmazonApiGateway
    
    Parameters:
    
    request - The GET request to list existing RestApis defined for your collection.
    
    Returns:
    
    Result of the GetRestApis operation returned by the service.
  - getSdk
```
public GetSdkResult getSdk(GetSdkRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Generates a client SDK for a RestApi and Stage.
    
    Specified by:
    
    getSdk in interface AmazonApiGateway
    
    Parameters:
    
    request - Request a new generated client SDK for a RestApi and Stage.
    
    Returns:
    
    Result of the GetSdk operation returned by the service.
  - getStage
```
public GetStageResult getStage(GetStageRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about a Stage resource.
    
    Specified by:
    
    getStage in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to get information about a Stage resource.
    
    Returns:
    
    Result of the GetStage operation returned by the service.
  - getStages
```
public GetStagesResult getStages(GetStagesRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Gets information about one or more Stage resources.
    
    Specified by:
    
    getStages in interface AmazonApiGateway
    
    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
```
public ImportRestApiResult importRestApi(ImportRestApiRequest request)
```
    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 interface AmazonApiGateway
    
    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
```
public PutIntegrationResult putIntegration(PutIntegrationRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a put integration.
    
    Specified by:
    
    putIntegration in interface AmazonApiGateway
    
    Parameters:
    
    request - Represents a put integration request.
    
    Returns:
    
    Result of the PutIntegration operation returned by the service.
  - putIntegrationResponse
```
public PutIntegrationResponseResult putIntegrationResponse(PutIntegrationResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents a put integration.
    
    Specified by:
    
    putIntegrationResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - Represents a put integration response request.
    
    Returns:
    
    Result of the PutIntegrationResponse operation returned by the service.
  - putMethod
```
public PutMethodResult putMethod(PutMethodRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Add a method to an existing Resource resource.
    
    Specified by:
    
    putMethod in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to add a method to an existing Resource resource.
    
    Returns:
    
    Result of the PutMethod operation returned by the service.
  - putMethodResponse
```
public PutMethodResponseResult putMethodResponse(PutMethodResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Adds a MethodResponse to an existing Method resource.
    
    Specified by:
    
    putMethodResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to add a MethodResponse to an existing Method resource.
    
    Returns:
    
    Result of the PutMethodResponse operation returned by the service.
  - putRestApi
```
public PutRestApiResult putRestApi(PutRestApiRequest request)
```
    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 interface AmazonApiGateway
    
    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
```
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
```
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Make a request to simulate the execution of an Authorizer.
    
    Returns:
    
    Result of the TestInvokeAuthorizer operation returned by the service.
  - testInvokeMethod
```
public TestInvokeMethodResult testInvokeMethod(TestInvokeMethodRequest request)
```
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Make a request to simulate the execution of a Method.
    
    Returns:
    
    Result of the TestInvokeMethod operation returned by the service.
  - updateAccount
```
public UpdateAccountResult updateAccount(UpdateAccountRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about the current Account resource.
    
    Specified by:
    
    updateAccount in interface AmazonApiGateway
    
    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
```
public UpdateApiKeyResult updateApiKey(UpdateApiKeyRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about an ApiKey resource.
    
    Specified by:
    
    updateApiKey in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to change information about an ApiKey resource.
    
    Returns:
    
    Result of the UpdateApiKey operation returned by the service.
  - updateAuthorizer
```
public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Updates an existing Authorizer resource.
    
    Specified by:
    
    updateAuthorizer in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to update an existing Authorizer resource.
    
    Returns:
    
    Result of the UpdateAuthorizer operation returned by the service.
  - updateBasePathMapping
```
public UpdateBasePathMappingResult updateBasePathMapping(UpdateBasePathMappingRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about the BasePathMapping resource.
    
    Specified by:
    
    updateBasePathMapping in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - A request to change information about an ClientCertificate resource.
    
    Returns:
    
    Result of the UpdateClientCertificate operation returned by the service.
  - updateDeployment
```
public UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about a Deployment resource.
    
    Specified by:
    
    updateDeployment in interface AmazonApiGateway
    
    Parameters:
    
    request - Requests Amazon API Gateway to change information about a Deployment resource.
    
    Returns:
    
    Result of the UpdateDeployment operation returned by the service.
  - updateDomainName
```
public UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about the DomainName resource.
    
    Specified by:
    
    updateDomainName in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to change information about the DomainName resource.
    
    Returns:
    
    Result of the UpdateDomainName operation returned by the service.
  - updateIntegration
```
public UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Represents an update integration.
    
    Specified by:
    
    updateIntegration in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - Represents an update integration response request.
    
    Returns:
    
    Result of the UpdateIntegrationResponse operation returned by the service.
  - updateMethod
```
public UpdateMethodResult updateMethod(UpdateMethodRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Updates an existing Method resource.
    
    Specified by:
    
    updateMethod in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to update an existing Method resource.
    
    Returns:
    
    Result of the UpdateMethod operation returned by the service.
  - updateMethodResponse
```
public UpdateMethodResponseResult updateMethodResponse(UpdateMethodResponseRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Updates an existing MethodResponse resource.
    
    Specified by:
    
    updateMethodResponse in interface AmazonApiGateway
    
    Parameters:
    
    request - A request to update an existing MethodResponse resource.
    
    Returns:
    
    Result of the UpdateMethodResponse operation returned by the service.
  - updateModel
```
public UpdateModelResult updateModel(UpdateModelRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about a model.
    
    Specified by:
    
    updateModel in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to update an existing model in an existing RestApi resource.
    
    Returns:
    
    Result of the UpdateModel operation returned by the service.
  - updateResource
```
public UpdateResourceResult updateResource(UpdateResourceRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about a Resource resource.
    
    Specified by:
    
    updateResource in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to change information about a Resource resource.
    
    Returns:
    
    Result of the UpdateResource operation returned by the service.
  - updateRestApi
```
public UpdateRestApiResult updateRestApi(UpdateRestApiRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about the specified API.
    
    Specified by:
    
    updateRestApi in interface AmazonApiGateway
    
    Parameters:
    
    request - Request to update an existing RestApi resource in your collection.
    
    Returns:
    
    Result of the UpdateRestApi operation returned by the service.
  - updateStage
```
public UpdateStageResult updateStage(UpdateStageRequest request)
```
    Description copied from interface: AmazonApiGateway
    
    Changes information about a Stage resource.
    
    Specified by:
    
    updateStage in interface AmazonApiGateway
    
    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 interface AmazonApiGateway
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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 interface AmazonApiGateway
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonApiGateway

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createApiKey

createAuthorizer

createBasePathMapping

createDeployment

createDomainName

createModel

createResource

createRestApi

createStage

deleteApiKey

deleteAuthorizer

deleteBasePathMapping

deleteClientCertificate

deleteDeployment

deleteDomainName

deleteIntegration

deleteIntegrationResponse

deleteMethod

deleteMethodResponse

deleteModel

deleteResource

deleteRestApi

deleteStage

flushStageAuthorizersCache

flushStageCache

generateClientCertificate

getAccount

getApiKey

getApiKeys

getAuthorizer

getAuthorizers

getBasePathMapping

getBasePathMappings

getClientCertificate

getClientCertificates

getDeployment

getDeployments

getDomainName

getDomainNames

getExport

getIntegration

getIntegrationResponse

getMethod

getMethodResponse

getModel

getModelTemplate

getModels

getResource

getResources

getRestApi

getRestApis

getSdk

getStage

getStages

importRestApi

putIntegration

putIntegrationResponse

putMethod

putMethodResponse

putRestApi

testInvokeAuthorizer

testInvokeMethod

updateAccount

updateApiKey

updateAuthorizer

updateBasePathMapping

updateClientCertificate

updateDeployment

updateDomainName

updateIntegration

updateIntegrationResponse