Skip to content

Apigatewayv2 Classes

AccessLogSettings

DestinationArn

  • Type: typing.Optional[str]

Format

  • Type: typing.Optional[str]

Api

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

ApiEndpoint

  • Type: typing.Optional[str]

ApiGatewayManaged

  • Type: typing.Optional[bool]

ApiId

  • Type: typing.Optional[str]

ApiKeySelectionExpression

  • Type: typing.Optional[str]

CorsConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.CorsOutput]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

Description

  • Type: typing.Optional[str]

DisableSchemaValidation

  • Type: typing.Optional[bool]

DisableExecuteApiEndpoint

  • Type: typing.Optional[bool]

ImportInfo

  • Type: typing.Optional[typing.List[str]]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

Version

  • Type: typing.Optional[str]

Warnings

  • Type: typing.Optional[typing.List[str]]

ApiMapping

ApiId

  • Type:
  • Required: Yes

Stage

  • Type:
  • Required: Yes

ApiMappingId

  • Type: typing.Optional[str]

ApiMappingKey

  • Type: typing.Optional[str]

Authorizer

Name

  • Type:
  • Required: Yes

AuthorizerCredentialsArn

  • Type: typing.Optional[str]

AuthorizerId

  • Type: typing.Optional[str]

AuthorizerPayloadFormatVersion

  • Type: typing.Optional[str]

AuthorizerResultTtlInSeconds

  • Type: typing.Optional[int]

AuthorizerType

  • Type: typing.Optional[typing.Literal['JWT', 'REQUEST']]

AuthorizerUri

  • Type: typing.Optional[str]

EnableSimpleResponses

  • Type: typing.Optional[bool]

IdentitySource

  • Type: typing.Optional[typing.List[str]]

IdentityValidationExpression

  • Type: typing.Optional[str]

JwtConfiguration

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.JWTConfigurationOutput]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

Cors

AllowCredentials

  • Type: typing.Optional[bool]

AllowHeaders

  • Type: typing.Optional[typing.List[str]]

AllowMethods

  • Type: typing.Optional[typing.List[str]]

AllowOrigins

  • Type: typing.Optional[typing.List[str]]

ExposeHeaders

  • Type: typing.Optional[typing.List[str]]

MaxAge

  • Type: typing.Optional[int]

CorsOutput

AllowCredentials

  • Type: typing.Optional[bool]

AllowHeaders

  • Type: typing.Optional[typing.List[str]]

AllowMethods

  • Type: typing.Optional[typing.List[str]]

AllowOrigins

  • Type: typing.Optional[typing.List[str]]

ExposeHeaders

  • Type: typing.Optional[typing.List[str]]

MaxAge

  • Type: typing.Optional[int]

CreateApiMappingRequest

ApiId

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

Stage

  • Type:
  • Required: Yes

ApiMappingKey

  • Type: typing.Optional[str]

CreateApiMappingResponse

ApiId

  • Type:
  • Required: Yes

ApiMappingId

  • Type:
  • Required: Yes

ApiMappingKey

  • Type:
  • Required: Yes

Stage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateApiRequest

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

ApiKeySelectionExpression

  • Type: typing.Optional[str]

CorsConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Cors, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.CorsOutput, NoneType]

CredentialsArn

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

DisableSchemaValidation

  • Type: typing.Optional[bool]

DisableExecuteApiEndpoint

  • Type: typing.Optional[bool]

RouteKey

  • Type: typing.Optional[str]

RouteSelectionExpression

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

Target

  • Type: typing.Optional[str]

Version

  • Type: typing.Optional[str]

CreateApiResponse

ApiEndpoint

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type:
  • Required: Yes

CorsConfiguration

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

DisableSchemaValidation

  • Type:
  • Required: Yes

DisableExecuteApiEndpoint

  • Type:
  • Required: Yes

ImportInfo

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Version

  • Type:
  • Required: Yes

Warnings

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAuthorizerRequest

ApiId

  • Type:
  • Required: Yes

AuthorizerType

  • Type: typing.Literal['JWT', 'REQUEST']
  • Required: Yes

IdentitySource

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

AuthorizerCredentialsArn

  • Type: typing.Optional[str]

AuthorizerPayloadFormatVersion

  • Type: typing.Optional[str]

AuthorizerResultTtlInSeconds

  • Type: typing.Optional[int]

AuthorizerUri

  • Type: typing.Optional[str]

EnableSimpleResponses

  • Type: typing.Optional[bool]

IdentityValidationExpression

  • Type: typing.Optional[str]

JwtConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.JWTConfiguration, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.JWTConfigurationOutput, NoneType]

CreateAuthorizerResponse

AuthorizerCredentialsArn

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

AuthorizerPayloadFormatVersion

  • Type:
  • Required: Yes

AuthorizerResultTtlInSeconds

  • Type:
  • Required: Yes

AuthorizerType

  • Type: typing.Literal['JWT', 'REQUEST']
  • Required: Yes

AuthorizerUri

  • Type:
  • Required: Yes

EnableSimpleResponses

  • Type:
  • Required: Yes

IdentitySource

  • Type: typing.List[str]
  • Required: Yes

IdentityValidationExpression

  • Type:
  • Required: Yes

JwtConfiguration

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDeploymentRequest

ApiId

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

StageName

  • Type: typing.Optional[str]

CreateDeploymentResponse

AutoDeployed

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

DeploymentStatus

  • Type: typing.Literal['DEPLOYED', 'FAILED', 'PENDING']
  • Required: Yes

DeploymentStatusMessage

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDomainNameRequest

DomainName

  • Type:
  • Required: Yes

DomainNameConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfiguration, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]]]

MutualTlsAuthentication

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.MutualTlsAuthenticationInput]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateDomainNameResponse

ApiMappingSelectionExpression

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

DomainNameConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]
  • Required: Yes

MutualTlsAuthentication

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIntegrationRequest

ApiId

  • Type:
  • Required: Yes

IntegrationType

  • Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
  • Required: Yes

ConnectionId

  • Type: typing.Optional[str]

ConnectionType

  • Type: typing.Optional[typing.Literal['INTERNET', 'VPC_LINK']]

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

CredentialsArn

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

IntegrationMethod

  • Type: typing.Optional[str]

IntegrationSubtype

  • Type: typing.Optional[str]

IntegrationUri

  • Type: typing.Optional[str]

PassthroughBehavior

  • Type: typing.Optional[typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']]

PayloadFormatVersion

  • Type: typing.Optional[str]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, str]]

RequestTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, str]]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

TimeoutInMillis

  • Type: typing.Optional[int]

TlsConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.TlsConfigInput]

CreateIntegrationResponseRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationResponseKey

  • Type:
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

CreateIntegrationResponseResponse

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

IntegrationResponseKey

  • Type:
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateIntegrationResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ConnectionId

  • Type:
  • Required: Yes

ConnectionType

  • Type: typing.Literal['INTERNET', 'VPC_LINK']
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

CredentialsArn

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationMethod

  • Type:
  • Required: Yes

IntegrationResponseSelectionExpression

  • Type:
  • Required: Yes

IntegrationSubtype

  • Type:
  • Required: Yes

IntegrationType

  • Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
  • Required: Yes

IntegrationUri

  • Type:
  • Required: Yes

PassthroughBehavior

  • Type: typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']
  • Required: Yes

PayloadFormatVersion

  • Type:
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, typing.Dict[str, str]]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

TimeoutInMillis

  • Type:
  • Required: Yes

TlsConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateModelRequest

ApiId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Schema

  • Type:
  • Required: Yes

ContentType

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

CreateModelResponse

ContentType

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Schema

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateRouteRequest

ApiId

  • Type:
  • Required: Yes

RouteKey

  • Type:
  • Required: Yes

ApiKeyRequired

  • Type: typing.Optional[bool]

AuthorizationScopes

  • Type: typing.Optional[typing.List[str]]

AuthorizationType

  • Type: typing.Optional[typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']]

AuthorizerId

  • Type: typing.Optional[str]

ModelSelectionExpression

  • Type: typing.Optional[str]

OperationName

  • Type: typing.Optional[str]

RequestModels

  • Type: typing.Optional[typing.Dict[str, str]]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

RouteResponseSelectionExpression

  • Type: typing.Optional[str]

Target

  • Type: typing.Optional[str]

CreateRouteResponseRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteResponseKey

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type: typing.Optional[str]

ResponseModels

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

CreateRouteResponseResponse

ModelSelectionExpression

  • Type:
  • Required: Yes

ResponseModels

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

RouteResponseKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateRouteResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiKeyRequired

  • Type:
  • Required: Yes

AuthorizationScopes

  • Type: typing.List[str]
  • Required: Yes

AuthorizationType

  • Type: typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type:
  • Required: Yes

OperationName

  • Type:
  • Required: Yes

RequestModels

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteKey

  • Type:
  • Required: Yes

RouteResponseSelectionExpression

  • Type:
  • Required: Yes

Target

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateStageRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

AccessLogSettings

  • Type:

AutoDeploy

  • Type: typing.Optional[bool]

ClientCertificateId

  • Type: typing.Optional[str]

DefaultRouteSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]

DeploymentId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

RouteSettings

  • Type: typing.Optional[typing.Dict[str, NoneType]]

StageVariables

  • Type: typing.Optional[typing.Dict[str, str]]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateStageResponse

AccessLogSettings

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

AutoDeploy

  • Type:
  • Required: Yes

ClientCertificateId

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DefaultRouteSettings

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

LastDeploymentStatusMessage

  • Type:
  • Required: Yes

LastUpdatedDate

  • Type:
  • Required: Yes

RouteSettings

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]
  • Required: Yes

StageName

  • Type:
  • Required: Yes

StageVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateVpcLinkRequest

Name

  • Type:
  • Required: Yes

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

SecurityGroupIds

  • Type: typing.Optional[typing.List[str]]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateVpcLinkResponse

CreatedDate

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

SecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

VpcLinkId

  • Type:
  • Required: Yes

VpcLinkStatus

  • Type: typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'INACTIVE', 'PENDING']
  • Required: Yes

VpcLinkStatusMessage

  • Type:
  • Required: Yes

VpcLinkVersion

  • Type: typing.Literal['V2']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAccessLogSettingsRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

DeleteApiMappingRequest

ApiMappingId

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

DeleteApiRequest

ApiId

  • Type:
  • Required: Yes

DeleteAuthorizerRequest

ApiId

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

DeleteCorsConfigurationRequest

ApiId

  • Type:
  • Required: Yes

DeleteDeploymentRequest

ApiId

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

DeleteDomainNameRequest

DomainName

  • Type:
  • Required: Yes

DeleteIntegrationRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

DeleteIntegrationResponseRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

DeleteModelRequest

ApiId

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

DeleteRouteRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

DeleteRouteRequestParameterRequest

ApiId

  • Type:
  • Required: Yes

RequestParameterKey

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

DeleteRouteResponseRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

DeleteRouteSettingsRequest

ApiId

  • Type:
  • Required: Yes

RouteKey

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

DeleteStageRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

DeleteVpcLinkRequest

VpcLinkId

  • Type:
  • Required: Yes

Deployment

AutoDeployed

  • Type: typing.Optional[bool]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

DeploymentId

  • Type: typing.Optional[str]

DeploymentStatus

  • Type: typing.Optional[typing.Literal['DEPLOYED', 'FAILED', 'PENDING']]

DeploymentStatusMessage

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

DomainName

DomainName

  • Type:
  • Required: Yes

ApiMappingSelectionExpression

  • Type: typing.Optional[str]

DomainNameConfigurations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]]

MutualTlsAuthentication

  • Type:

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

DomainNameConfiguration

ApiGatewayDomainName

  • Type: typing.Optional[str]

CertificateArn

  • Type: typing.Optional[str]

CertificateName

  • Type: typing.Optional[str]

CertificateUploadDate

  • Type: typing.Union[datetime.datetime, str, NoneType]

DomainNameStatus

  • Type: typing.Optional[typing.Literal['AVAILABLE', 'PENDING_CERTIFICATE_REIMPORT', 'PENDING_OWNERSHIP_VERIFICATION', 'UPDATING']]

DomainNameStatusMessage

  • Type: typing.Optional[str]

EndpointType

  • Type: typing.Optional[typing.Literal['EDGE', 'REGIONAL']]

HostedZoneId

  • Type: typing.Optional[str]

SecurityPolicy

  • Type: typing.Optional[typing.Literal['TLS_1_0', 'TLS_1_2']]

OwnershipVerificationCertificateArn

  • Type: typing.Optional[str]

DomainNameConfigurationOutput

ApiGatewayDomainName

  • Type: typing.Optional[str]

CertificateArn

  • Type: typing.Optional[str]

CertificateName

  • Type: typing.Optional[str]

CertificateUploadDate

  • Type: typing.Optional[datetime.datetime]

DomainNameStatus

  • Type: typing.Optional[typing.Literal['AVAILABLE', 'PENDING_CERTIFICATE_REIMPORT', 'PENDING_OWNERSHIP_VERIFICATION', 'UPDATING']]

DomainNameStatusMessage

  • Type: typing.Optional[str]

EndpointType

  • Type: typing.Optional[typing.Literal['EDGE', 'REGIONAL']]

HostedZoneId

  • Type: typing.Optional[str]

SecurityPolicy

  • Type: typing.Optional[typing.Literal['TLS_1_0', 'TLS_1_2']]

OwnershipVerificationCertificateArn

  • Type: typing.Optional[str]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

ExportApiRequest

ApiId

  • Type:
  • Required: Yes

OutputType

  • Type: typing.Literal['JSON', 'YAML']
  • Required: Yes

Specification

  • Type: typing.Literal['OAS30']
  • Required: Yes

ExportVersion

  • Type: typing.Optional[str]

IncludeExtensions

  • Type: typing.Optional[bool]

StageName

  • Type: typing.Optional[str]

ExportApiResponse

body

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetApiMappingRequest

ApiMappingId

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

GetApiMappingResponse

ApiId

  • Type:
  • Required: Yes

ApiMappingId

  • Type:
  • Required: Yes

ApiMappingKey

  • Type:
  • Required: Yes

Stage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetApiMappingsRequest

DomainName

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetApiMappingsResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ApiMapping]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetApiRequest

ApiId

  • Type:
  • Required: Yes

GetApiResponse

ApiEndpoint

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type:
  • Required: Yes

CorsConfiguration

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

DisableSchemaValidation

  • Type:
  • Required: Yes

DisableExecuteApiEndpoint

  • Type:
  • Required: Yes

ImportInfo

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Version

  • Type:
  • Required: Yes

Warnings

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetApisRequest

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetApisRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetApisResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Api]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetAuthorizerRequest

ApiId

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

GetAuthorizerResponse

AuthorizerCredentialsArn

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

AuthorizerPayloadFormatVersion

  • Type:
  • Required: Yes

AuthorizerResultTtlInSeconds

  • Type:
  • Required: Yes

AuthorizerType

  • Type: typing.Literal['JWT', 'REQUEST']
  • Required: Yes

AuthorizerUri

  • Type:
  • Required: Yes

EnableSimpleResponses

  • Type:
  • Required: Yes

IdentitySource

  • Type: typing.List[str]
  • Required: Yes

IdentityValidationExpression

  • Type:
  • Required: Yes

JwtConfiguration

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAuthorizersRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetAuthorizersRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetAuthorizersResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Authorizer]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetDeploymentRequest

ApiId

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

GetDeploymentResponse

AutoDeployed

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

DeploymentStatus

  • Type: typing.Literal['DEPLOYED', 'FAILED', 'PENDING']
  • Required: Yes

DeploymentStatusMessage

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDeploymentsRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetDeploymentsRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetDeploymentsResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Deployment]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetDomainNameRequest

DomainName

  • Type:
  • Required: Yes

GetDomainNameResponse

ApiMappingSelectionExpression

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

DomainNameConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]
  • Required: Yes

MutualTlsAuthentication

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetDomainNamesRequest

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetDomainNamesRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetDomainNamesResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainName]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetIntegrationRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

GetIntegrationResponseRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

GetIntegrationResponseResponse

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

IntegrationResponseKey

  • Type:
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIntegrationResponsesRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetIntegrationResponsesRequestPaginate

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetIntegrationResponsesResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.IntegrationResponse]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetIntegrationResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ConnectionId

  • Type:
  • Required: Yes

ConnectionType

  • Type: typing.Literal['INTERNET', 'VPC_LINK']
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

CredentialsArn

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationMethod

  • Type:
  • Required: Yes

IntegrationResponseSelectionExpression

  • Type:
  • Required: Yes

IntegrationSubtype

  • Type:
  • Required: Yes

IntegrationType

  • Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
  • Required: Yes

IntegrationUri

  • Type:
  • Required: Yes

PassthroughBehavior

  • Type: typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']
  • Required: Yes

PayloadFormatVersion

  • Type:
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, typing.Dict[str, str]]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

TimeoutInMillis

  • Type:
  • Required: Yes

TlsConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetIntegrationsRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetIntegrationsRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetIntegrationsResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Integration]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetModelRequest

ApiId

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

GetModelResponse

ContentType

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Schema

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetModelTemplateRequest

ApiId

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

GetModelTemplateResponse

Value

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetModelsRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetModelsRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetModelsResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Model]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetRouteRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

GetRouteResponseRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

GetRouteResponseResponse

ModelSelectionExpression

  • Type:
  • Required: Yes

ResponseModels

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

RouteResponseKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRouteResponsesRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetRouteResponsesRequestPaginate

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetRouteResponsesResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteResponse]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetRouteResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiKeyRequired

  • Type:
  • Required: Yes

AuthorizationScopes

  • Type: typing.List[str]
  • Required: Yes

AuthorizationType

  • Type: typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type:
  • Required: Yes

OperationName

  • Type:
  • Required: Yes

RequestModels

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteKey

  • Type:
  • Required: Yes

RouteResponseSelectionExpression

  • Type:
  • Required: Yes

Target

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRoutesRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetRoutesRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetRoutesResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Route]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetStageRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

GetStageResponse

AccessLogSettings

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

AutoDeploy

  • Type:
  • Required: Yes

ClientCertificateId

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DefaultRouteSettings

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

LastDeploymentStatusMessage

  • Type:
  • Required: Yes

LastUpdatedDate

  • Type:
  • Required: Yes

RouteSettings

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]
  • Required: Yes

StageName

  • Type:
  • Required: Yes

StageVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetStagesRequest

ApiId

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetStagesRequestPaginate

ApiId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.PaginatorConfig]

GetStagesResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Stage]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

GetTagsRequest

ResourceArn

  • Type:
  • Required: Yes

GetTagsResponse

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetVpcLinkRequest

VpcLinkId

  • Type:
  • Required: Yes

GetVpcLinkResponse

CreatedDate

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

SecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

VpcLinkId

  • Type:
  • Required: Yes

VpcLinkStatus

  • Type: typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'INACTIVE', 'PENDING']
  • Required: Yes

VpcLinkStatusMessage

  • Type:
  • Required: Yes

VpcLinkVersion

  • Type: typing.Literal['V2']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetVpcLinksRequest

MaxResults

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

GetVpcLinksResponse

Items

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.VpcLink]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ImportApiRequest

Body

  • Type:
  • Required: Yes

Basepath

  • Type: typing.Optional[str]

FailOnWarnings

  • Type: typing.Optional[bool]

ImportApiResponse

ApiEndpoint

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type:
  • Required: Yes

CorsConfiguration

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

DisableSchemaValidation

  • Type:
  • Required: Yes

DisableExecuteApiEndpoint

  • Type:
  • Required: Yes

ImportInfo

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Version

  • Type:
  • Required: Yes

Warnings

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Integration

ApiGatewayManaged

  • Type: typing.Optional[bool]

ConnectionId

  • Type: typing.Optional[str]

ConnectionType

  • Type: typing.Optional[typing.Literal['INTERNET', 'VPC_LINK']]

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

CredentialsArn

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

IntegrationId

  • Type: typing.Optional[str]

IntegrationMethod

  • Type: typing.Optional[str]

IntegrationResponseSelectionExpression

  • Type: typing.Optional[str]

IntegrationSubtype

  • Type: typing.Optional[str]

IntegrationType

  • Type: typing.Optional[typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']]

IntegrationUri

  • Type: typing.Optional[str]

PassthroughBehavior

  • Type: typing.Optional[typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']]

PayloadFormatVersion

  • Type: typing.Optional[str]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, str]]

RequestTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, str]]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

TimeoutInMillis

  • Type: typing.Optional[int]

TlsConfig

  • Type:

IntegrationResponse

IntegrationResponseKey

  • Type:
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

IntegrationResponseId

  • Type: typing.Optional[str]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

JWTConfiguration

Audience

  • Type: typing.Optional[typing.List[str]]

Issuer

  • Type: typing.Optional[str]

JWTConfigurationOutput

Audience

  • Type: typing.Optional[typing.List[str]]

Issuer

  • Type: typing.Optional[str]

Model

Name

  • Type:
  • Required: Yes

ContentType

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

ModelId

  • Type: typing.Optional[str]

Schema

  • Type: typing.Optional[str]

MutualTlsAuthentication

TruststoreUri

  • Type: typing.Optional[str]

TruststoreVersion

  • Type: typing.Optional[str]

TruststoreWarnings

  • Type: typing.Optional[typing.List[str]]

MutualTlsAuthenticationInput

TruststoreUri

  • Type: typing.Optional[str]

TruststoreVersion

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ParameterConstraints

Required

  • Type: typing.Optional[bool]

ReimportApiRequest

ApiId

  • Type:
  • Required: Yes

Body

  • Type:
  • Required: Yes

Basepath

  • Type: typing.Optional[str]

FailOnWarnings

  • Type: typing.Optional[bool]

ReimportApiResponse

ApiEndpoint

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type:
  • Required: Yes

CorsConfiguration

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

DisableSchemaValidation

  • Type:
  • Required: Yes

DisableExecuteApiEndpoint

  • Type:
  • Required: Yes

ImportInfo

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Version

  • Type:
  • Required: Yes

Warnings

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResetAuthorizersCacheRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Route

RouteKey

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type: typing.Optional[bool]

ApiKeyRequired

  • Type: typing.Optional[bool]

AuthorizationScopes

  • Type: typing.Optional[typing.List[str]]

AuthorizationType

  • Type: typing.Optional[typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']]

AuthorizerId

  • Type: typing.Optional[str]

ModelSelectionExpression

  • Type: typing.Optional[str]

OperationName

  • Type: typing.Optional[str]

RequestModels

  • Type: typing.Optional[typing.Dict[str, str]]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

RouteId

  • Type: typing.Optional[str]

RouteResponseSelectionExpression

  • Type: typing.Optional[str]

Target

  • Type: typing.Optional[str]

RouteResponse

RouteResponseKey

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type: typing.Optional[str]

ResponseModels

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

RouteResponseId

  • Type: typing.Optional[str]

RouteSettings

DataTraceEnabled

  • Type: typing.Optional[bool]

DetailedMetricsEnabled

  • Type: typing.Optional[bool]

LoggingLevel

  • Type: typing.Optional[typing.Literal['ERROR', 'INFO', 'OFF']]

ThrottlingBurstLimit

  • Type: typing.Optional[int]

ThrottlingRateLimit

  • Type: typing.Optional[float]

Stage

StageName

  • Type:
  • Required: Yes

AccessLogSettings

  • Type:

ApiGatewayManaged

  • Type: typing.Optional[bool]

AutoDeploy

  • Type: typing.Optional[bool]

ClientCertificateId

  • Type: typing.Optional[str]

CreatedDate

  • Type: typing.Optional[datetime.datetime]

DefaultRouteSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]

DeploymentId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

LastDeploymentStatusMessage

  • Type: typing.Optional[str]

LastUpdatedDate

  • Type: typing.Optional[datetime.datetime]

RouteSettings

  • Type: typing.Optional[typing.Dict[str, NoneType]]

StageVariables

  • Type: typing.Optional[typing.Dict[str, str]]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

TagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

TlsConfig

ServerNameToVerify

  • Type: typing.Optional[str]

TlsConfigInput

ServerNameToVerify

  • Type: typing.Optional[str]

UntagResourceRequest

ResourceArn

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateApiMappingRequest

ApiId

  • Type:
  • Required: Yes

ApiMappingId

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

ApiMappingKey

  • Type: typing.Optional[str]

Stage

  • Type: typing.Optional[str]

UpdateApiMappingResponse

ApiId

  • Type:
  • Required: Yes

ApiMappingId

  • Type:
  • Required: Yes

ApiMappingKey

  • Type:
  • Required: Yes

Stage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateApiRequest

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type: typing.Optional[str]

CorsConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.Cors, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.CorsOutput, NoneType]

CredentialsArn

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

DisableSchemaValidation

  • Type: typing.Optional[bool]

DisableExecuteApiEndpoint

  • Type: typing.Optional[bool]

Name

  • Type: typing.Optional[str]

RouteKey

  • Type: typing.Optional[str]

RouteSelectionExpression

  • Type: typing.Optional[str]

Target

  • Type: typing.Optional[str]

Version

  • Type: typing.Optional[str]

UpdateApiResponse

ApiEndpoint

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiId

  • Type:
  • Required: Yes

ApiKeySelectionExpression

  • Type:
  • Required: Yes

CorsConfiguration

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

DisableSchemaValidation

  • Type:
  • Required: Yes

DisableExecuteApiEndpoint

  • Type:
  • Required: Yes

ImportInfo

  • Type: typing.List[str]
  • Required: Yes

Name

  • Type:
  • Required: Yes

ProtocolType

  • Type: typing.Literal['HTTP', 'WEBSOCKET']
  • Required: Yes

RouteSelectionExpression

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

Version

  • Type:
  • Required: Yes

Warnings

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAuthorizerRequest

ApiId

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

AuthorizerCredentialsArn

  • Type: typing.Optional[str]

AuthorizerPayloadFormatVersion

  • Type: typing.Optional[str]

AuthorizerResultTtlInSeconds

  • Type: typing.Optional[int]

AuthorizerType

  • Type: typing.Optional[typing.Literal['JWT', 'REQUEST']]

AuthorizerUri

  • Type: typing.Optional[str]

EnableSimpleResponses

  • Type: typing.Optional[bool]

IdentitySource

  • Type: typing.Optional[typing.List[str]]

IdentityValidationExpression

  • Type: typing.Optional[str]

JwtConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.JWTConfiguration, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.JWTConfigurationOutput, NoneType]

Name

  • Type: typing.Optional[str]

UpdateAuthorizerResponse

AuthorizerCredentialsArn

  • Type:
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

AuthorizerPayloadFormatVersion

  • Type:
  • Required: Yes

AuthorizerResultTtlInSeconds

  • Type:
  • Required: Yes

AuthorizerType

  • Type: typing.Literal['JWT', 'REQUEST']
  • Required: Yes

AuthorizerUri

  • Type:
  • Required: Yes

EnableSimpleResponses

  • Type:
  • Required: Yes

IdentitySource

  • Type: typing.List[str]
  • Required: Yes

IdentityValidationExpression

  • Type:
  • Required: Yes

JwtConfiguration

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDeploymentRequest

ApiId

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

UpdateDeploymentResponse

AutoDeployed

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

DeploymentStatus

  • Type: typing.Literal['DEPLOYED', 'FAILED', 'PENDING']
  • Required: Yes

DeploymentStatusMessage

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDomainNameRequest

DomainName

  • Type:
  • Required: Yes

DomainNameConfigurations

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfiguration, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]]]

MutualTlsAuthentication

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.MutualTlsAuthenticationInput]

UpdateDomainNameResponse

ApiMappingSelectionExpression

  • Type:
  • Required: Yes

DomainName

  • Type:
  • Required: Yes

DomainNameConfigurations

  • Type: typing.List[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.DomainNameConfigurationOutput]
  • Required: Yes

MutualTlsAuthentication

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateIntegrationRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

ConnectionId

  • Type: typing.Optional[str]

ConnectionType

  • Type: typing.Optional[typing.Literal['INTERNET', 'VPC_LINK']]

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

CredentialsArn

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

IntegrationMethod

  • Type: typing.Optional[str]

IntegrationSubtype

  • Type: typing.Optional[str]

IntegrationType

  • Type: typing.Optional[typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']]

IntegrationUri

  • Type: typing.Optional[str]

PassthroughBehavior

  • Type: typing.Optional[typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']]

PayloadFormatVersion

  • Type: typing.Optional[str]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, str]]

RequestTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, str]]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

TimeoutInMillis

  • Type: typing.Optional[int]

TlsConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.TlsConfigInput]

UpdateIntegrationResponseRequest

ApiId

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

IntegrationResponseKey

  • Type: typing.Optional[str]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseTemplates

  • Type: typing.Optional[typing.Dict[str, str]]

TemplateSelectionExpression

  • Type: typing.Optional[str]

UpdateIntegrationResponseResponse

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

IntegrationResponseId

  • Type:
  • Required: Yes

IntegrationResponseKey

  • Type:
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateIntegrationResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ConnectionId

  • Type:
  • Required: Yes

ConnectionType

  • Type: typing.Literal['INTERNET', 'VPC_LINK']
  • Required: Yes

ContentHandlingStrategy

  • Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
  • Required: Yes

CredentialsArn

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

IntegrationId

  • Type:
  • Required: Yes

IntegrationMethod

  • Type:
  • Required: Yes

IntegrationResponseSelectionExpression

  • Type:
  • Required: Yes

IntegrationSubtype

  • Type:
  • Required: Yes

IntegrationType

  • Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
  • Required: Yes

IntegrationUri

  • Type:
  • Required: Yes

PassthroughBehavior

  • Type: typing.Literal['NEVER', 'WHEN_NO_MATCH', 'WHEN_NO_TEMPLATES']
  • Required: Yes

PayloadFormatVersion

  • Type:
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestTemplates

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, typing.Dict[str, str]]
  • Required: Yes

TemplateSelectionExpression

  • Type:
  • Required: Yes

TimeoutInMillis

  • Type:
  • Required: Yes

TlsConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateModelRequest

ApiId

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

ContentType

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Schema

  • Type: typing.Optional[str]

UpdateModelResponse

ContentType

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

ModelId

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Schema

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateRouteRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

ApiKeyRequired

  • Type: typing.Optional[bool]

AuthorizationScopes

  • Type: typing.Optional[typing.List[str]]

AuthorizationType

  • Type: typing.Optional[typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']]

AuthorizerId

  • Type: typing.Optional[str]

ModelSelectionExpression

  • Type: typing.Optional[str]

OperationName

  • Type: typing.Optional[str]

RequestModels

  • Type: typing.Optional[typing.Dict[str, str]]

RequestParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

RouteKey

  • Type: typing.Optional[str]

RouteResponseSelectionExpression

  • Type: typing.Optional[str]

Target

  • Type: typing.Optional[str]

UpdateRouteResponseRequest

ApiId

  • Type:
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type: typing.Optional[str]

ResponseModels

  • Type: typing.Optional[typing.Dict[str, str]]

ResponseParameters

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]]

RouteResponseKey

  • Type: typing.Optional[str]

UpdateRouteResponseResponse

ModelSelectionExpression

  • Type:
  • Required: Yes

ResponseModels

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteResponseId

  • Type:
  • Required: Yes

RouteResponseKey

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateRouteResult

ApiGatewayManaged

  • Type:
  • Required: Yes

ApiKeyRequired

  • Type:
  • Required: Yes

AuthorizationScopes

  • Type: typing.List[str]
  • Required: Yes

AuthorizationType

  • Type: typing.Literal['AWS_IAM', 'CUSTOM', 'JWT', 'NONE']
  • Required: Yes

AuthorizerId

  • Type:
  • Required: Yes

ModelSelectionExpression

  • Type:
  • Required: Yes

OperationName

  • Type:
  • Required: Yes

RequestModels

  • Type: typing.Dict[str, str]
  • Required: Yes

RequestParameters

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.ParameterConstraints]
  • Required: Yes

RouteId

  • Type:
  • Required: Yes

RouteKey

  • Type:
  • Required: Yes

RouteResponseSelectionExpression

  • Type:
  • Required: Yes

Target

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateStageRequest

ApiId

  • Type:
  • Required: Yes

StageName

  • Type:
  • Required: Yes

AccessLogSettings

  • Type:

AutoDeploy

  • Type: typing.Optional[bool]

ClientCertificateId

  • Type: typing.Optional[str]

DefaultRouteSettings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]

DeploymentId

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

RouteSettings

  • Type: typing.Optional[typing.Dict[str, NoneType]]

StageVariables

  • Type: typing.Optional[typing.Dict[str, str]]

UpdateStageResponse

AccessLogSettings

  • Type:
  • Required: Yes

ApiGatewayManaged

  • Type:
  • Required: Yes

AutoDeploy

  • Type:
  • Required: Yes

ClientCertificateId

  • Type:
  • Required: Yes

CreatedDate

  • Type:
  • Required: Yes

DefaultRouteSettings

  • Type:
  • Required: Yes

DeploymentId

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

LastDeploymentStatusMessage

  • Type:
  • Required: Yes

LastUpdatedDate

  • Type:
  • Required: Yes

RouteSettings

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigatewayv2.apigatewayv2_classes.RouteSettings]
  • Required: Yes

StageName

  • Type:
  • Required: Yes

StageVariables

  • Type: typing.Dict[str, str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateVpcLinkRequest

VpcLinkId

  • Type:
  • Required: Yes

Name

  • Type: typing.Optional[str]

UpdateVpcLinkResponse

CreatedDate

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

SecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

VpcLinkId

  • Type:
  • Required: Yes

VpcLinkStatus

  • Type: typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'INACTIVE', 'PENDING']
  • Required: Yes

VpcLinkStatusMessage

  • Type:
  • Required: Yes

VpcLinkVersion

  • Type: typing.Literal['V2']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VpcLink

Name

  • Type:
  • Required: Yes

SecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

SubnetIds

  • Type: typing.List[str]
  • Required: Yes

VpcLinkId

  • Type:
  • Required: Yes

CreatedDate

  • Type: typing.Optional[datetime.datetime]

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

VpcLinkStatus

  • Type: typing.Optional[typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'INACTIVE', 'PENDING']]

VpcLinkStatusMessage

  • Type: typing.Optional[str]

VpcLinkVersion

  • Type: typing.Optional[typing.Literal['V2']]