Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Access
LogSettings Settings for logging access in a stage.
- Api
Represents an 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.
- 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.
- 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).
- Route
Represents a route.
- Route
Response Represents a route response.
- Route
Settings Represents a collection of route settings.
- Routing
Rule Represents a routing rule.
- Routing
Rule Action The routing rule action.
- Routing
Rule Action Invoke Api Represents an InvokeApi action.
- Routing
Rule Condition Represents a routing rule condition.
- Routing
Rule Match Base Paths Represents a MatchBasePaths condition.
- Routing
Rule Match Header Value Represents a MatchHeaderValue.
- Routing
Rule Match Headers Represents a MatchHeaders condition.
- Stage
Represents an API stage.
- 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.
- VpcLink
Represents a VPC link.
Enums§
- Authorization
Type - When writing a match expression against
AuthorizationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Authorizer
Type - When writing a match expression against
AuthorizerType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Connection
Type - When writing a match expression against
ConnectionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Content
Handling Strategy - When writing a match expression against
ContentHandlingStrategy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deployment
Status - When writing a match expression against
DeploymentStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Domain
Name Status - When writing a match expression against
DomainNameStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Endpoint
Type - When writing a match expression against
EndpointType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Integration
Type - When writing a match expression against
IntegrationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IpAddress
Type - When writing a match expression against
IpAddressType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Logging
Level - When writing a match expression against
LoggingLevel
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Passthrough
Behavior - When writing a match expression against
PassthroughBehavior
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Protocol
Type - When writing a match expression against
ProtocolType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Routing
Mode - When writing a match expression against
RoutingMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Security
Policy - When writing a match expression against
SecurityPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcLink
Status - When writing a match expression against
VpcLinkStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcLink
Version - When writing a match expression against
VpcLinkVersion
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.