AmazonApiGatewayV2 (AWS SDK for Java

All Known Subinterfaces:

AmazonApiGatewayV2Async

All Known Implementing Classes:

AbstractAmazonApiGatewayV2, AbstractAmazonApiGatewayV2Async, AmazonApiGatewayV2AsyncClient, AmazonApiGatewayV2Client
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApiGatewayV2
```
Interface for accessing AmazonApiGatewayV2.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonApiGatewayV2 instead.

Amazon API Gateway V2

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateApiResult`	`createApi(CreateApiRequest createApiRequest)` Creates an Api resource.
`CreateApiMappingResult`	`createApiMapping(CreateApiMappingRequest createApiMappingRequest)` Creates an API mapping.
`CreateAuthorizerResult`	`createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)` Creates an Authorizer for an API.
`CreateDeploymentResult`	`createDeployment(CreateDeploymentRequest createDeploymentRequest)` Creates a Deployment for an API.
`CreateDomainNameResult`	`createDomainName(CreateDomainNameRequest createDomainNameRequest)` Creates a domain name.
`CreateIntegrationResult`	`createIntegration(CreateIntegrationRequest createIntegrationRequest)` Creates an Integration.
`CreateIntegrationResponseResult`	`createIntegrationResponse(CreateIntegrationResponseRequest createIntegrationResponseRequest)` Creates an IntegrationResponses.
`CreateModelResult`	`createModel(CreateModelRequest createModelRequest)` Creates a Model for an API.
`CreateRouteResult`	`createRoute(CreateRouteRequest createRouteRequest)` Creates a Route for an API.
`CreateRouteResponseResult`	`createRouteResponse(CreateRouteResponseRequest createRouteResponseRequest)` Creates a RouteResponse for a Route.
`CreateStageResult`	`createStage(CreateStageRequest createStageRequest)` Creates a Stage for an API.
`DeleteApiResult`	`deleteApi(DeleteApiRequest deleteApiRequest)` Deletes an Api resource.
`DeleteApiMappingResult`	`deleteApiMapping(DeleteApiMappingRequest deleteApiMappingRequest)` Deletes an API mapping.
`DeleteAuthorizerResult`	`deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)` Deletes an Authorizer.
`DeleteDeploymentResult`	`deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)` Deletes a Deployment.
`DeleteDomainNameResult`	`deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)` Deletes a domain name.
`DeleteIntegrationResult`	`deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)` Deletes an Integration.
`DeleteIntegrationResponseResult`	`deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)` Deletes an IntegrationResponses.
`DeleteModelResult`	`deleteModel(DeleteModelRequest deleteModelRequest)` Deletes a Model.
`DeleteRouteResult`	`deleteRoute(DeleteRouteRequest deleteRouteRequest)` Deletes a Route.
`DeleteRouteResponseResult`	`deleteRouteResponse(DeleteRouteResponseRequest deleteRouteResponseRequest)` Deletes a RouteResponse.
`DeleteStageResult`	`deleteStage(DeleteStageRequest deleteStageRequest)` Deletes a Stage.
`GetApiResult`	`getApi(GetApiRequest getApiRequest)` Gets an Api resource.
`GetApiMappingResult`	`getApiMapping(GetApiMappingRequest getApiMappingRequest)` The API mapping.
`GetApiMappingsResult`	`getApiMappings(GetApiMappingsRequest getApiMappingsRequest)` The API mappings.
`GetApisResult`	`getApis(GetApisRequest getApisRequest)` Gets a collection of Api resources.
`GetAuthorizerResult`	`getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)` Gets an Authorizer.
`GetAuthorizersResult`	`getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)` Gets the Authorizers for an API.
`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.
`GetDeploymentResult`	`getDeployment(GetDeploymentRequest getDeploymentRequest)` Gets a Deployment.
`GetDeploymentsResult`	`getDeployments(GetDeploymentsRequest getDeploymentsRequest)` Gets the Deployments for an API.
`GetDomainNameResult`	`getDomainName(GetDomainNameRequest getDomainNameRequest)` Gets a domain name.
`GetDomainNamesResult`	`getDomainNames(GetDomainNamesRequest getDomainNamesRequest)` Gets the domain names for an AWS account.
`GetIntegrationResult`	`getIntegration(GetIntegrationRequest getIntegrationRequest)` Gets an Integration.
`GetIntegrationResponseResult`	`getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)` Gets an IntegrationResponses.
`GetIntegrationResponsesResult`	`getIntegrationResponses(GetIntegrationResponsesRequest getIntegrationResponsesRequest)` Gets the IntegrationResponses for an Integration.
`GetIntegrationsResult`	`getIntegrations(GetIntegrationsRequest getIntegrationsRequest)` Gets the Integrations for an API.
`GetModelResult`	`getModel(GetModelRequest getModelRequest)` Gets a Model.
`GetModelsResult`	`getModels(GetModelsRequest getModelsRequest)` Gets the Models for an API.
`GetModelTemplateResult`	`getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)` Gets a model template.
`GetRouteResult`	`getRoute(GetRouteRequest getRouteRequest)` Gets a Route.
`GetRouteResponseResult`	`getRouteResponse(GetRouteResponseRequest getRouteResponseRequest)` Gets a RouteResponse.
`GetRouteResponsesResult`	`getRouteResponses(GetRouteResponsesRequest getRouteResponsesRequest)` Gets the RouteResponses for a Route.
`GetRoutesResult`	`getRoutes(GetRoutesRequest getRoutesRequest)` Gets the Routes for an API.
`GetStageResult`	`getStage(GetStageRequest getStageRequest)` Gets a Stage.
`GetStagesResult`	`getStages(GetStagesRequest getStagesRequest)` Gets the Stages for an API.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateApiResult`	`updateApi(UpdateApiRequest updateApiRequest)` Updates an Api resource.
`UpdateApiMappingResult`	`updateApiMapping(UpdateApiMappingRequest updateApiMappingRequest)` The API mapping.
`UpdateAuthorizerResult`	`updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)` Updates an Authorizer.
`UpdateDeploymentResult`	`updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)` Updates a Deployment.
`UpdateDomainNameResult`	`updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)` Updates a domain name.
`UpdateIntegrationResult`	`updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)` Updates an Integration.
`UpdateIntegrationResponseResult`	`updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)` Updates an IntegrationResponses.
`UpdateModelResult`	`updateModel(UpdateModelRequest updateModelRequest)` Updates a Model.
`UpdateRouteResult`	`updateRoute(UpdateRouteRequest updateRouteRequest)` Updates a Route.
`UpdateRouteResponseResult`	`updateRouteResponse(UpdateRouteResponseRequest updateRouteResponseRequest)` Updates a RouteResponse.
`UpdateStageResult`	`updateStage(UpdateStageRequest updateStageRequest)` Updates a Stage.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createApi
```
CreateApiResult createApi(CreateApiRequest createApiRequest)
```
    Creates an Api resource.
    
    Parameters:
    
    createApiRequest -
    
    Returns:
    
    Result of the CreateApi operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createApiMapping
```
CreateApiMappingResult createApiMapping(CreateApiMappingRequest createApiMappingRequest)
```
    Creates an API mapping.
    
    Parameters:
    
    createApiMappingRequest -
    
    Returns:
    
    Result of the CreateApiMapping operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createAuthorizer
```
CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
```
    Creates an Authorizer for an API.
    
    Parameters:
    
    createAuthorizerRequest -
    
    Returns:
    
    Result of the CreateAuthorizer operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createDeployment
```
CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
```
    Creates a Deployment for an API.
    
    Parameters:
    
    createDeploymentRequest -
    
    Returns:
    
    Result of the CreateDeployment operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createDomainName
```
CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
```
    Creates a domain name.
    
    Parameters:
    
    createDomainNameRequest -
    
    Returns:
    
    Result of the CreateDomainName operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createIntegration
```
CreateIntegrationResult createIntegration(CreateIntegrationRequest createIntegrationRequest)
```
    Creates an Integration.
    
    Parameters:
    
    createIntegrationRequest -
    
    Returns:
    
    Result of the CreateIntegration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createIntegrationResponse
```
CreateIntegrationResponseResult createIntegrationResponse(CreateIntegrationResponseRequest createIntegrationResponseRequest)
```
    Creates an IntegrationResponses.
    
    Parameters:
    
    createIntegrationResponseRequest -
    
    Returns:
    
    Result of the CreateIntegrationResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createModel
```
CreateModelResult createModel(CreateModelRequest createModelRequest)
```
    Creates a Model for an API.
    
    Parameters:
    
    createModelRequest -
    
    Returns:
    
    Result of the CreateModel operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createRoute
```
CreateRouteResult createRoute(CreateRouteRequest createRouteRequest)
```
    Creates a Route for an API.
    
    Parameters:
    
    createRouteRequest -
    
    Returns:
    
    Result of the CreateRoute operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createRouteResponse
```
CreateRouteResponseResult createRouteResponse(CreateRouteResponseRequest createRouteResponseRequest)
```
    Creates a RouteResponse for a Route.
    
    Parameters:
    
    createRouteResponseRequest -
    
    Returns:
    
    Result of the CreateRouteResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - createStage
```
CreateStageResult createStage(CreateStageRequest createStageRequest)
```
    Creates a Stage for an API.
    
    Parameters:
    
    createStageRequest -
    
    Returns:
    
    Result of the CreateStage operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - deleteApi
```
DeleteApiResult deleteApi(DeleteApiRequest deleteApiRequest)
```
    Deletes an Api resource.
    
    Parameters:
    
    deleteApiRequest -
    
    Returns:
    
    Result of the DeleteApi operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteApiMapping
```
DeleteApiMappingResult deleteApiMapping(DeleteApiMappingRequest deleteApiMappingRequest)
```
    Deletes an API mapping.
    
    Parameters:
    
    deleteApiMappingRequest -
    
    Returns:
    
    Result of the DeleteApiMapping operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - deleteAuthorizer
```
DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
```
    Deletes an Authorizer.
    
    Parameters:
    
    deleteAuthorizerRequest -
    
    Returns:
    
    Result of the DeleteAuthorizer operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteDeployment
```
DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
```
    Deletes a Deployment.
    
    Parameters:
    
    deleteDeploymentRequest -
    
    Returns:
    
    Result of the DeleteDeployment operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteDomainName
```
DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
```
    Deletes a domain name.
    
    Parameters:
    
    deleteDomainNameRequest -
    
    Returns:
    
    Result of the DeleteDomainName operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteIntegration
```
DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
```
    Deletes an Integration.
    
    Parameters:
    
    deleteIntegrationRequest -
    
    Returns:
    
    Result of the DeleteIntegration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteIntegrationResponse
```
DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
```
    Deletes an IntegrationResponses.
    
    Parameters:
    
    deleteIntegrationResponseRequest -
    
    Returns:
    
    Result of the DeleteIntegrationResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteModel
```
DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
```
    Deletes a Model.
    
    Parameters:
    
    deleteModelRequest -
    
    Returns:
    
    Result of the DeleteModel operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteRoute
```
DeleteRouteResult deleteRoute(DeleteRouteRequest deleteRouteRequest)
```
    Deletes a Route.
    
    Parameters:
    
    deleteRouteRequest -
    
    Returns:
    
    Result of the DeleteRoute operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteRouteResponse
```
DeleteRouteResponseResult deleteRouteResponse(DeleteRouteResponseRequest deleteRouteResponseRequest)
```
    Deletes a RouteResponse.
    
    Parameters:
    
    deleteRouteResponseRequest -
    
    Returns:
    
    Result of the DeleteRouteResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - deleteStage
```
DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
```
    Deletes a Stage.
    
    Parameters:
    
    deleteStageRequest -
    
    Returns:
    
    Result of the DeleteStage operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getApi
```
GetApiResult getApi(GetApiRequest getApiRequest)
```
    Gets an Api resource.
    
    Parameters:
    
    getApiRequest -
    
    Returns:
    
    Result of the GetApi operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getApiMapping
```
GetApiMappingResult getApiMapping(GetApiMappingRequest getApiMappingRequest)
```
    The API mapping.
    
    Parameters:
    
    getApiMappingRequest -
    
    Returns:
    
    Result of the GetApiMapping operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getApiMappings
```
GetApiMappingsResult getApiMappings(GetApiMappingsRequest getApiMappingsRequest)
```
    The API mappings.
    
    Parameters:
    
    getApiMappingsRequest -
    
    Returns:
    
    Result of the GetApiMappings operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getApis
```
GetApisResult getApis(GetApisRequest getApisRequest)
```
    Gets a collection of Api resources.
    
    Parameters:
    
    getApisRequest -
    
    Returns:
    
    Result of the GetApis operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getAuthorizer
```
GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
```
    Gets an Authorizer.
    
    Parameters:
    
    getAuthorizerRequest -
    
    Returns:
    
    Result of the GetAuthorizer operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getAuthorizers
```
GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
```
    Gets the Authorizers for an API.
    
    Parameters:
    
    getAuthorizersRequest -
    
    Returns:
    
    Result of the GetAuthorizers operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getDeployment
```
GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
```
    Gets a Deployment.
    
    Parameters:
    
    getDeploymentRequest -
    
    Returns:
    
    Result of the GetDeployment operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getDeployments
```
GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
```
    Gets the Deployments for an API.
    
    Parameters:
    
    getDeploymentsRequest -
    
    Returns:
    
    Result of the GetDeployments operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getDomainName
```
GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
```
    Gets a domain name.
    
    Parameters:
    
    getDomainNameRequest -
    
    Returns:
    
    Result of the GetDomainName operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getDomainNames
```
GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
```
    Gets the domain names for an AWS account.
    
    Parameters:
    
    getDomainNamesRequest -
    
    Returns:
    
    Result of the GetDomainNames operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getIntegration
```
GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
```
    Gets an Integration.
    
    Parameters:
    
    getIntegrationRequest -
    
    Returns:
    
    Result of the GetIntegration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getIntegrationResponse
```
GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
```
    Gets an IntegrationResponses.
    
    Parameters:
    
    getIntegrationResponseRequest -
    
    Returns:
    
    Result of the GetIntegrationResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getIntegrationResponses
```
GetIntegrationResponsesResult getIntegrationResponses(GetIntegrationResponsesRequest getIntegrationResponsesRequest)
```
    Gets the IntegrationResponses for an Integration.
    
    Parameters:
    
    getIntegrationResponsesRequest -
    
    Returns:
    
    Result of the GetIntegrationResponses operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getIntegrations
```
GetIntegrationsResult getIntegrations(GetIntegrationsRequest getIntegrationsRequest)
```
    Gets the Integrations for an API.
    
    Parameters:
    
    getIntegrationsRequest -
    
    Returns:
    
    Result of the GetIntegrations operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getModel
```
GetModelResult getModel(GetModelRequest getModelRequest)
```
    Gets a Model.
    
    Parameters:
    
    getModelRequest -
    
    Returns:
    
    Result of the GetModel operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getModelTemplate
```
GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
```
    Gets a model template.
    
    Parameters:
    
    getModelTemplateRequest -
    
    Returns:
    
    Result of the GetModelTemplate operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getModels
```
GetModelsResult getModels(GetModelsRequest getModelsRequest)
```
    Gets the Models for an API.
    
    Parameters:
    
    getModelsRequest -
    
    Returns:
    
    Result of the GetModels operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getRoute
```
GetRouteResult getRoute(GetRouteRequest getRouteRequest)
```
    Gets a Route.
    
    Parameters:
    
    getRouteRequest -
    
    Returns:
    
    Result of the GetRoute operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getRouteResponse
```
GetRouteResponseResult getRouteResponse(GetRouteResponseRequest getRouteResponseRequest)
```
    Gets a RouteResponse.
    
    Parameters:
    
    getRouteResponseRequest -
    
    Returns:
    
    Result of the GetRouteResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getRouteResponses
```
GetRouteResponsesResult getRouteResponses(GetRouteResponsesRequest getRouteResponsesRequest)
```
    Gets the RouteResponses for a Route.
    
    Parameters:
    
    getRouteResponsesRequest -
    
    Returns:
    
    Result of the GetRouteResponses operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getRoutes
```
GetRoutesResult getRoutes(GetRoutesRequest getRoutesRequest)
```
    Gets the Routes for an API.
    
    Parameters:
    
    getRoutesRequest -
    
    Returns:
    
    Result of the GetRoutes operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - getStage
```
GetStageResult getStage(GetStageRequest getStageRequest)
```
    Gets a Stage.
    
    Parameters:
    
    getStageRequest -
    
    Returns:
    
    Result of the GetStage operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
  - getStages
```
GetStagesResult getStages(GetStagesRequest getStagesRequest)
```
    Gets the Stages for an API.
    
    Parameters:
    
    getStagesRequest -
    
    Returns:
    
    Result of the GetStages operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
  - updateApi
```
UpdateApiResult updateApi(UpdateApiRequest updateApiRequest)
```
    Updates an Api resource.
    
    Parameters:
    
    updateApiRequest -
    
    Returns:
    
    Result of the UpdateApi operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateApiMapping
```
UpdateApiMappingResult updateApiMapping(UpdateApiMappingRequest updateApiMappingRequest)
```
    The API mapping.
    
    Parameters:
    
    updateApiMappingRequest -
    
    Returns:
    
    Result of the UpdateApiMapping operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateAuthorizer
```
UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
```
    Updates an Authorizer.
    
    Parameters:
    
    updateAuthorizerRequest -
    
    Returns:
    
    Result of the UpdateAuthorizer operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateDeployment
```
UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
```
    Updates a Deployment.
    
    Parameters:
    
    updateDeploymentRequest -
    
    Returns:
    
    Result of the UpdateDeployment operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateDomainName
```
UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
```
    Updates a domain name.
    
    Parameters:
    
    updateDomainNameRequest -
    
    Returns:
    
    Result of the UpdateDomainName operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateIntegration
```
UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
```
    Updates an Integration.
    
    Parameters:
    
    updateIntegrationRequest -
    
    Returns:
    
    Result of the UpdateIntegration operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateIntegrationResponse
```
UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
```
    Updates an IntegrationResponses.
    
    Parameters:
    
    updateIntegrationResponseRequest -
    
    Returns:
    
    Result of the UpdateIntegrationResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateModel
```
UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
```
    Updates a Model.
    
    Parameters:
    
    updateModelRequest -
    
    Returns:
    
    Result of the UpdateModel operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateRoute
```
UpdateRouteResult updateRoute(UpdateRouteRequest updateRouteRequest)
```
    Updates a Route.
    
    Parameters:
    
    updateRouteRequest -
    
    Returns:
    
    Result of the UpdateRoute operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateRouteResponse
```
UpdateRouteResponseResult updateRouteResponse(UpdateRouteResponseRequest updateRouteResponseRequest)
```
    Updates a RouteResponse.
    
    Parameters:
    
    updateRouteResponseRequest -
    
    Returns:
    
    Result of the UpdateRouteResponse operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - updateStage
```
UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
```
    Updates a Stage.
    
    Parameters:
    
    updateStageRequest -
    
    Returns:
    
    Result of the UpdateStage operation returned by the service.
    
    Throws:
    
    NotFoundException - The resource specified in the request was not found.
    
    TooManyRequestsException - The client is sending more than the allowed number of requests per unit of time.
    
    BadRequestException - One of the parameters in the request is invalid.
    
    ConflictException - The resource already exists.
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    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?

Interface AmazonApiGatewayV2

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createApi

createApiMapping

createAuthorizer

createDeployment

createDomainName

createIntegration

createIntegrationResponse

createModel

createRoute

createRouteResponse

createStage

deleteApi

deleteApiMapping

deleteAuthorizer

deleteDeployment

deleteDomainName

deleteIntegration

deleteIntegrationResponse

deleteModel

deleteRoute

deleteRouteResponse

deleteStage

getApi

getApiMapping

getApiMappings

getApis

getAuthorizer

getAuthorizers

getDeployment

getDeployments

getDomainName

getDomainNames

getIntegration

getIntegrationResponse

getIntegrationResponses

getIntegrations

getModel

getModelTemplate

getModels

getRoute

getRouteResponse

getRouteResponses

getRoutes

getStage

getStages

updateApi

updateApiMapping

updateAuthorizer

updateDeployment

updateDomainName

updateIntegration

updateIntegrationResponse

updateModel

updateRoute

updateRouteResponse

updateStage

shutdown

getCachedResponseMetadata