All Known Subinterfaces:

AmazonApiGatewayV2Async

All Known Implementing Classes:

AbstractAmazonApiGatewayV2, AbstractAmazonApiGatewayV2Async, AmazonApiGatewayV2AsyncClient, AmazonApiGatewayV2Client

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApiGatewayV2

• Field Summary

  Fields

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

• Method Summary

  All 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.
  CreateVpcLinkResult	createVpcLink (CreateVpcLinkRequest createVpcLinkRequest) Creates a VPC link.
  DeleteAccessLogSettingsResult	deleteAccessLogSettings (DeleteAccessLogSettingsRequest deleteAccessLogSettingsRequest) Deletes the AccessLogSettings for a Stage.
  DeleteApiResult	deleteApi (DeleteApiRequest deleteApiRequest) Deletes an Api resource.
  DeleteApiMappingResult	deleteApiMapping (DeleteApiMappingRequest deleteApiMappingRequest) Deletes an API mapping.
  DeleteAuthorizerResult	deleteAuthorizer (DeleteAuthorizerRequest deleteAuthorizerRequest) Deletes an Authorizer.
  DeleteCorsConfigurationResult	deleteCorsConfiguration (DeleteCorsConfigurationRequest deleteCorsConfigurationRequest) Deletes a CORS configuration.
  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.
  DeleteRouteRequestParameterResult	deleteRouteRequestParameter (DeleteRouteRequestParameterRequest deleteRouteRequestParameterRequest) Deletes a route request parameter.
  DeleteRouteResponseResult	deleteRouteResponse (DeleteRouteResponseRequest deleteRouteResponseRequest) Deletes a RouteResponse.
  DeleteRouteSettingsResult	deleteRouteSettings (DeleteRouteSettingsRequest deleteRouteSettingsRequest) Deletes the RouteSettings for a stage.
  DeleteStageResult	deleteStage (DeleteStageRequest deleteStageRequest) Deletes a Stage.
  DeleteVpcLinkResult	deleteVpcLink (DeleteVpcLinkRequest deleteVpcLinkRequest) Deletes a VPC link.
  ExportApiResult	exportApi (ExportApiRequest exportApiRequest)
  GetApiResult	getApi (GetApiRequest getApiRequest) Gets an Api resource.
  GetApiMappingResult	getApiMapping (GetApiMappingRequest getApiMappingRequest) Gets an API mapping.
  GetApiMappingsResult	getApiMappings (GetApiMappingsRequest getApiMappingsRequest) Gets 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.
  GetTagsResult	getTags (GetTagsRequest getTagsRequest) Gets a collection of Tag resources.
  GetVpcLinkResult	getVpcLink (GetVpcLinkRequest getVpcLinkRequest) Gets a VPC link.
  GetVpcLinksResult	getVpcLinks (GetVpcLinksRequest getVpcLinksRequest) Gets a collection of VPC links.
  ImportApiResult	importApi (ImportApiRequest importApiRequest) Imports an API.
  ReimportApiResult	reimportApi (ReimportApiRequest reimportApiRequest) Puts an Api resource.
  ResetAuthorizersCacheResult	resetAuthorizersCache (ResetAuthorizersCacheRequest resetAuthorizersCacheRequest) Resets all authorizer cache entries on a stage.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.
  TagResourceResult	tagResource (TagResourceRequest tagResourceRequest) Creates a new Tag resource to represent a tag.
  UntagResourceResult	untagResource (UntagResourceRequest untagResourceRequest) Deletes a Tag.
  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.
  UpdateVpcLinkResult	updateVpcLink (UpdateVpcLinkRequest updateVpcLinkRequest) Updates a VPC link.

• 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 - Creates a new Api resource to represent an API.

    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 - Creates a new ApiMapping resource to represent an API mapping.

    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 - Creates a new Authorizer resource to represent an authorizer.

    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 - Creates a new Deployment resource to represent a deployment.

    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 - Creates a new DomainName resource to represent a domain name.

    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.

    AccessDeniedException - 403 response

  • createIntegration

    CreateIntegrationResult createIntegration(CreateIntegrationRequest createIntegrationRequest)

    Creates an Integration.

    Parameters:

    createIntegrationRequest - Creates a new Integration resource to represent an integration.

    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 - Creates a new IntegrationResponse resource to represent an integration response.

    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 - Creates a new Model.

    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 - Creates a new Route resource to represent a route.

    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 - Creates a new RouteResponse resource to represent a route response.

    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 - Creates a new Stage resource to represent a stage.

    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.

  • createVpcLink

    CreateVpcLinkResult createVpcLink(CreateVpcLinkRequest createVpcLinkRequest)

    Creates a VPC link.

    Parameters:

    createVpcLinkRequest - Creates a VPC link

    Returns:

    Result of the CreateVpcLink operation returned by the service.

    Throws:

    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.

  • deleteAccessLogSettings

    DeleteAccessLogSettingsResult deleteAccessLogSettings(DeleteAccessLogSettingsRequest deleteAccessLogSettingsRequest)

    Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

    Parameters:

    deleteAccessLogSettingsRequest -

    Returns:

    Result of the DeleteAccessLogSettings 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.

  • 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.

  • deleteCorsConfiguration

    DeleteCorsConfigurationResult deleteCorsConfiguration(DeleteCorsConfigurationRequest deleteCorsConfigurationRequest)

    Deletes a CORS configuration.

    Parameters:

    deleteCorsConfigurationRequest -

    Returns:

    Result of the DeleteCorsConfiguration 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.

  • deleteRouteRequestParameter

    DeleteRouteRequestParameterResult deleteRouteRequestParameter(DeleteRouteRequestParameterRequest deleteRouteRequestParameterRequest)

    Deletes a route request parameter. Supported only for WebSocket APIs.

    Parameters:

    deleteRouteRequestParameterRequest -

    Returns:

    Result of the DeleteRouteRequestParameter 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.

  • deleteRouteSettings

    DeleteRouteSettingsResult deleteRouteSettings(DeleteRouteSettingsRequest deleteRouteSettingsRequest)

    Deletes the RouteSettings for a stage.

    Parameters:

    deleteRouteSettingsRequest -

    Returns:

    Result of the DeleteRouteSettings 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.

  • deleteVpcLink

    DeleteVpcLinkResult deleteVpcLink(DeleteVpcLinkRequest deleteVpcLinkRequest)

    Deletes a VPC link.

    Parameters:

    deleteVpcLinkRequest -

    Returns:

    Result of the DeleteVpcLink 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.

  • exportApi

    ExportApiResult exportApi(ExportApiRequest exportApiRequest)

    Parameters:

    exportApiRequest -

    Returns:

    Result of the ExportApi 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.

  • 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)

    Gets an 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)

    Gets 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.

  • getTags

    GetTagsResult getTags(GetTagsRequest getTagsRequest)

    Gets a collection of Tag resources.

    Parameters:

    getTagsRequest -

    Returns:

    Result of the GetTags 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.

  • getVpcLink

    GetVpcLinkResult getVpcLink(GetVpcLinkRequest getVpcLinkRequest)

    Gets a VPC link.

    Parameters:

    getVpcLinkRequest -

    Returns:

    Result of the GetVpcLink 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.

  • getVpcLinks

    GetVpcLinksResult getVpcLinks(GetVpcLinksRequest getVpcLinksRequest)

    Gets a collection of VPC links.

    Parameters:

    getVpcLinksRequest -

    Returns:

    Result of the GetVpcLinks operation returned by the service.

    Throws:

    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.

  • importApi

    ImportApiResult importApi(ImportApiRequest importApiRequest)

    Imports an API.

    Parameters:

    importApiRequest -

    Returns:

    Result of the ImportApi 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.

  • reimportApi

    ReimportApiResult reimportApi(ReimportApiRequest reimportApiRequest)

    Puts an Api resource.

    Parameters:

    reimportApiRequest -

    Returns:

    Result of the ReimportApi 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.

  • resetAuthorizersCache

    ResetAuthorizersCacheResult resetAuthorizersCache(ResetAuthorizersCacheRequest resetAuthorizersCacheRequest)

    Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

    Parameters:

    resetAuthorizersCacheRequest -

    Returns:

    Result of the ResetAuthorizersCache 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.

  • tagResource

    TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

    Creates a new Tag resource to represent a tag.

    Parameters:

    tagResourceRequest - Creates a new Tag resource to represent a tag.

    Returns:

    Result of the TagResource 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.

  • untagResource

    UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

    Deletes a Tag.

    Parameters:

    untagResourceRequest -

    Returns:

    Result of the UntagResource 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.

  • updateApi

    UpdateApiResult updateApi(UpdateApiRequest updateApiRequest)

    Updates an Api resource.

    Parameters:

    updateApiRequest - Updates an Api.

    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 - Updates an ApiMapping.

    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 - Updates an Authorizer.

    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 - Updates a Deployment.

    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 - Updates a DomainName.

    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 - Updates an Integration.

    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 - Updates an IntegrationResponses.

    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 - Updates a Model.

    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 - Updates a Route.

    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 - Updates a RouteResponse.

    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 - Updates a Stage.

    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.

  • updateVpcLink

    UpdateVpcLinkResult updateVpcLink(UpdateVpcLinkRequest updateVpcLinkRequest)

    Updates a VPC link.

    Parameters:

    updateVpcLinkRequest - Updates a VPC link.

    Returns:

    Result of the UpdateVpcLink 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.

  • 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.