apigatewayv2/aws.sdk.kotlin.services.apigatewayv2.model

Package-level declarations

Types

AccessDeniedException

class AccessDeniedException : ApiGatewayV2Exception

AccessLogSettings

class AccessLogSettings

Settings for logging access in a stage.

Api

class Api

Represents an API.

ApiGatewayV2Exception

open class ApiGatewayV2Exception : AwsServiceException

Base class for all service related exceptions thrown by the ApiGatewayV2 client

ApiMapping

class ApiMapping

Represents an API mapping.

AuthorizationType

sealed class AuthorizationType

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Authorizer

class Authorizer

Represents an authorizer.

AuthorizerType

sealed class AuthorizerType

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

BadRequestException

class BadRequestException : ApiGatewayV2Exception

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

ConflictException

class ConflictException : ApiGatewayV2Exception

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

ConnectionType

sealed class ConnectionType

Represents a connection type.

ContentHandlingStrategy

sealed class ContentHandlingStrategy

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

Cors

class Cors

Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

CreateApiMappingRequest

class CreateApiMappingRequest

Creates a new ApiMapping resource to represent an API mapping.

CreateApiMappingResponse

class CreateApiMappingResponse

CreateApiRequest

class CreateApiRequest

Creates a new Api resource to represent an API.

CreateApiResponse

class CreateApiResponse

CreateAuthorizerRequest

class CreateAuthorizerRequest

Creates a new Authorizer resource to represent an authorizer.

CreateAuthorizerResponse

class CreateAuthorizerResponse

CreateDeploymentRequest

class CreateDeploymentRequest

Creates a new Deployment resource to represent a deployment.

CreateDeploymentResponse

class CreateDeploymentResponse

CreateDomainNameRequest

class CreateDomainNameRequest

Creates a new DomainName resource to represent a domain name.

CreateDomainNameResponse

class CreateDomainNameResponse

CreateIntegrationRequest

class CreateIntegrationRequest

Creates a new Integration resource to represent an integration.

CreateIntegrationResponse

class CreateIntegrationResponse

CreateIntegrationResponseRequest

class CreateIntegrationResponseRequest

Creates a new IntegrationResponse resource to represent an integration response.

CreateIntegrationResponseResponse

class CreateIntegrationResponseResponse

CreateModelRequest

class CreateModelRequest

Creates a new Model.

CreateModelResponse

class CreateModelResponse

CreateRouteRequest

class CreateRouteRequest

Creates a new Route resource to represent a route.

CreateRouteResponse

class CreateRouteResponse

CreateRouteResponseRequest

class CreateRouteResponseRequest

Creates a new RouteResponse resource to represent a route response.

CreateRouteResponseResponse

class CreateRouteResponseResponse

CreateRoutingRuleRequest

class CreateRoutingRuleRequest

CreateRoutingRuleResponse

class CreateRoutingRuleResponse

CreateStageRequest

class CreateStageRequest

Creates a new Stage resource to represent a stage.

CreateStageResponse

class CreateStageResponse

CreateVpcLinkRequest

class CreateVpcLinkRequest

Creates a VPC link

CreateVpcLinkResponse

class CreateVpcLinkResponse

DeleteAccessLogSettingsRequest

class DeleteAccessLogSettingsRequest

DeleteAccessLogSettingsResponse

class DeleteAccessLogSettingsResponse

DeleteApiMappingRequest

class DeleteApiMappingRequest

DeleteApiMappingResponse

class DeleteApiMappingResponse

DeleteApiRequest

class DeleteApiRequest

DeleteApiResponse

class DeleteApiResponse

DeleteAuthorizerRequest

class DeleteAuthorizerRequest

DeleteAuthorizerResponse

class DeleteAuthorizerResponse

DeleteCorsConfigurationRequest

class DeleteCorsConfigurationRequest

DeleteCorsConfigurationResponse

class DeleteCorsConfigurationResponse

DeleteDeploymentRequest

class DeleteDeploymentRequest

DeleteDeploymentResponse

class DeleteDeploymentResponse

DeleteDomainNameRequest

class DeleteDomainNameRequest

DeleteDomainNameResponse

class DeleteDomainNameResponse

DeleteIntegrationRequest

class DeleteIntegrationRequest

DeleteIntegrationResponse

class DeleteIntegrationResponse

DeleteIntegrationResponseRequest

class DeleteIntegrationResponseRequest

DeleteIntegrationResponseResponse

class DeleteIntegrationResponseResponse

DeleteModelRequest

class DeleteModelRequest

DeleteModelResponse

class DeleteModelResponse

DeleteRouteRequest

class DeleteRouteRequest

DeleteRouteRequestParameterRequest

class DeleteRouteRequestParameterRequest

DeleteRouteRequestParameterResponse

class DeleteRouteRequestParameterResponse

DeleteRouteResponse

class DeleteRouteResponse

DeleteRouteResponseRequest

class DeleteRouteResponseRequest

DeleteRouteResponseResponse

class DeleteRouteResponseResponse

DeleteRouteSettingsRequest

class DeleteRouteSettingsRequest

DeleteRouteSettingsResponse

class DeleteRouteSettingsResponse

DeleteRoutingRuleRequest

class DeleteRoutingRuleRequest

DeleteRoutingRuleResponse

class DeleteRoutingRuleResponse

DeleteStageRequest

class DeleteStageRequest

DeleteStageResponse

class DeleteStageResponse

DeleteVpcLinkRequest

class DeleteVpcLinkRequest

DeleteVpcLinkResponse

class DeleteVpcLinkResponse

Deployment

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

DeploymentStatus

sealed class DeploymentStatus

Represents a deployment status.

DomainName

class DomainName

Represents a domain name.

DomainNameConfiguration

class DomainNameConfiguration

The domain name configuration.

DomainNameStatus

sealed class DomainNameStatus

The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

EndpointType

sealed class EndpointType

Represents an endpoint type.

ExportApiRequest

class ExportApiRequest

ExportApiResponse

class ExportApiResponse

GetApiMappingRequest

class GetApiMappingRequest

GetApiMappingResponse

class GetApiMappingResponse

GetApiMappingsRequest

class GetApiMappingsRequest

GetApiMappingsResponse

class GetApiMappingsResponse

class GetApiRequest

class GetApiResponse

class GetApisRequest

class GetApisResponse

GetAuthorizerRequest

class GetAuthorizerRequest

GetAuthorizerResponse

class GetAuthorizerResponse

GetAuthorizersRequest

class GetAuthorizersRequest

GetAuthorizersResponse

class GetAuthorizersResponse

GetDeploymentRequest

class GetDeploymentRequest

GetDeploymentResponse

class GetDeploymentResponse

GetDeploymentsRequest

class GetDeploymentsRequest

GetDeploymentsResponse

class GetDeploymentsResponse

GetDomainNameRequest

class GetDomainNameRequest

GetDomainNameResponse

class GetDomainNameResponse

GetDomainNamesRequest

class GetDomainNamesRequest

GetDomainNamesResponse

class GetDomainNamesResponse

GetIntegrationRequest

class GetIntegrationRequest

GetIntegrationResponse

class GetIntegrationResponse

GetIntegrationResponseRequest

class GetIntegrationResponseRequest

GetIntegrationResponseResponse

class GetIntegrationResponseResponse

GetIntegrationResponsesRequest

class GetIntegrationResponsesRequest

GetIntegrationResponsesResponse

class GetIntegrationResponsesResponse

GetIntegrationsRequest

class GetIntegrationsRequest

GetIntegrationsResponse

class GetIntegrationsResponse

GetModelRequest

class GetModelRequest

GetModelResponse

class GetModelResponse

GetModelsRequest

class GetModelsRequest

GetModelsResponse

class GetModelsResponse

GetModelTemplateRequest

class GetModelTemplateRequest

GetModelTemplateResponse

class GetModelTemplateResponse

GetRouteRequest

class GetRouteRequest

GetRouteResponse

class GetRouteResponse

GetRouteResponseRequest

class GetRouteResponseRequest

GetRouteResponseResponse

class GetRouteResponseResponse

GetRouteResponsesRequest

class GetRouteResponsesRequest

GetRouteResponsesResponse

class GetRouteResponsesResponse

GetRoutesRequest

class GetRoutesRequest

GetRoutesResponse

class GetRoutesResponse

GetRoutingRuleRequest

class GetRoutingRuleRequest

GetRoutingRuleResponse

class GetRoutingRuleResponse

GetStageRequest

class GetStageRequest

GetStageResponse

class GetStageResponse

GetStagesRequest

class GetStagesRequest

GetStagesResponse

class GetStagesResponse

GetTagsRequest

class GetTagsRequest

GetTagsResponse

class GetTagsResponse

GetVpcLinkRequest

class GetVpcLinkRequest

GetVpcLinkResponse

class GetVpcLinkResponse

GetVpcLinksRequest

class GetVpcLinksRequest

GetVpcLinksResponse

class GetVpcLinksResponse

ImportApiRequest

class ImportApiRequest

ImportApiResponse

class ImportApiResponse

Integration

class Integration

Represents an integration.

IntegrationResponse

class IntegrationResponse

Represents an integration response.

IntegrationType

sealed class IntegrationType

Represents an API method integration type.

IpAddressType

sealed class IpAddressType

The IP address types that can invoke your API or domain name.

JwtConfiguration

class JwtConfiguration

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

ListRoutingRulesRequest

class ListRoutingRulesRequest

ListRoutingRulesResponse

class ListRoutingRulesResponse

LoggingLevel

sealed class LoggingLevel

The logging level.

Model

class Model

Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.

MutualTlsAuthentication

class MutualTlsAuthentication

MutualTlsAuthenticationInput

class MutualTlsAuthenticationInput

NotFoundException

class NotFoundException : ApiGatewayV2Exception

The resource specified in the request was not found. See the message field for more information.

ParameterConstraints

class ParameterConstraints

Validation constraints imposed on parameters of a request (path, query string, headers).

PassthroughBehavior

sealed class PassthroughBehavior

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

ProtocolType

sealed class ProtocolType

Represents a protocol type.

PutRoutingRuleRequest

class PutRoutingRuleRequest

PutRoutingRuleResponse

class PutRoutingRuleResponse

ReimportApiRequest

class ReimportApiRequest

ReimportApiResponse

class ReimportApiResponse

ResetAuthorizersCacheRequest

class ResetAuthorizersCacheRequest

ResetAuthorizersCacheResponse

class ResetAuthorizersCacheResponse

Route

class Route

Represents a route.

RouteResponse

class RouteResponse

Represents a route response.

RouteSettings

class RouteSettings

Represents a collection of route settings.

RoutingMode

sealed class RoutingMode

RoutingRule

class RoutingRule

Represents a routing rule.

RoutingRuleAction

class RoutingRuleAction

The routing rule action.

RoutingRuleActionInvokeApi

class RoutingRuleActionInvokeApi

Represents an InvokeApi action.

RoutingRuleCondition

class RoutingRuleCondition

Represents a routing rule condition.

RoutingRuleMatchBasePaths

class RoutingRuleMatchBasePaths

Represents a MatchBasePaths condition.

RoutingRuleMatchHeaders

class RoutingRuleMatchHeaders

Represents a MatchHeaders condition.

RoutingRuleMatchHeaderValue

class RoutingRuleMatchHeaderValue

Represents a MatchHeaderValue.

SecurityPolicy

sealed class SecurityPolicy

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

Stage

class Stage

Represents an API stage.

TagResourceRequest

class TagResourceRequest

Creates a new Tag resource to represent a tag.

TagResourceResponse

class TagResourceResponse

TlsConfig

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

TlsConfigInput

class TlsConfigInput

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.

TooManyRequestsException

class TooManyRequestsException : ApiGatewayV2Exception

A limit has been exceeded. See the accompanying error message for details.

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateApiMappingRequest

class UpdateApiMappingRequest

Updates an ApiMapping.

UpdateApiMappingResponse

class UpdateApiMappingResponse