Skip to content

Type definitions#

Index > ApiGatewayV2 > Type definitions

Auto-generated documentation for ApiGatewayV2 type annotations stubs module mypy-boto3-apigatewayv2.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AccessLogSettingsTypeDef#

# AccessLogSettingsTypeDef definition

class AccessLogSettingsTypeDef(TypedDict):
    DestinationArn: NotRequired[str],
    Format: NotRequired[str],

ApiMappingTypeDef#

# ApiMappingTypeDef definition

class ApiMappingTypeDef(TypedDict):
    ApiId: str,
    Stage: str,
    ApiMappingId: NotRequired[str],
    ApiMappingKey: NotRequired[str],

CorsPaginatorTypeDef#

# CorsPaginatorTypeDef definition

class CorsPaginatorTypeDef(TypedDict):
    AllowCredentials: NotRequired[bool],
    AllowHeaders: NotRequired[List[str]],
    AllowMethods: NotRequired[List[str]],
    AllowOrigins: NotRequired[List[str]],
    ExposeHeaders: NotRequired[List[str]],
    MaxAge: NotRequired[int],

CorsTypeDef#

# CorsTypeDef definition

class CorsTypeDef(TypedDict):
    AllowCredentials: NotRequired[bool],
    AllowHeaders: NotRequired[Sequence[str]],
    AllowMethods: NotRequired[Sequence[str]],
    AllowOrigins: NotRequired[Sequence[str]],
    ExposeHeaders: NotRequired[Sequence[str]],
    MaxAge: NotRequired[int],

JWTConfigurationPaginatorTypeDef#

# JWTConfigurationPaginatorTypeDef definition

class JWTConfigurationPaginatorTypeDef(TypedDict):
    Audience: NotRequired[List[str]],
    Issuer: NotRequired[str],

JWTConfigurationTypeDef#

# JWTConfigurationTypeDef definition

class JWTConfigurationTypeDef(TypedDict):
    Audience: NotRequired[Sequence[str]],
    Issuer: NotRequired[str],

CreateApiMappingRequestRequestTypeDef#

# CreateApiMappingRequestRequestTypeDef definition

class CreateApiMappingRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DomainName: str,
    Stage: str,
    ApiMappingKey: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef definition

class CreateDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Description: NotRequired[str],
    StageName: NotRequired[str],

MutualTlsAuthenticationInputTypeDef#

# MutualTlsAuthenticationInputTypeDef definition

class MutualTlsAuthenticationInputTypeDef(TypedDict):
    TruststoreUri: NotRequired[str],
    TruststoreVersion: NotRequired[str],

MutualTlsAuthenticationTypeDef#

# MutualTlsAuthenticationTypeDef definition

class MutualTlsAuthenticationTypeDef(TypedDict):
    TruststoreUri: NotRequired[str],
    TruststoreVersion: NotRequired[str],
    TruststoreWarnings: NotRequired[List[str]],

TlsConfigInputTypeDef#

# TlsConfigInputTypeDef definition

class TlsConfigInputTypeDef(TypedDict):
    ServerNameToVerify: NotRequired[str],

CreateIntegrationResponseRequestRequestTypeDef#

# CreateIntegrationResponseRequestRequestTypeDef definition

class CreateIntegrationResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    IntegrationResponseKey: str,
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (1)
    ResponseParameters: NotRequired[Mapping[str, str]],
    ResponseTemplates: NotRequired[Mapping[str, str]],
    TemplateSelectionExpression: NotRequired[str],
  1. See ContentHandlingStrategyType

TlsConfigTypeDef#

# TlsConfigTypeDef definition

class TlsConfigTypeDef(TypedDict):
    ServerNameToVerify: NotRequired[str],

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef definition

class CreateModelRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Name: str,
    Schema: str,
    ContentType: NotRequired[str],
    Description: NotRequired[str],

ParameterConstraintsTypeDef#

# ParameterConstraintsTypeDef definition

class ParameterConstraintsTypeDef(TypedDict):
    Required: NotRequired[bool],

RouteSettingsTypeDef#

# RouteSettingsTypeDef definition

class RouteSettingsTypeDef(TypedDict):
    DataTraceEnabled: NotRequired[bool],
    DetailedMetricsEnabled: NotRequired[bool],
    LoggingLevel: NotRequired[LoggingLevelType],  # (1)
    ThrottlingBurstLimit: NotRequired[int],
    ThrottlingRateLimit: NotRequired[float],
  1. See LoggingLevelType

CreateVpcLinkRequestRequestTypeDef#

# CreateVpcLinkRequestRequestTypeDef definition

class CreateVpcLinkRequestRequestTypeDef(TypedDict):
    Name: str,
    SubnetIds: Sequence[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Mapping[str, str]],

DeleteAccessLogSettingsRequestRequestTypeDef#

# DeleteAccessLogSettingsRequestRequestTypeDef definition

class DeleteAccessLogSettingsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    StageName: str,

DeleteApiMappingRequestRequestTypeDef#

# DeleteApiMappingRequestRequestTypeDef definition

class DeleteApiMappingRequestRequestTypeDef(TypedDict):
    ApiMappingId: str,
    DomainName: str,

DeleteApiRequestRequestTypeDef#

# DeleteApiRequestRequestTypeDef definition

class DeleteApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteAuthorizerRequestRequestTypeDef#

# DeleteAuthorizerRequestRequestTypeDef definition

class DeleteAuthorizerRequestRequestTypeDef(TypedDict):
    ApiId: str,
    AuthorizerId: str,

DeleteCorsConfigurationRequestRequestTypeDef#

# DeleteCorsConfigurationRequestRequestTypeDef definition

class DeleteCorsConfigurationRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteDeploymentRequestRequestTypeDef#

# DeleteDeploymentRequestRequestTypeDef definition

class DeleteDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DeploymentId: str,

DeleteDomainNameRequestRequestTypeDef#

# DeleteDomainNameRequestRequestTypeDef definition

class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteIntegrationRequestRequestTypeDef#

# DeleteIntegrationRequestRequestTypeDef definition

class DeleteIntegrationRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,

DeleteIntegrationResponseRequestRequestTypeDef#

# DeleteIntegrationResponseRequestRequestTypeDef definition

class DeleteIntegrationResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    IntegrationResponseId: str,

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef definition

class DeleteModelRequestRequestTypeDef(TypedDict):
    ApiId: str,
    ModelId: str,

DeleteRouteRequestParameterRequestRequestTypeDef#

# DeleteRouteRequestParameterRequestRequestTypeDef definition

class DeleteRouteRequestParameterRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RequestParameterKey: str,
    RouteId: str,

DeleteRouteRequestRequestTypeDef#

# DeleteRouteRequestRequestTypeDef definition

class DeleteRouteRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,

DeleteRouteResponseRequestRequestTypeDef#

# DeleteRouteResponseRequestRequestTypeDef definition

class DeleteRouteResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    RouteResponseId: str,

DeleteRouteSettingsRequestRequestTypeDef#

# DeleteRouteSettingsRequestRequestTypeDef definition

class DeleteRouteSettingsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteKey: str,
    StageName: str,

DeleteStageRequestRequestTypeDef#

# DeleteStageRequestRequestTypeDef definition

class DeleteStageRequestRequestTypeDef(TypedDict):
    ApiId: str,
    StageName: str,

DeleteVpcLinkRequestRequestTypeDef#

# DeleteVpcLinkRequestRequestTypeDef definition

class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

DeploymentTypeDef#

# DeploymentTypeDef definition

class DeploymentTypeDef(TypedDict):
    AutoDeployed: NotRequired[bool],
    CreatedDate: NotRequired[datetime],
    DeploymentId: NotRequired[str],
    DeploymentStatus: NotRequired[DeploymentStatusType],  # (1)
    DeploymentStatusMessage: NotRequired[str],
    Description: NotRequired[str],
  1. See DeploymentStatusType

DomainNameConfigurationPaginatorTypeDef#

# DomainNameConfigurationPaginatorTypeDef definition

class DomainNameConfigurationPaginatorTypeDef(TypedDict):
    ApiGatewayDomainName: NotRequired[str],
    CertificateArn: NotRequired[str],
    CertificateName: NotRequired[str],
    CertificateUploadDate: NotRequired[datetime],
    DomainNameStatus: NotRequired[DomainNameStatusType],  # (1)
    DomainNameStatusMessage: NotRequired[str],
    EndpointType: NotRequired[EndpointTypeType],  # (2)
    HostedZoneId: NotRequired[str],
    SecurityPolicy: NotRequired[SecurityPolicyType],  # (3)
    OwnershipVerificationCertificateArn: NotRequired[str],
  1. See DomainNameStatusType
  2. See EndpointTypeType
  3. See SecurityPolicyType

ExportApiRequestRequestTypeDef#

# ExportApiRequestRequestTypeDef definition

class ExportApiRequestRequestTypeDef(TypedDict):
    ApiId: str,
    OutputType: JSONYAMLType,  # (1)
    Specification: OAS30Type,  # (2)
    ExportVersion: NotRequired[str],
    IncludeExtensions: NotRequired[bool],
    StageName: NotRequired[str],
  1. See JSONYAMLType
  2. See OAS30Type

GetApiMappingRequestRequestTypeDef#

# GetApiMappingRequestRequestTypeDef definition

class GetApiMappingRequestRequestTypeDef(TypedDict):
    ApiMappingId: str,
    DomainName: str,

GetApiMappingsRequestRequestTypeDef#

# GetApiMappingsRequestRequestTypeDef definition

class GetApiMappingsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetApiRequestRequestTypeDef#

# GetApiRequestRequestTypeDef definition

class GetApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetApisRequestRequestTypeDef#

# GetApisRequestRequestTypeDef definition

class GetApisRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetAuthorizerRequestRequestTypeDef#

# GetAuthorizerRequestRequestTypeDef definition

class GetAuthorizerRequestRequestTypeDef(TypedDict):
    ApiId: str,
    AuthorizerId: str,

GetAuthorizersRequestRequestTypeDef#

# GetAuthorizersRequestRequestTypeDef definition

class GetAuthorizersRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetDeploymentRequestRequestTypeDef#

# GetDeploymentRequestRequestTypeDef definition

class GetDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DeploymentId: str,

GetDeploymentsRequestRequestTypeDef#

# GetDeploymentsRequestRequestTypeDef definition

class GetDeploymentsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetDomainNameRequestRequestTypeDef#

# GetDomainNameRequestRequestTypeDef definition

class GetDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetDomainNamesRequestRequestTypeDef#

# GetDomainNamesRequestRequestTypeDef definition

class GetDomainNamesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],