@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonApiGatewayV2
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonApiGatewayV2
instead.
Amazon API Gateway V2
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
static final String ENDPOINT_PREFIX
CreateApiResult createApi(CreateApiRequest createApiRequest)
Creates an Api resource.
createApiRequest
- Creates a new Api resource to represent an API.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.CreateApiMappingResult createApiMapping(CreateApiMappingRequest createApiMappingRequest)
Creates an API mapping.
createApiMappingRequest
- Creates a new ApiMapping resource to represent an API mapping.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.CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an Authorizer for an API.
createAuthorizerRequest
- Creates a new Authorizer resource to represent an authorizer.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.CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a Deployment for an API.
createDeploymentRequest
- Creates a new Deployment resource to represent a deployment.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.CreateDomainNameResult createDomainName(CreateDomainNameRequest createDomainNameRequest)
Creates a domain name.
createDomainNameRequest
- Creates a new DomainName resource to represent a domain name.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.AccessDeniedException
- 403 responseCreateIntegrationResult createIntegration(CreateIntegrationRequest createIntegrationRequest)
Creates an Integration.
createIntegrationRequest
- Creates a new Integration resource to represent an integration.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.CreateIntegrationResponseResult createIntegrationResponse(CreateIntegrationResponseRequest createIntegrationResponseRequest)
Creates an IntegrationResponses.
createIntegrationResponseRequest
- Creates a new IntegrationResponse resource to represent an integration response.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.CreateModelResult createModel(CreateModelRequest createModelRequest)
Creates a Model for an API.
createModelRequest
- Creates a new Model.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.CreateRouteResult createRoute(CreateRouteRequest createRouteRequest)
Creates a Route for an API.
createRouteRequest
- Creates a new Route resource to represent a route.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.CreateRouteResponseResult createRouteResponse(CreateRouteResponseRequest createRouteResponseRequest)
Creates a RouteResponse for a Route.
createRouteResponseRequest
- Creates a new RouteResponse resource to represent a route response.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.CreateStageResult createStage(CreateStageRequest createStageRequest)
Creates a Stage for an API.
createStageRequest
- Creates a new Stage resource to represent a stage.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.CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest createVpcLinkRequest)
Creates a VPC link.
createVpcLinkRequest
- Creates a VPC linkBadRequestException
- One of the parameters in the request is invalid.TooManyRequestsException
- The client is sending more than the allowed number of requests per unit of time.DeleteAccessLogSettingsResult deleteAccessLogSettings(DeleteAccessLogSettingsRequest deleteAccessLogSettingsRequest)
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
deleteAccessLogSettingsRequest
- 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.DeleteApiResult deleteApi(DeleteApiRequest deleteApiRequest)
Deletes an Api resource.
deleteApiRequest
- 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.DeleteApiMappingResult deleteApiMapping(DeleteApiMappingRequest deleteApiMappingRequest)
Deletes an API mapping.
deleteApiMappingRequest
- 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.DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an Authorizer.
deleteAuthorizerRequest
- 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.DeleteCorsConfigurationResult deleteCorsConfiguration(DeleteCorsConfigurationRequest deleteCorsConfigurationRequest)
Deletes a CORS configuration.
deleteCorsConfigurationRequest
- 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.DeleteDeploymentResult deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a Deployment.
deleteDeploymentRequest
- 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.DeleteDomainNameResult deleteDomainName(DeleteDomainNameRequest deleteDomainNameRequest)
Deletes a domain name.
deleteDomainNameRequest
- 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.DeleteIntegrationResult deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest)
Deletes an Integration.
deleteIntegrationRequest
- 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.DeleteIntegrationResponseResult deleteIntegrationResponse(DeleteIntegrationResponseRequest deleteIntegrationResponseRequest)
Deletes an IntegrationResponses.
deleteIntegrationResponseRequest
- 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.DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)
Deletes a Model.
deleteModelRequest
- 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.DeleteRouteResult deleteRoute(DeleteRouteRequest deleteRouteRequest)
Deletes a Route.
deleteRouteRequest
- 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.DeleteRouteRequestParameterResult deleteRouteRequestParameter(DeleteRouteRequestParameterRequest deleteRouteRequestParameterRequest)
Deletes a route request parameter.
deleteRouteRequestParameterRequest
- 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.DeleteRouteResponseResult deleteRouteResponse(DeleteRouteResponseRequest deleteRouteResponseRequest)
Deletes a RouteResponse.
deleteRouteResponseRequest
- 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.DeleteRouteSettingsResult deleteRouteSettings(DeleteRouteSettingsRequest deleteRouteSettingsRequest)
Deletes the RouteSettings for a stage.
deleteRouteSettingsRequest
- 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.DeleteStageResult deleteStage(DeleteStageRequest deleteStageRequest)
Deletes a Stage.
deleteStageRequest
- 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.DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)
Deletes a VPC link.
deleteVpcLinkRequest
- 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.ExportApiResult exportApi(ExportApiRequest exportApiRequest)
exportApiRequest
- 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.GetApiResult getApi(GetApiRequest getApiRequest)
Gets an Api resource.
getApiRequest
- 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.GetApiMappingResult getApiMapping(GetApiMappingRequest getApiMappingRequest)
Gets an API mapping.
getApiMappingRequest
- 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.GetApiMappingsResult getApiMappings(GetApiMappingsRequest getApiMappingsRequest)
Gets API mappings.
getApiMappingsRequest
- 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.GetApisResult getApis(GetApisRequest getApisRequest)
Gets a collection of Api resources.
getApisRequest
- 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.GetAuthorizerResult getAuthorizer(GetAuthorizerRequest getAuthorizerRequest)
Gets an Authorizer.
getAuthorizerRequest
- 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.GetAuthorizersResult getAuthorizers(GetAuthorizersRequest getAuthorizersRequest)
Gets the Authorizers for an API.
getAuthorizersRequest
- 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.GetDeploymentResult getDeployment(GetDeploymentRequest getDeploymentRequest)
Gets a Deployment.
getDeploymentRequest
- 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.GetDeploymentsResult getDeployments(GetDeploymentsRequest getDeploymentsRequest)
Gets the Deployments for an API.
getDeploymentsRequest
- 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.GetDomainNameResult getDomainName(GetDomainNameRequest getDomainNameRequest)
Gets a domain name.
getDomainNameRequest
- 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.GetDomainNamesResult getDomainNames(GetDomainNamesRequest getDomainNamesRequest)
Gets the domain names for an AWS account.
getDomainNamesRequest
- 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.GetIntegrationResult getIntegration(GetIntegrationRequest getIntegrationRequest)
Gets an Integration.
getIntegrationRequest
- 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.GetIntegrationResponseResult getIntegrationResponse(GetIntegrationResponseRequest getIntegrationResponseRequest)
Gets an IntegrationResponses.
getIntegrationResponseRequest
- 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.GetIntegrationResponsesResult getIntegrationResponses(GetIntegrationResponsesRequest getIntegrationResponsesRequest)
Gets the IntegrationResponses for an Integration.
getIntegrationResponsesRequest
- 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.GetIntegrationsResult getIntegrations(GetIntegrationsRequest getIntegrationsRequest)
Gets the Integrations for an API.
getIntegrationsRequest
- 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.GetModelResult getModel(GetModelRequest getModelRequest)
Gets a Model.
getModelRequest
- 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.GetModelTemplateResult getModelTemplate(GetModelTemplateRequest getModelTemplateRequest)
Gets a model template.
getModelTemplateRequest
- 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.GetModelsResult getModels(GetModelsRequest getModelsRequest)
Gets the Models for an API.
getModelsRequest
- 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.GetRouteResult getRoute(GetRouteRequest getRouteRequest)
Gets a Route.
getRouteRequest
- 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.GetRouteResponseResult getRouteResponse(GetRouteResponseRequest getRouteResponseRequest)
Gets a RouteResponse.
getRouteResponseRequest
- 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.GetRouteResponsesResult getRouteResponses(GetRouteResponsesRequest getRouteResponsesRequest)
Gets the RouteResponses for a Route.
getRouteResponsesRequest
- 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.GetRoutesResult getRoutes(GetRoutesRequest getRoutesRequest)
Gets the Routes for an API.
getRoutesRequest
- 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.GetStageResult getStage(GetStageRequest getStageRequest)
Gets a Stage.
getStageRequest
- 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.GetStagesResult getStages(GetStagesRequest getStagesRequest)
Gets the Stages for an API.
getStagesRequest
- 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.GetTagsResult getTags(GetTagsRequest getTagsRequest)
Gets a collection of Tag resources.
getTagsRequest
- 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.GetVpcLinkResult getVpcLink(GetVpcLinkRequest getVpcLinkRequest)
Gets a VPC link.
getVpcLinkRequest
- 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.GetVpcLinksResult getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)
Gets a collection of VPC links.
getVpcLinksRequest
- BadRequestException
- One of the parameters in the request is invalid.TooManyRequestsException
- The client is sending more than the allowed number of requests per unit of time.ImportApiResult importApi(ImportApiRequest importApiRequest)
Imports an API.
importApiRequest
- 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.ReimportApiResult reimportApi(ReimportApiRequest reimportApiRequest)
Puts an Api resource.
reimportApiRequest
- 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.ResetAuthorizersCacheResult resetAuthorizersCache(ResetAuthorizersCacheRequest resetAuthorizersCacheRequest)
Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.
resetAuthorizersCacheRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Creates a new Tag resource to represent a tag.
tagResourceRequest
- Creates a new Tag resource to represent a tag.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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes a Tag.
untagResourceRequest
- 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.UpdateApiResult updateApi(UpdateApiRequest updateApiRequest)
Updates an Api resource.
updateApiRequest
- Updates an Api.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.UpdateApiMappingResult updateApiMapping(UpdateApiMappingRequest updateApiMappingRequest)
The API mapping.
updateApiMappingRequest
- Updates an ApiMapping.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.UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an Authorizer.
updateAuthorizerRequest
- Updates an Authorizer.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.UpdateDeploymentResult updateDeployment(UpdateDeploymentRequest updateDeploymentRequest)
Updates a Deployment.
updateDeploymentRequest
- Updates a Deployment.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.UpdateDomainNameResult updateDomainName(UpdateDomainNameRequest updateDomainNameRequest)
Updates a domain name.
updateDomainNameRequest
- Updates a DomainName.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.UpdateIntegrationResult updateIntegration(UpdateIntegrationRequest updateIntegrationRequest)
Updates an Integration.
updateIntegrationRequest
- Updates an Integration.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.UpdateIntegrationResponseResult updateIntegrationResponse(UpdateIntegrationResponseRequest updateIntegrationResponseRequest)
Updates an IntegrationResponses.
updateIntegrationResponseRequest
- Updates an IntegrationResponses.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.UpdateModelResult updateModel(UpdateModelRequest updateModelRequest)
Updates a Model.
updateModelRequest
- Updates a Model.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.UpdateRouteResult updateRoute(UpdateRouteRequest updateRouteRequest)
Updates a Route.
updateRouteRequest
- Updates a Route.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.UpdateRouteResponseResult updateRouteResponse(UpdateRouteResponseRequest updateRouteResponseRequest)
Updates a RouteResponse.
updateRouteResponseRequest
- Updates a RouteResponse.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.UpdateStageResult updateStage(UpdateStageRequest updateStageRequest)
Updates a Stage.
updateStageRequest
- Updates a Stage.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.UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)
Updates a VPC link.
updateVpcLinkRequest
- Updates a VPC link.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.