Expand description
Amazon API Gateway V2
If you’re using the service, you’re probably looking for ApiGatewayV2Client and ApiGatewayV2.
Structs§
- Access
LogSettings Settings for logging access in a stage.
- Api
Represents an API.
- ApiGateway
V2Client - A client for the AmazonApiGatewayV2 API.
- ApiMapping
Represents an API mapping.
- Authorizer
Represents an authorizer.
- Cors
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- Create
ApiMapping Request Creates a new ApiMapping resource to represent an API mapping.
- Create
ApiMapping Response - Create
ApiRequest Creates a new Api resource to represent an API.
- Create
ApiResponse - Create
Authorizer Request Creates a new Authorizer resource to represent an authorizer.
- Create
Authorizer Response - Create
Deployment Request Creates a new Deployment resource to represent a deployment.
- Create
Deployment Response - Create
Domain Name Request Creates a new DomainName resource to represent a domain name.
- Create
Domain Name Response - Create
Integration Request Creates a new Integration resource to represent an integration.
- Create
Integration Response Request Creates a new IntegrationResponse resource to represent an integration response.
- Create
Integration Response Response - Create
Integration Result - Create
Model Request Creates a new Model.
- Create
Model Response - Create
Route Request Creates a new Route resource to represent a route.
- Create
Route Response Request Creates a new RouteResponse resource to represent a route response.
- Create
Route Response Response - Create
Route Result - Create
Stage Request Creates a new Stage resource to represent a stage.
- Create
Stage Response - Create
VpcLink Request Creates a VPC link
- Create
VpcLink Response - Delete
Access LogSettings Request - Delete
ApiMapping Request - Delete
ApiRequest - Delete
Authorizer Request - Delete
Cors Configuration Request - Delete
Deployment Request - Delete
Domain Name Request - Delete
Integration Request - Delete
Integration Response Request - Delete
Model Request - Delete
Route Request - Delete
Route Request Parameter Request - Delete
Route Response Request - Delete
Route Settings Request - Delete
Stage Request - Delete
VpcLink Request - Delete
VpcLink Response - Deployment
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
- Domain
Name Represents a domain name.
- Domain
Name Configuration The domain name configuration.
- Export
ApiRequest - Export
ApiResponse - GetApi
Mapping Request - GetApi
Mapping Response - GetApi
Mappings Request - GetApi
Mappings Response - GetApi
Request - GetApi
Response - GetApis
Request - GetApis
Response - GetAuthorizer
Request - GetAuthorizer
Response - GetAuthorizers
Request - GetAuthorizers
Response - GetDeployment
Request - GetDeployment
Response - GetDeployments
Request - GetDeployments
Response - GetDomain
Name Request - GetDomain
Name Response - GetDomain
Names Request - GetDomain
Names Response - GetIntegration
Request - GetIntegration
Response Request - GetIntegration
Response Response - GetIntegration
Responses Request - GetIntegration
Responses Response - GetIntegration
Result - GetIntegrations
Request - GetIntegrations
Response - GetModel
Request - GetModel
Response - GetModel
Template Request - GetModel
Template Response - GetModels
Request - GetModels
Response - GetRoute
Request - GetRoute
Response Request - GetRoute
Response Response - GetRoute
Responses Request - GetRoute
Responses Response - GetRoute
Result - GetRoutes
Request - GetRoutes
Response - GetStage
Request - GetStage
Response - GetStages
Request - GetStages
Response - GetTags
Request - GetTags
Response - GetVpc
Link Request - GetVpc
Link Response - GetVpc
Links Request - GetVpc
Links Response - Import
ApiRequest - Import
ApiResponse - Integration
Represents an integration.
- Integration
Response Represents an integration response.
- JWTConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
- Model
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
- Mutual
TlsAuthentication - Mutual
TlsAuthentication Input - Parameter
Constraints Validation constraints imposed on parameters of a request (path, query string, headers).
- Reimport
ApiRequest - Reimport
ApiResponse - Reset
Authorizers Cache Request - Route
Represents a route.
- Route
Response Represents a route response.
- Route
Settings Represents a collection of route settings.
- Stage
Represents an API stage.
- TagResource
Request Creates a new Tag resource to represent a tag.
- TagResource
Response - TlsConfig
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
- TlsConfig
Input The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
- Untag
Resource Request - Update
ApiMapping Request Updates an ApiMapping.
- Update
ApiMapping Response - Update
ApiRequest Updates an Api.
- Update
ApiResponse - Update
Authorizer Request Updates an Authorizer.
- Update
Authorizer Response - Update
Deployment Request Updates a Deployment.
- Update
Deployment Response - Update
Domain Name Request Updates a DomainName.
- Update
Domain Name Response - Update
Integration Request Updates an Integration.
- Update
Integration Response Request Updates an IntegrationResponses.
- Update
Integration Response Response - Update
Integration Result - Update
Model Request Updates a Model.
- Update
Model Response - Update
Route Request Updates a Route.
- Update
Route Response Request Updates a RouteResponse.
- Update
Route Response Response - Update
Route Result - Update
Stage Request Updates a Stage.
- Update
Stage Response - Update
VpcLink Request Updates a VPC link.
- Update
VpcLink Response - VpcLink
Represents a VPC link.
Enums§
- Create
ApiError - Errors returned by CreateApi
- Create
ApiMapping Error - Errors returned by CreateApiMapping
- Create
Authorizer Error - Errors returned by CreateAuthorizer
- Create
Deployment Error - Errors returned by CreateDeployment
- Create
Domain Name Error - Errors returned by CreateDomainName
- Create
Integration Error - Errors returned by CreateIntegration
- Create
Integration Response Error - Errors returned by CreateIntegrationResponse
- Create
Model Error - Errors returned by CreateModel
- Create
Route Error - Errors returned by CreateRoute
- Create
Route Response Error - Errors returned by CreateRouteResponse
- Create
Stage Error - Errors returned by CreateStage
- Create
VpcLink Error - Errors returned by CreateVpcLink
- Delete
Access LogSettings Error - Errors returned by DeleteAccessLogSettings
- Delete
ApiError - Errors returned by DeleteApi
- Delete
ApiMapping Error - Errors returned by DeleteApiMapping
- Delete
Authorizer Error - Errors returned by DeleteAuthorizer
- Delete
Cors Configuration Error - Errors returned by DeleteCorsConfiguration
- Delete
Deployment Error - Errors returned by DeleteDeployment
- Delete
Domain Name Error - Errors returned by DeleteDomainName
- Delete
Integration Error - Errors returned by DeleteIntegration
- Delete
Integration Response Error - Errors returned by DeleteIntegrationResponse
- Delete
Model Error - Errors returned by DeleteModel
- Delete
Route Error - Errors returned by DeleteRoute
- Delete
Route Request Parameter Error - Errors returned by DeleteRouteRequestParameter
- Delete
Route Response Error - Errors returned by DeleteRouteResponse
- Delete
Route Settings Error - Errors returned by DeleteRouteSettings
- Delete
Stage Error - Errors returned by DeleteStage
- Delete
VpcLink Error - Errors returned by DeleteVpcLink
- Export
ApiError - Errors returned by ExportApi
- GetApi
Error - Errors returned by GetApi
- GetApi
Mapping Error - Errors returned by GetApiMapping
- GetApi
Mappings Error - Errors returned by GetApiMappings
- GetApis
Error - Errors returned by GetApis
- GetAuthorizer
Error - Errors returned by GetAuthorizer
- GetAuthorizers
Error - Errors returned by GetAuthorizers
- GetDeployment
Error - Errors returned by GetDeployment
- GetDeployments
Error - Errors returned by GetDeployments
- GetDomain
Name Error - Errors returned by GetDomainName
- GetDomain
Names Error - Errors returned by GetDomainNames
- GetIntegration
Error - Errors returned by GetIntegration
- GetIntegration
Response Error - Errors returned by GetIntegrationResponse
- GetIntegration
Responses Error - Errors returned by GetIntegrationResponses
- GetIntegrations
Error - Errors returned by GetIntegrations
- GetModel
Error - Errors returned by GetModel
- GetModel
Template Error - Errors returned by GetModelTemplate
- GetModels
Error - Errors returned by GetModels
- GetRoute
Error - Errors returned by GetRoute
- GetRoute
Response Error - Errors returned by GetRouteResponse
- GetRoute
Responses Error - Errors returned by GetRouteResponses
- GetRoutes
Error - Errors returned by GetRoutes
- GetStage
Error - Errors returned by GetStage
- GetStages
Error - Errors returned by GetStages
- GetTags
Error - Errors returned by GetTags
- GetVpc
Link Error - Errors returned by GetVpcLink
- GetVpc
Links Error - Errors returned by GetVpcLinks
- Import
ApiError - Errors returned by ImportApi
- Reimport
ApiError - Errors returned by ReimportApi
- Reset
Authorizers Cache Error - Errors returned by ResetAuthorizersCache
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
ApiError - Errors returned by UpdateApi
- Update
ApiMapping Error - Errors returned by UpdateApiMapping
- Update
Authorizer Error - Errors returned by UpdateAuthorizer
- Update
Deployment Error - Errors returned by UpdateDeployment
- Update
Domain Name Error - Errors returned by UpdateDomainName
- Update
Integration Error - Errors returned by UpdateIntegration
- Update
Integration Response Error - Errors returned by UpdateIntegrationResponse
- Update
Model Error - Errors returned by UpdateModel
- Update
Route Error - Errors returned by UpdateRoute
- Update
Route Response Error - Errors returned by UpdateRouteResponse
- Update
Stage Error - Errors returned by UpdateStage
- Update
VpcLink Error - Errors returned by UpdateVpcLink
Traits§
- ApiGateway
V2 - Trait representing the capabilities of the AmazonApiGatewayV2 API. AmazonApiGatewayV2 clients implement this trait.