Typed dictionaries#

Index > ApiGatewayV2 > Typed dictionaries

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

AccessLogSettingsTypeDef#

# AccessLogSettingsTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import AccessLogSettingsTypeDef

def get_value() -> AccessLogSettingsTypeDef:
    return {
        "DestinationArn": ...,
    }

# AccessLogSettingsTypeDef definition

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

ApiMappingTypeDef#

# ApiMappingTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ApiMappingTypeDef

def get_value() -> ApiMappingTypeDef:
    return {
        "ApiId": ...,
        "Stage": ...,
    }

# ApiMappingTypeDef definition

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

CorsTypeDef#

# CorsTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CorsTypeDef

def get_value() -> CorsTypeDef:
    return {
        "AllowCredentials": ...,
    }

# 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],

JWTConfigurationTypeDef#

# JWTConfigurationTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import JWTConfigurationTypeDef

def get_value() -> JWTConfigurationTypeDef:
    return {
        "Audience": ...,
    }

# JWTConfigurationTypeDef definition

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

CreateApiMappingRequestRequestTypeDef#

# CreateApiMappingRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateApiMappingRequestRequestTypeDef

def get_value() -> CreateApiMappingRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DomainName": ...,
        "Stage": ...,
    }

# CreateApiMappingRequestRequestTypeDef definition

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

CreateApiMappingResponseTypeDef#

# CreateApiMappingResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateApiMappingResponseTypeDef

def get_value() -> CreateApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }

# CreateApiMappingResponseTypeDef definition

class CreateApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateDeploymentRequestRequestTypeDef

def get_value() -> CreateDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# CreateDeploymentRequestRequestTypeDef definition

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

CreateDeploymentResponseTypeDef#

# CreateDeploymentResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateDeploymentResponseTypeDef

def get_value() -> CreateDeploymentResponseTypeDef:
    return {
        "AutoDeployed": ...,
        "CreatedDate": ...,
        "DeploymentId": ...,
        "DeploymentStatus": ...,
        "DeploymentStatusMessage": ...,
        "Description": ...,
        "ResponseMetadata": ...,
    }

# CreateDeploymentResponseTypeDef definition

class CreateDeploymentResponseTypeDef(TypedDict):
    AutoDeployed: bool,
    CreatedDate: datetime,
    DeploymentId: str,
    DeploymentStatus: DeploymentStatusType,  # (1)
    DeploymentStatusMessage: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DeploymentStatusType
See ResponseMetadataTypeDef

DomainNameConfigurationTypeDef#

# DomainNameConfigurationTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DomainNameConfigurationTypeDef

def get_value() -> DomainNameConfigurationTypeDef:
    return {
        "ApiGatewayDomainName": ...,
    }

# DomainNameConfigurationTypeDef definition

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

MutualTlsAuthenticationInputTypeDef#

# MutualTlsAuthenticationInputTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import MutualTlsAuthenticationInputTypeDef

def get_value() -> MutualTlsAuthenticationInputTypeDef:
    return {
        "TruststoreUri": ...,
    }

# MutualTlsAuthenticationInputTypeDef definition

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

MutualTlsAuthenticationTypeDef#

# MutualTlsAuthenticationTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import MutualTlsAuthenticationTypeDef

def get_value() -> MutualTlsAuthenticationTypeDef:
    return {
        "TruststoreUri": ...,
    }

# MutualTlsAuthenticationTypeDef definition

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

TlsConfigInputTypeDef#

# TlsConfigInputTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import TlsConfigInputTypeDef

def get_value() -> TlsConfigInputTypeDef:
    return {
        "ServerNameToVerify": ...,
    }

# TlsConfigInputTypeDef definition

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

CreateIntegrationResponseRequestRequestTypeDef#

# CreateIntegrationResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationResponseRequestRequestTypeDef

def get_value() -> CreateIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseKey": ...,
    }

# 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],

See ContentHandlingStrategyType

CreateIntegrationResponseResponseTypeDef#

# CreateIntegrationResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationResponseResponseTypeDef

def get_value() -> CreateIntegrationResponseResponseTypeDef:
    return {
        "ContentHandlingStrategy": ...,
        "IntegrationResponseId": ...,
        "IntegrationResponseKey": ...,
        "ResponseParameters": ...,
        "ResponseTemplates": ...,
        "TemplateSelectionExpression": ...,
        "ResponseMetadata": ...,
    }

# CreateIntegrationResponseResponseTypeDef definition

class CreateIntegrationResponseResponseTypeDef(TypedDict):
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (1)
    IntegrationResponseId: str,
    IntegrationResponseKey: str,
    ResponseParameters: Dict[str, str],
    ResponseTemplates: Dict[str, str],
    TemplateSelectionExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ContentHandlingStrategyType
See ResponseMetadataTypeDef

TlsConfigTypeDef#

# TlsConfigTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import TlsConfigTypeDef

def get_value() -> TlsConfigTypeDef:
    return {
        "ServerNameToVerify": ...,
    }

# TlsConfigTypeDef definition

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

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateModelRequestRequestTypeDef

def get_value() -> CreateModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "Name": ...,
        "Schema": ...,
    }

# CreateModelRequestRequestTypeDef definition

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

CreateModelResponseTypeDef#

# CreateModelResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateModelResponseTypeDef

def get_value() -> CreateModelResponseTypeDef:
    return {
        "ContentType": ...,
        "Description": ...,
        "ModelId": ...,
        "Name": ...,
        "Schema": ...,
        "ResponseMetadata": ...,
    }

# CreateModelResponseTypeDef definition

class CreateModelResponseTypeDef(TypedDict):
    ContentType: str,
    Description: str,
    ModelId: str,
    Name: str,
    Schema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

ParameterConstraintsTypeDef#

# ParameterConstraintsTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ParameterConstraintsTypeDef

def get_value() -> ParameterConstraintsTypeDef:
    return {
        "Required": ...,
    }

# ParameterConstraintsTypeDef definition

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

RouteSettingsTypeDef#

# RouteSettingsTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import RouteSettingsTypeDef

def get_value() -> RouteSettingsTypeDef:
    return {
        "DataTraceEnabled": ...,
    }

# RouteSettingsTypeDef definition

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

See LoggingLevelType

CreateVpcLinkRequestRequestTypeDef#

# CreateVpcLinkRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateVpcLinkRequestRequestTypeDef

def get_value() -> CreateVpcLinkRequestRequestTypeDef:
    return {
        "Name": ...,
        "SubnetIds": ...,
    }

# CreateVpcLinkRequestRequestTypeDef definition

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

CreateVpcLinkResponseTypeDef#

# CreateVpcLinkResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateVpcLinkResponseTypeDef

def get_value() -> CreateVpcLinkResponseTypeDef:
    return {
        "CreatedDate": ...,
        "Name": ...,
        "SecurityGroupIds": ...,
        "SubnetIds": ...,
        "Tags": ...,
        "VpcLinkId": ...,
        "VpcLinkStatus": ...,
        "VpcLinkStatusMessage": ...,
        "VpcLinkVersion": ...,
        "ResponseMetadata": ...,
    }

# CreateVpcLinkResponseTypeDef definition

class CreateVpcLinkResponseTypeDef(TypedDict):
    CreatedDate: datetime,
    Name: str,
    SecurityGroupIds: List[str],
    SubnetIds: List[str],
    Tags: Dict[str, str],
    VpcLinkId: str,
    VpcLinkStatus: VpcLinkStatusType,  # (1)
    VpcLinkStatusMessage: str,
    VpcLinkVersion: VpcLinkVersionType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

DeleteAccessLogSettingsRequestRequestTypeDef#

# DeleteAccessLogSettingsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteAccessLogSettingsRequestRequestTypeDef

def get_value() -> DeleteAccessLogSettingsRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# DeleteAccessLogSettingsRequestRequestTypeDef definition

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

DeleteApiMappingRequestRequestTypeDef#

# DeleteApiMappingRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteApiMappingRequestRequestTypeDef

def get_value() -> DeleteApiMappingRequestRequestTypeDef:
    return {
        "ApiMappingId": ...,
        "DomainName": ...,
    }

# DeleteApiMappingRequestRequestTypeDef definition

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

DeleteApiRequestRequestTypeDef#

# DeleteApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteApiRequestRequestTypeDef

def get_value() -> DeleteApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# DeleteApiRequestRequestTypeDef definition

class DeleteApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteAuthorizerRequestRequestTypeDef#

# DeleteAuthorizerRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteAuthorizerRequestRequestTypeDef

def get_value() -> DeleteAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerId": ...,
    }

# DeleteAuthorizerRequestRequestTypeDef definition

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

DeleteCorsConfigurationRequestRequestTypeDef#

# DeleteCorsConfigurationRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteCorsConfigurationRequestRequestTypeDef

def get_value() -> DeleteCorsConfigurationRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# DeleteCorsConfigurationRequestRequestTypeDef definition

class DeleteCorsConfigurationRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteDeploymentRequestRequestTypeDef#

# DeleteDeploymentRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteDeploymentRequestRequestTypeDef

def get_value() -> DeleteDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DeploymentId": ...,
    }

# DeleteDeploymentRequestRequestTypeDef definition

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

DeleteDomainNameRequestRequestTypeDef#

# DeleteDomainNameRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteDomainNameRequestRequestTypeDef

def get_value() -> DeleteDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# DeleteDomainNameRequestRequestTypeDef definition

class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteIntegrationRequestRequestTypeDef#

# DeleteIntegrationRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteIntegrationRequestRequestTypeDef

def get_value() -> DeleteIntegrationRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }

# DeleteIntegrationRequestRequestTypeDef definition

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

DeleteIntegrationResponseRequestRequestTypeDef#

# DeleteIntegrationResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteIntegrationResponseRequestRequestTypeDef

def get_value() -> DeleteIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseId": ...,
    }

# DeleteIntegrationResponseRequestRequestTypeDef definition

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

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteModelRequestRequestTypeDef

def get_value() -> DeleteModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ModelId": ...,
    }

# DeleteModelRequestRequestTypeDef definition

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

DeleteRouteRequestParameterRequestRequestTypeDef#

# DeleteRouteRequestParameterRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteRouteRequestParameterRequestRequestTypeDef

def get_value() -> DeleteRouteRequestParameterRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RequestParameterKey": ...,
        "RouteId": ...,
    }

# DeleteRouteRequestParameterRequestRequestTypeDef definition

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

DeleteRouteRequestRequestTypeDef#

# DeleteRouteRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteRouteRequestRequestTypeDef

def get_value() -> DeleteRouteRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }

# DeleteRouteRequestRequestTypeDef definition

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

DeleteRouteResponseRequestRequestTypeDef#

# DeleteRouteResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteRouteResponseRequestRequestTypeDef

def get_value() -> DeleteRouteResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
        "RouteResponseId": ...,
    }

# DeleteRouteResponseRequestRequestTypeDef definition

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

DeleteRouteSettingsRequestRequestTypeDef#

# DeleteRouteSettingsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteRouteSettingsRequestRequestTypeDef

def get_value() -> DeleteRouteSettingsRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteKey": ...,
        "StageName": ...,
    }

# DeleteRouteSettingsRequestRequestTypeDef definition

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

DeleteStageRequestRequestTypeDef#

# DeleteStageRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteStageRequestRequestTypeDef

def get_value() -> DeleteStageRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# DeleteStageRequestRequestTypeDef definition

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

DeleteVpcLinkRequestRequestTypeDef#

# DeleteVpcLinkRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeleteVpcLinkRequestRequestTypeDef

def get_value() -> DeleteVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }

# DeleteVpcLinkRequestRequestTypeDef definition

class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

DeploymentTypeDef#

# DeploymentTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DeploymentTypeDef

def get_value() -> DeploymentTypeDef:
    return {
        "AutoDeployed": ...,
    }

# DeploymentTypeDef definition

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

See DeploymentStatusType

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

ExportApiRequestRequestTypeDef#

# ExportApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ExportApiRequestRequestTypeDef

def get_value() -> ExportApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "OutputType": ...,
        "Specification": ...,
    }

# ExportApiRequestRequestTypeDef definition

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

See JSONYAMLType
See OAS30Type

ExportApiResponseTypeDef#

# ExportApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ExportApiResponseTypeDef

def get_value() -> ExportApiResponseTypeDef:
    return {
        "body": ...,
        "ResponseMetadata": ...,
    }

# ExportApiResponseTypeDef definition

class ExportApiResponseTypeDef(TypedDict):
    body: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetApiMappingRequestRequestTypeDef#

# GetApiMappingRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiMappingRequestRequestTypeDef

def get_value() -> GetApiMappingRequestRequestTypeDef:
    return {
        "ApiMappingId": ...,
        "DomainName": ...,
    }

# GetApiMappingRequestRequestTypeDef definition

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

GetApiMappingResponseTypeDef#

# GetApiMappingResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiMappingResponseTypeDef

def get_value() -> GetApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }

# GetApiMappingResponseTypeDef definition

class GetApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetApiMappingsRequestRequestTypeDef#

# GetApiMappingsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiMappingsRequestRequestTypeDef

def get_value() -> GetApiMappingsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# GetApiMappingsRequestRequestTypeDef definition

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

GetApiRequestRequestTypeDef#

# GetApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiRequestRequestTypeDef

def get_value() -> GetApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetApiRequestRequestTypeDef definition

class GetApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

GetApisRequestGetApisPaginateTypeDef#

# GetApisRequestGetApisPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApisRequestGetApisPaginateTypeDef

def get_value() -> GetApisRequestGetApisPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

# GetApisRequestGetApisPaginateTypeDef definition

class GetApisRequestGetApisPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetApisRequestRequestTypeDef#

# GetApisRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApisRequestRequestTypeDef

def get_value() -> GetApisRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

# GetApisRequestRequestTypeDef definition

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

GetAuthorizerRequestRequestTypeDef#

# GetAuthorizerRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizerRequestRequestTypeDef

def get_value() -> GetAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerId": ...,
    }

# GetAuthorizerRequestRequestTypeDef definition

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

GetAuthorizersRequestGetAuthorizersPaginateTypeDef#

# GetAuthorizersRequestGetAuthorizersPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersRequestGetAuthorizersPaginateTypeDef

def get_value() -> GetAuthorizersRequestGetAuthorizersPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetAuthorizersRequestGetAuthorizersPaginateTypeDef definition

class GetAuthorizersRequestGetAuthorizersPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetAuthorizersRequestRequestTypeDef#

# GetAuthorizersRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersRequestRequestTypeDef

def get_value() -> GetAuthorizersRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetAuthorizersRequestRequestTypeDef definition

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

GetDeploymentRequestRequestTypeDef#

# GetDeploymentRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentRequestRequestTypeDef

def get_value() -> GetDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DeploymentId": ...,
    }

# GetDeploymentRequestRequestTypeDef definition

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

GetDeploymentResponseTypeDef#

# GetDeploymentResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentResponseTypeDef

def get_value() -> GetDeploymentResponseTypeDef:
    return {
        "AutoDeployed": ...,
        "CreatedDate": ...,
        "DeploymentId": ...,
        "DeploymentStatus": ...,
        "DeploymentStatusMessage": ...,
        "Description": ...,
        "ResponseMetadata": ...,
    }

# GetDeploymentResponseTypeDef definition

class GetDeploymentResponseTypeDef(TypedDict):
    AutoDeployed: bool,
    CreatedDate: datetime,
    DeploymentId: str,
    DeploymentStatus: DeploymentStatusType,  # (1)
    DeploymentStatusMessage: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DeploymentStatusType
See ResponseMetadataTypeDef

GetDeploymentsRequestGetDeploymentsPaginateTypeDef#

# GetDeploymentsRequestGetDeploymentsPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsRequestGetDeploymentsPaginateTypeDef

def get_value() -> GetDeploymentsRequestGetDeploymentsPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetDeploymentsRequestGetDeploymentsPaginateTypeDef definition

class GetDeploymentsRequestGetDeploymentsPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetDeploymentsRequestRequestTypeDef#

# GetDeploymentsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsRequestRequestTypeDef

def get_value() -> GetDeploymentsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetDeploymentsRequestRequestTypeDef definition

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

GetDomainNameRequestRequestTypeDef#

# GetDomainNameRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNameRequestRequestTypeDef

def get_value() -> GetDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# GetDomainNameRequestRequestTypeDef definition

class GetDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetDomainNamesRequestGetDomainNamesPaginateTypeDef#

# GetDomainNamesRequestGetDomainNamesPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesRequestGetDomainNamesPaginateTypeDef

def get_value() -> GetDomainNamesRequestGetDomainNamesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

# GetDomainNamesRequestGetDomainNamesPaginateTypeDef definition

class GetDomainNamesRequestGetDomainNamesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetDomainNamesRequestRequestTypeDef#

# GetDomainNamesRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesRequestRequestTypeDef

def get_value() -> GetDomainNamesRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

# GetDomainNamesRequestRequestTypeDef definition

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

GetIntegrationRequestRequestTypeDef#

# GetIntegrationRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationRequestRequestTypeDef

def get_value() -> GetIntegrationRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }

# GetIntegrationRequestRequestTypeDef definition

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

GetIntegrationResponseRequestRequestTypeDef#

# GetIntegrationResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponseRequestRequestTypeDef

def get_value() -> GetIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseId": ...,
    }

# GetIntegrationResponseRequestRequestTypeDef definition

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

GetIntegrationResponseResponseTypeDef#

# GetIntegrationResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponseResponseTypeDef

def get_value() -> GetIntegrationResponseResponseTypeDef:
    return {
        "ContentHandlingStrategy": ...,
        "IntegrationResponseId": ...,
        "IntegrationResponseKey": ...,
        "ResponseParameters": ...,
        "ResponseTemplates": ...,
        "TemplateSelectionExpression": ...,
        "ResponseMetadata": ...,
    }

# GetIntegrationResponseResponseTypeDef definition

class GetIntegrationResponseResponseTypeDef(TypedDict):
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (1)
    IntegrationResponseId: str,
    IntegrationResponseKey: str,
    ResponseParameters: Dict[str, str],
    ResponseTemplates: Dict[str, str],
    TemplateSelectionExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ContentHandlingStrategyType
See ResponseMetadataTypeDef

GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef#

# GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef

def get_value() -> GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }

# GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef definition

class GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetIntegrationResponsesRequestRequestTypeDef#

# GetIntegrationResponsesRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesRequestRequestTypeDef

def get_value() -> GetIntegrationResponsesRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }

# GetIntegrationResponsesRequestRequestTypeDef definition

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

IntegrationResponseTypeDef#

# IntegrationResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import IntegrationResponseTypeDef

def get_value() -> IntegrationResponseTypeDef:
    return {
        "IntegrationResponseKey": ...,
    }

# IntegrationResponseTypeDef definition

class IntegrationResponseTypeDef(TypedDict):
    IntegrationResponseKey: str,
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (1)
    IntegrationResponseId: NotRequired[str],
    ResponseParameters: NotRequired[Dict[str, str]],
    ResponseTemplates: NotRequired[Dict[str, str]],
    TemplateSelectionExpression: NotRequired[str],

See ContentHandlingStrategyType

GetIntegrationsRequestGetIntegrationsPaginateTypeDef#

# GetIntegrationsRequestGetIntegrationsPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsRequestGetIntegrationsPaginateTypeDef

def get_value() -> GetIntegrationsRequestGetIntegrationsPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetIntegrationsRequestGetIntegrationsPaginateTypeDef definition

class GetIntegrationsRequestGetIntegrationsPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetIntegrationsRequestRequestTypeDef#

# GetIntegrationsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsRequestRequestTypeDef

def get_value() -> GetIntegrationsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetIntegrationsRequestRequestTypeDef definition

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

GetModelRequestRequestTypeDef#

# GetModelRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelRequestRequestTypeDef

def get_value() -> GetModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ModelId": ...,
    }

# GetModelRequestRequestTypeDef definition

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

GetModelResponseTypeDef#

# GetModelResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelResponseTypeDef

def get_value() -> GetModelResponseTypeDef:
    return {
        "ContentType": ...,
        "Description": ...,
        "ModelId": ...,
        "Name": ...,
        "Schema": ...,
        "ResponseMetadata": ...,
    }

# GetModelResponseTypeDef definition

class GetModelResponseTypeDef(TypedDict):
    ContentType: str,
    Description: str,
    ModelId: str,
    Name: str,
    Schema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetModelTemplateRequestRequestTypeDef#

# GetModelTemplateRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelTemplateRequestRequestTypeDef

def get_value() -> GetModelTemplateRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ModelId": ...,
    }

# GetModelTemplateRequestRequestTypeDef definition

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

GetModelTemplateResponseTypeDef#

# GetModelTemplateResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelTemplateResponseTypeDef

def get_value() -> GetModelTemplateResponseTypeDef:
    return {
        "Value": ...,
        "ResponseMetadata": ...,
    }

# GetModelTemplateResponseTypeDef definition

class GetModelTemplateResponseTypeDef(TypedDict):
    Value: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetModelsRequestGetModelsPaginateTypeDef#

# GetModelsRequestGetModelsPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelsRequestGetModelsPaginateTypeDef

def get_value() -> GetModelsRequestGetModelsPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetModelsRequestGetModelsPaginateTypeDef definition

class GetModelsRequestGetModelsPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetModelsRequestRequestTypeDef#

# GetModelsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelsRequestRequestTypeDef

def get_value() -> GetModelsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetModelsRequestRequestTypeDef definition

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

ModelTypeDef#

# ModelTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ModelTypeDef

def get_value() -> ModelTypeDef:
    return {
        "Name": ...,
    }

# ModelTypeDef definition

class ModelTypeDef(TypedDict):
    Name: str,
    ContentType: NotRequired[str],
    Description: NotRequired[str],
    ModelId: NotRequired[str],
    Schema: NotRequired[str],

GetRouteRequestRequestTypeDef#

# GetRouteRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteRequestRequestTypeDef

def get_value() -> GetRouteRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }

# GetRouteRequestRequestTypeDef definition

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

GetRouteResponseRequestRequestTypeDef#

# GetRouteResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponseRequestRequestTypeDef

def get_value() -> GetRouteResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
        "RouteResponseId": ...,
    }

# GetRouteResponseRequestRequestTypeDef definition

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

GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef#

# GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef

def get_value() -> GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }

# GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef definition

class GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetRouteResponsesRequestRequestTypeDef#

# GetRouteResponsesRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesRequestRequestTypeDef

def get_value() -> GetRouteResponsesRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }

# GetRouteResponsesRequestRequestTypeDef definition

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

GetRoutesRequestGetRoutesPaginateTypeDef#

# GetRoutesRequestGetRoutesPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRoutesRequestGetRoutesPaginateTypeDef

def get_value() -> GetRoutesRequestGetRoutesPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetRoutesRequestGetRoutesPaginateTypeDef definition

class GetRoutesRequestGetRoutesPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetRoutesRequestRequestTypeDef#

# GetRoutesRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRoutesRequestRequestTypeDef

def get_value() -> GetRoutesRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetRoutesRequestRequestTypeDef definition

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

GetStageRequestRequestTypeDef#

# GetStageRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetStageRequestRequestTypeDef

def get_value() -> GetStageRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# GetStageRequestRequestTypeDef definition

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

GetStagesRequestGetStagesPaginateTypeDef#

# GetStagesRequestGetStagesPaginateTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetStagesRequestGetStagesPaginateTypeDef

def get_value() -> GetStagesRequestGetStagesPaginateTypeDef:
    return {
        "ApiId": ...,
    }

# GetStagesRequestGetStagesPaginateTypeDef definition

class GetStagesRequestGetStagesPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetStagesRequestRequestTypeDef#

# GetStagesRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetStagesRequestRequestTypeDef

def get_value() -> GetStagesRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# GetStagesRequestRequestTypeDef definition

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

GetTagsRequestRequestTypeDef#

# GetTagsRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetTagsRequestRequestTypeDef

def get_value() -> GetTagsRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

# GetTagsRequestRequestTypeDef definition

class GetTagsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetTagsResponseTypeDef#

# GetTagsResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetTagsResponseTypeDef

def get_value() -> GetTagsResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# GetTagsResponseTypeDef definition

class GetTagsResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

GetVpcLinkRequestRequestTypeDef#

# GetVpcLinkRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetVpcLinkRequestRequestTypeDef

def get_value() -> GetVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }

# GetVpcLinkRequestRequestTypeDef definition

class GetVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

GetVpcLinkResponseTypeDef#

# GetVpcLinkResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetVpcLinkResponseTypeDef

def get_value() -> GetVpcLinkResponseTypeDef:
    return {
        "CreatedDate": ...,
        "Name": ...,
        "SecurityGroupIds": ...,
        "SubnetIds": ...,
        "Tags": ...,
        "VpcLinkId": ...,
        "VpcLinkStatus": ...,
        "VpcLinkStatusMessage": ...,
        "VpcLinkVersion": ...,
        "ResponseMetadata": ...,
    }

# GetVpcLinkResponseTypeDef definition

class GetVpcLinkResponseTypeDef(TypedDict):
    CreatedDate: datetime,
    Name: str,
    SecurityGroupIds: List[str],
    SubnetIds: List[str],
    Tags: Dict[str, str],
    VpcLinkId: str,
    VpcLinkStatus: VpcLinkStatusType,  # (1)
    VpcLinkStatusMessage: str,
    VpcLinkVersion: VpcLinkVersionType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GetVpcLinksRequestRequestTypeDef#

# GetVpcLinksRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetVpcLinksRequestRequestTypeDef

def get_value() -> GetVpcLinksRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }

# GetVpcLinksRequestRequestTypeDef definition

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

VpcLinkTypeDef#

# VpcLinkTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import VpcLinkTypeDef

def get_value() -> VpcLinkTypeDef:
    return {
        "Name": ...,
        "SecurityGroupIds": ...,
        "SubnetIds": ...,
        "VpcLinkId": ...,
    }

# VpcLinkTypeDef definition

class VpcLinkTypeDef(TypedDict):
    Name: str,
    SecurityGroupIds: List[str],
    SubnetIds: List[str],
    VpcLinkId: str,
    CreatedDate: NotRequired[datetime],
    Tags: NotRequired[Dict[str, str]],
    VpcLinkStatus: NotRequired[VpcLinkStatusType],  # (1)
    VpcLinkStatusMessage: NotRequired[str],
    VpcLinkVersion: NotRequired[VpcLinkVersionType],  # (2)

See VpcLinkStatusType
See VpcLinkVersionType

ImportApiRequestRequestTypeDef#

# ImportApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ImportApiRequestRequestTypeDef

def get_value() -> ImportApiRequestRequestTypeDef:
    return {
        "Body": ...,
    }

# ImportApiRequestRequestTypeDef definition

class ImportApiRequestRequestTypeDef(TypedDict):
    Body: str,
    Basepath: NotRequired[str],
    FailOnWarnings: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

# PaginatorConfigTypeDef definition

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

ReimportApiRequestRequestTypeDef#

# ReimportApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ReimportApiRequestRequestTypeDef

def get_value() -> ReimportApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "Body": ...,
    }

# ReimportApiRequestRequestTypeDef definition

class ReimportApiRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Body: str,
    Basepath: NotRequired[str],
    FailOnWarnings: NotRequired[bool],

ResetAuthorizersCacheRequestRequestTypeDef#

# ResetAuthorizersCacheRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ResetAuthorizersCacheRequestRequestTypeDef

def get_value() -> ResetAuthorizersCacheRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# ResetAuthorizersCacheRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: NotRequired[Mapping[str, str]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateApiMappingRequestRequestTypeDef#

# UpdateApiMappingRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateApiMappingRequestRequestTypeDef

def get_value() -> UpdateApiMappingRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "DomainName": ...,
    }

# UpdateApiMappingRequestRequestTypeDef definition

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

UpdateApiMappingResponseTypeDef#

# UpdateApiMappingResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateApiMappingResponseTypeDef

def get_value() -> UpdateApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }

# UpdateApiMappingResponseTypeDef definition

class UpdateApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

UpdateDeploymentRequestRequestTypeDef#

# UpdateDeploymentRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateDeploymentRequestRequestTypeDef

def get_value() -> UpdateDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DeploymentId": ...,
    }

# UpdateDeploymentRequestRequestTypeDef definition

class UpdateDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DeploymentId: str,
    Description: NotRequired[str],

UpdateDeploymentResponseTypeDef#

# UpdateDeploymentResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateDeploymentResponseTypeDef

def get_value() -> UpdateDeploymentResponseTypeDef:
    return {
        "AutoDeployed": ...,
        "CreatedDate": ...,
        "DeploymentId": ...,
        "DeploymentStatus": ...,
        "DeploymentStatusMessage": ...,
        "Description": ...,
        "ResponseMetadata": ...,
    }

# UpdateDeploymentResponseTypeDef definition

class UpdateDeploymentResponseTypeDef(TypedDict):
    AutoDeployed: bool,
    CreatedDate: datetime,
    DeploymentId: str,
    DeploymentStatus: DeploymentStatusType,  # (1)
    DeploymentStatusMessage: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DeploymentStatusType
See ResponseMetadataTypeDef

UpdateIntegrationResponseRequestRequestTypeDef#

# UpdateIntegrationResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationResponseRequestRequestTypeDef

def get_value() -> UpdateIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseId": ...,
    }

# UpdateIntegrationResponseRequestRequestTypeDef definition

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

See ContentHandlingStrategyType

UpdateIntegrationResponseResponseTypeDef#

# UpdateIntegrationResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationResponseResponseTypeDef

def get_value() -> UpdateIntegrationResponseResponseTypeDef:
    return {
        "ContentHandlingStrategy": ...,
        "IntegrationResponseId": ...,
        "IntegrationResponseKey": ...,
        "ResponseParameters": ...,
        "ResponseTemplates": ...,
        "TemplateSelectionExpression": ...,
        "ResponseMetadata": ...,
    }

# UpdateIntegrationResponseResponseTypeDef definition

class UpdateIntegrationResponseResponseTypeDef(TypedDict):
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (1)
    IntegrationResponseId: str,
    IntegrationResponseKey: str,
    ResponseParameters: Dict[str, str],
    ResponseTemplates: Dict[str, str],
    TemplateSelectionExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ContentHandlingStrategyType
See ResponseMetadataTypeDef

UpdateModelRequestRequestTypeDef#

# UpdateModelRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateModelRequestRequestTypeDef

def get_value() -> UpdateModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ModelId": ...,
    }

# UpdateModelRequestRequestTypeDef definition

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

UpdateModelResponseTypeDef#

# UpdateModelResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateModelResponseTypeDef

def get_value() -> UpdateModelResponseTypeDef:
    return {
        "ContentType": ...,
        "Description": ...,
        "ModelId": ...,
        "Name": ...,
        "Schema": ...,
        "ResponseMetadata": ...,
    }

# UpdateModelResponseTypeDef definition

class UpdateModelResponseTypeDef(TypedDict):
    ContentType: str,
    Description: str,
    ModelId: str,
    Name: str,
    Schema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

UpdateVpcLinkRequestRequestTypeDef#

# UpdateVpcLinkRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateVpcLinkRequestRequestTypeDef

def get_value() -> UpdateVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }

# UpdateVpcLinkRequestRequestTypeDef definition

class UpdateVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,
    Name: NotRequired[str],

UpdateVpcLinkResponseTypeDef#

# UpdateVpcLinkResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateVpcLinkResponseTypeDef

def get_value() -> UpdateVpcLinkResponseTypeDef:
    return {
        "CreatedDate": ...,
        "Name": ...,
        "SecurityGroupIds": ...,
        "SubnetIds": ...,
        "Tags": ...,
        "VpcLinkId": ...,
        "VpcLinkStatus": ...,
        "VpcLinkStatusMessage": ...,
        "VpcLinkVersion": ...,
        "ResponseMetadata": ...,
    }

# UpdateVpcLinkResponseTypeDef definition

class UpdateVpcLinkResponseTypeDef(TypedDict):
    CreatedDate: datetime,
    Name: str,
    SecurityGroupIds: List[str],
    SubnetIds: List[str],
    Tags: Dict[str, str],
    VpcLinkId: str,
    VpcLinkStatus: VpcLinkStatusType,  # (1)
    VpcLinkStatusMessage: str,
    VpcLinkVersion: VpcLinkVersionType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GetApiMappingsResponseTypeDef#

# GetApiMappingsResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiMappingsResponseTypeDef

def get_value() -> GetApiMappingsResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetApiMappingsResponseTypeDef definition

class GetApiMappingsResponseTypeDef(TypedDict):
    Items: List[ApiMappingTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ApiMappingTypeDef
See ResponseMetadataTypeDef

ApiTypeDef#

# ApiTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ApiTypeDef

def get_value() -> ApiTypeDef:
    return {
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
    }

# ApiTypeDef definition

class ApiTypeDef(TypedDict):
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    ApiEndpoint: NotRequired[str],
    ApiGatewayManaged: NotRequired[bool],
    ApiId: NotRequired[str],
    ApiKeySelectionExpression: NotRequired[str],
    CorsConfiguration: NotRequired[CorsTypeDef],  # (1)
    CreatedDate: NotRequired[datetime],
    Description: NotRequired[str],
    DisableSchemaValidation: NotRequired[bool],
    DisableExecuteApiEndpoint: NotRequired[bool],
    ImportInfo: NotRequired[List[str]],
    Tags: NotRequired[Dict[str, str]],
    Version: NotRequired[str],
    Warnings: NotRequired[List[str]],

See CorsTypeDef
See ProtocolTypeType

CreateApiRequestRequestTypeDef#

# CreateApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateApiRequestRequestTypeDef

def get_value() -> CreateApiRequestRequestTypeDef:
    return {
        "Name": ...,
        "ProtocolType": ...,
    }

# CreateApiRequestRequestTypeDef definition

class CreateApiRequestRequestTypeDef(TypedDict):
    Name: str,
    ProtocolType: ProtocolTypeType,  # (1)
    ApiKeySelectionExpression: NotRequired[str],
    CorsConfiguration: NotRequired[CorsTypeDef],  # (2)
    CredentialsArn: NotRequired[str],
    Description: NotRequired[str],
    DisableSchemaValidation: NotRequired[bool],
    DisableExecuteApiEndpoint: NotRequired[bool],
    RouteKey: NotRequired[str],
    RouteSelectionExpression: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    Target: NotRequired[str],
    Version: NotRequired[str],

See ProtocolTypeType
See CorsTypeDef

CreateApiResponseTypeDef#

# CreateApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateApiResponseTypeDef

def get_value() -> CreateApiResponseTypeDef:
    return {
        "ApiEndpoint": ...,
        "ApiGatewayManaged": ...,
        "ApiId": ...,
        "ApiKeySelectionExpression": ...,
        "CorsConfiguration": ...,
        "CreatedDate": ...,
        "Description": ...,
        "DisableSchemaValidation": ...,
        "DisableExecuteApiEndpoint": ...,
        "ImportInfo": ...,
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
        "Tags": ...,
        "Version": ...,
        "Warnings": ...,
        "ResponseMetadata": ...,
    }

# CreateApiResponseTypeDef definition

class CreateApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsTypeDef,  # (1)
    CreatedDate: datetime,
    Description: str,
    DisableSchemaValidation: bool,
    DisableExecuteApiEndpoint: bool,
    ImportInfo: List[str],
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    Tags: Dict[str, str],
    Version: str,
    Warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GetApiResponseTypeDef#

# GetApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApiResponseTypeDef

def get_value() -> GetApiResponseTypeDef:
    return {
        "ApiEndpoint": ...,
        "ApiGatewayManaged": ...,
        "ApiId": ...,
        "ApiKeySelectionExpression": ...,
        "CorsConfiguration": ...,
        "CreatedDate": ...,
        "Description": ...,
        "DisableSchemaValidation": ...,
        "DisableExecuteApiEndpoint": ...,
        "ImportInfo": ...,
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
        "Tags": ...,
        "Version": ...,
        "Warnings": ...,
        "ResponseMetadata": ...,
    }

# GetApiResponseTypeDef definition

class GetApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsTypeDef,  # (1)
    CreatedDate: datetime,
    Description: str,
    DisableSchemaValidation: bool,
    DisableExecuteApiEndpoint: bool,
    ImportInfo: List[str],
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    Tags: Dict[str, str],
    Version: str,
    Warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

ImportApiResponseTypeDef#

# ImportApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ImportApiResponseTypeDef

def get_value() -> ImportApiResponseTypeDef:
    return {
        "ApiEndpoint": ...,
        "ApiGatewayManaged": ...,
        "ApiId": ...,
        "ApiKeySelectionExpression": ...,
        "CorsConfiguration": ...,
        "CreatedDate": ...,
        "Description": ...,
        "DisableSchemaValidation": ...,
        "DisableExecuteApiEndpoint": ...,
        "ImportInfo": ...,
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
        "Tags": ...,
        "Version": ...,
        "Warnings": ...,
        "ResponseMetadata": ...,
    }

# ImportApiResponseTypeDef definition

class ImportApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsTypeDef,  # (1)
    CreatedDate: datetime,
    Description: str,
    DisableSchemaValidation: bool,
    DisableExecuteApiEndpoint: bool,
    ImportInfo: List[str],
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    Tags: Dict[str, str],
    Version: str,
    Warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

ReimportApiResponseTypeDef#

# ReimportApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import ReimportApiResponseTypeDef

def get_value() -> ReimportApiResponseTypeDef:
    return {
        "ApiEndpoint": ...,
        "ApiGatewayManaged": ...,
        "ApiId": ...,
        "ApiKeySelectionExpression": ...,
        "CorsConfiguration": ...,
        "CreatedDate": ...,
        "Description": ...,
        "DisableSchemaValidation": ...,
        "DisableExecuteApiEndpoint": ...,
        "ImportInfo": ...,
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
        "Tags": ...,
        "Version": ...,
        "Warnings": ...,
        "ResponseMetadata": ...,
    }

# ReimportApiResponseTypeDef definition

class ReimportApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsTypeDef,  # (1)
    CreatedDate: datetime,
    Description: str,
    DisableSchemaValidation: bool,
    DisableExecuteApiEndpoint: bool,
    ImportInfo: List[str],
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    Tags: Dict[str, str],
    Version: str,
    Warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

UpdateApiRequestRequestTypeDef#

# UpdateApiRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateApiRequestRequestTypeDef

def get_value() -> UpdateApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }

# UpdateApiRequestRequestTypeDef definition

class UpdateApiRequestRequestTypeDef(TypedDict):
    ApiId: str,
    ApiKeySelectionExpression: NotRequired[str],
    CorsConfiguration: NotRequired[CorsTypeDef],  # (1)
    CredentialsArn: NotRequired[str],
    Description: NotRequired[str],
    DisableSchemaValidation: NotRequired[bool],
    DisableExecuteApiEndpoint: NotRequired[bool],
    Name: NotRequired[str],
    RouteKey: NotRequired[str],
    RouteSelectionExpression: NotRequired[str],
    Target: NotRequired[str],
    Version: NotRequired[str],

See CorsTypeDef

UpdateApiResponseTypeDef#

# UpdateApiResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateApiResponseTypeDef

def get_value() -> UpdateApiResponseTypeDef:
    return {
        "ApiEndpoint": ...,
        "ApiGatewayManaged": ...,
        "ApiId": ...,
        "ApiKeySelectionExpression": ...,
        "CorsConfiguration": ...,
        "CreatedDate": ...,
        "Description": ...,
        "DisableSchemaValidation": ...,
        "DisableExecuteApiEndpoint": ...,
        "ImportInfo": ...,
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
        "Tags": ...,
        "Version": ...,
        "Warnings": ...,
        "ResponseMetadata": ...,
    }

# UpdateApiResponseTypeDef definition

class UpdateApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsTypeDef,  # (1)
    CreatedDate: datetime,
    Description: str,
    DisableSchemaValidation: bool,
    DisableExecuteApiEndpoint: bool,
    ImportInfo: List[str],
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    Tags: Dict[str, str],
    Version: str,
    Warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

AuthorizerTypeDef#

# AuthorizerTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import AuthorizerTypeDef

def get_value() -> AuthorizerTypeDef:
    return {
        "Name": ...,
    }

# AuthorizerTypeDef definition

class AuthorizerTypeDef(TypedDict):
    Name: str,
    AuthorizerCredentialsArn: NotRequired[str],
    AuthorizerId: NotRequired[str],
    AuthorizerPayloadFormatVersion: NotRequired[str],
    AuthorizerResultTtlInSeconds: NotRequired[int],
    AuthorizerType: NotRequired[AuthorizerTypeType],  # (1)
    AuthorizerUri: NotRequired[str],
    EnableSimpleResponses: NotRequired[bool],
    IdentitySource: NotRequired[List[str]],
    IdentityValidationExpression: NotRequired[str],
    JwtConfiguration: NotRequired[JWTConfigurationTypeDef],  # (2)

See AuthorizerTypeType
See JWTConfigurationTypeDef

CreateAuthorizerRequestRequestTypeDef#

# CreateAuthorizerRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateAuthorizerRequestRequestTypeDef

def get_value() -> CreateAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerType": ...,
        "IdentitySource": ...,
        "Name": ...,
    }

# CreateAuthorizerRequestRequestTypeDef definition

class CreateAuthorizerRequestRequestTypeDef(TypedDict):
    ApiId: str,
    AuthorizerType: AuthorizerTypeType,  # (1)
    IdentitySource: Sequence[str],
    Name: str,
    AuthorizerCredentialsArn: NotRequired[str],
    AuthorizerPayloadFormatVersion: NotRequired[str],
    AuthorizerResultTtlInSeconds: NotRequired[int],
    AuthorizerUri: NotRequired[str],
    EnableSimpleResponses: NotRequired[bool],
    IdentityValidationExpression: NotRequired[str],
    JwtConfiguration: NotRequired[JWTConfigurationTypeDef],  # (2)

See AuthorizerTypeType
See JWTConfigurationTypeDef

CreateAuthorizerResponseTypeDef#

# CreateAuthorizerResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateAuthorizerResponseTypeDef

def get_value() -> CreateAuthorizerResponseTypeDef:
    return {
        "AuthorizerCredentialsArn": ...,
        "AuthorizerId": ...,
        "AuthorizerPayloadFormatVersion": ...,
        "AuthorizerResultTtlInSeconds": ...,
        "AuthorizerType": ...,
        "AuthorizerUri": ...,
        "EnableSimpleResponses": ...,
        "IdentitySource": ...,
        "IdentityValidationExpression": ...,
        "JwtConfiguration": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }

# CreateAuthorizerResponseTypeDef definition

class CreateAuthorizerResponseTypeDef(TypedDict):
    AuthorizerCredentialsArn: str,
    AuthorizerId: str,
    AuthorizerPayloadFormatVersion: str,
    AuthorizerResultTtlInSeconds: int,
    AuthorizerType: AuthorizerTypeType,  # (1)
    AuthorizerUri: str,
    EnableSimpleResponses: bool,
    IdentitySource: List[str],
    IdentityValidationExpression: str,
    JwtConfiguration: JWTConfigurationTypeDef,  # (2)
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GetAuthorizerResponseTypeDef#

# GetAuthorizerResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizerResponseTypeDef

def get_value() -> GetAuthorizerResponseTypeDef:
    return {
        "AuthorizerCredentialsArn": ...,
        "AuthorizerId": ...,
        "AuthorizerPayloadFormatVersion": ...,
        "AuthorizerResultTtlInSeconds": ...,
        "AuthorizerType": ...,
        "AuthorizerUri": ...,
        "EnableSimpleResponses": ...,
        "IdentitySource": ...,
        "IdentityValidationExpression": ...,
        "JwtConfiguration": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }

# GetAuthorizerResponseTypeDef definition

class GetAuthorizerResponseTypeDef(TypedDict):
    AuthorizerCredentialsArn: str,
    AuthorizerId: str,
    AuthorizerPayloadFormatVersion: str,
    AuthorizerResultTtlInSeconds: int,
    AuthorizerType: AuthorizerTypeType,  # (1)
    AuthorizerUri: str,
    EnableSimpleResponses: bool,
    IdentitySource: List[str],
    IdentityValidationExpression: str,
    JwtConfiguration: JWTConfigurationTypeDef,  # (2)
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

UpdateAuthorizerRequestRequestTypeDef#

# UpdateAuthorizerRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateAuthorizerRequestRequestTypeDef

def get_value() -> UpdateAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerId": ...,
    }

# UpdateAuthorizerRequestRequestTypeDef definition

class UpdateAuthorizerRequestRequestTypeDef(TypedDict):
    ApiId: str,
    AuthorizerId: str,
    AuthorizerCredentialsArn: NotRequired[str],
    AuthorizerPayloadFormatVersion: NotRequired[str],
    AuthorizerResultTtlInSeconds: NotRequired[int],
    AuthorizerType: NotRequired[AuthorizerTypeType],  # (1)
    AuthorizerUri: NotRequired[str],
    EnableSimpleResponses: NotRequired[bool],
    IdentitySource: NotRequired[Sequence[str]],
    IdentityValidationExpression: NotRequired[str],
    JwtConfiguration: NotRequired[JWTConfigurationTypeDef],  # (2)
    Name: NotRequired[str],

See AuthorizerTypeType
See JWTConfigurationTypeDef

UpdateAuthorizerResponseTypeDef#

# UpdateAuthorizerResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateAuthorizerResponseTypeDef

def get_value() -> UpdateAuthorizerResponseTypeDef:
    return {
        "AuthorizerCredentialsArn": ...,
        "AuthorizerId": ...,
        "AuthorizerPayloadFormatVersion": ...,
        "AuthorizerResultTtlInSeconds": ...,
        "AuthorizerType": ...,
        "AuthorizerUri": ...,
        "EnableSimpleResponses": ...,
        "IdentitySource": ...,
        "IdentityValidationExpression": ...,
        "JwtConfiguration": ...,
        "Name": ...,
        "ResponseMetadata": ...,
    }

# UpdateAuthorizerResponseTypeDef definition

class UpdateAuthorizerResponseTypeDef(TypedDict):
    AuthorizerCredentialsArn: str,
    AuthorizerId: str,
    AuthorizerPayloadFormatVersion: str,
    AuthorizerResultTtlInSeconds: int,
    AuthorizerType: AuthorizerTypeType,  # (1)
    AuthorizerUri: str,
    EnableSimpleResponses: bool,
    IdentitySource: List[str],
    IdentityValidationExpression: str,
    JwtConfiguration: JWTConfigurationTypeDef,  # (2)
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

CreateDomainNameRequestRequestTypeDef#

# CreateDomainNameRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateDomainNameRequestRequestTypeDef

def get_value() -> CreateDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# CreateDomainNameRequestRequestTypeDef definition

class CreateDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DomainNameConfigurations: NotRequired[Sequence[DomainNameConfigurationTypeDef]],  # (1)
    MutualTlsAuthentication: NotRequired[MutualTlsAuthenticationInputTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],

UpdateDomainNameRequestRequestTypeDef#

# UpdateDomainNameRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateDomainNameRequestRequestTypeDef

def get_value() -> UpdateDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }

# UpdateDomainNameRequestRequestTypeDef definition

class UpdateDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,
    DomainNameConfigurations: NotRequired[Sequence[DomainNameConfigurationTypeDef]],  # (1)
    MutualTlsAuthentication: NotRequired[MutualTlsAuthenticationInputTypeDef],  # (2)

CreateDomainNameResponseTypeDef#

# CreateDomainNameResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateDomainNameResponseTypeDef

def get_value() -> CreateDomainNameResponseTypeDef:
    return {
        "ApiMappingSelectionExpression": ...,
        "DomainName": ...,
        "DomainNameConfigurations": ...,
        "MutualTlsAuthentication": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# CreateDomainNameResponseTypeDef definition

class CreateDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: List[DomainNameConfigurationTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

DomainNameTypeDef#

# DomainNameTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import DomainNameTypeDef

def get_value() -> DomainNameTypeDef:
    return {
        "DomainName": ...,
    }

# DomainNameTypeDef definition

class DomainNameTypeDef(TypedDict):
    DomainName: str,
    ApiMappingSelectionExpression: NotRequired[str],
    DomainNameConfigurations: NotRequired[List[DomainNameConfigurationTypeDef]],  # (1)
    MutualTlsAuthentication: NotRequired[MutualTlsAuthenticationTypeDef],  # (2)
    Tags: NotRequired[Dict[str, str]],

GetDomainNameResponseTypeDef#

# GetDomainNameResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNameResponseTypeDef

def get_value() -> GetDomainNameResponseTypeDef:
    return {
        "ApiMappingSelectionExpression": ...,
        "DomainName": ...,
        "DomainNameConfigurations": ...,
        "MutualTlsAuthentication": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# GetDomainNameResponseTypeDef definition

class GetDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: List[DomainNameConfigurationTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

UpdateDomainNameResponseTypeDef#

# UpdateDomainNameResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateDomainNameResponseTypeDef

def get_value() -> UpdateDomainNameResponseTypeDef:
    return {
        "ApiMappingSelectionExpression": ...,
        "DomainName": ...,
        "DomainNameConfigurations": ...,
        "MutualTlsAuthentication": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# UpdateDomainNameResponseTypeDef definition

class UpdateDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: List[DomainNameConfigurationTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

CreateIntegrationRequestRequestTypeDef#

# CreateIntegrationRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationRequestRequestTypeDef

def get_value() -> CreateIntegrationRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationType": ...,
    }

# CreateIntegrationRequestRequestTypeDef definition

class CreateIntegrationRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationType: IntegrationTypeType,  # (1)
    ConnectionId: NotRequired[str],
    ConnectionType: NotRequired[ConnectionTypeType],  # (2)
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (3)
    CredentialsArn: NotRequired[str],
    Description: NotRequired[str],
    IntegrationMethod: NotRequired[str],
    IntegrationSubtype: NotRequired[str],
    IntegrationUri: NotRequired[str],
    PassthroughBehavior: NotRequired[PassthroughBehaviorType],  # (4)
    PayloadFormatVersion: NotRequired[str],
    RequestParameters: NotRequired[Mapping[str, str]],
    RequestTemplates: NotRequired[Mapping[str, str]],
    ResponseParameters: NotRequired[Mapping[str, Mapping[str, str]]],
    TemplateSelectionExpression: NotRequired[str],
    TimeoutInMillis: NotRequired[int],
    TlsConfig: NotRequired[TlsConfigInputTypeDef],  # (5)

UpdateIntegrationRequestRequestTypeDef#

# UpdateIntegrationRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationRequestRequestTypeDef

def get_value() -> UpdateIntegrationRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }

# UpdateIntegrationRequestRequestTypeDef definition

class UpdateIntegrationRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    ConnectionId: NotRequired[str],
    ConnectionType: NotRequired[ConnectionTypeType],  # (1)
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (2)
    CredentialsArn: NotRequired[str],
    Description: NotRequired[str],
    IntegrationMethod: NotRequired[str],
    IntegrationSubtype: NotRequired[str],
    IntegrationType: NotRequired[IntegrationTypeType],  # (3)
    IntegrationUri: NotRequired[str],
    PassthroughBehavior: NotRequired[PassthroughBehaviorType],  # (4)
    PayloadFormatVersion: NotRequired[str],
    RequestParameters: NotRequired[Mapping[str, str]],
    RequestTemplates: NotRequired[Mapping[str, str]],
    ResponseParameters: NotRequired[Mapping[str, Mapping[str, str]]],
    TemplateSelectionExpression: NotRequired[str],
    TimeoutInMillis: NotRequired[int],
    TlsConfig: NotRequired[TlsConfigInputTypeDef],  # (5)

CreateIntegrationResultTypeDef#

# CreateIntegrationResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationResultTypeDef

def get_value() -> CreateIntegrationResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ConnectionId": ...,
        "ConnectionType": ...,
        "ContentHandlingStrategy": ...,
        "CredentialsArn": ...,
        "Description": ...,
        "IntegrationId": ...,
        "IntegrationMethod": ...,
        "IntegrationResponseSelectionExpression": ...,
        "IntegrationSubtype": ...,
        "IntegrationType": ...,
        "IntegrationUri": ...,
        "PassthroughBehavior": ...,
        "PayloadFormatVersion": ...,
        "RequestParameters": ...,
        "RequestTemplates": ...,
        "ResponseParameters": ...,
        "TemplateSelectionExpression": ...,
        "TimeoutInMillis": ...,
        "TlsConfig": ...,
        "ResponseMetadata": ...,
    }

# CreateIntegrationResultTypeDef definition

class CreateIntegrationResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ConnectionId: str,
    ConnectionType: ConnectionTypeType,  # (1)
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (2)
    CredentialsArn: str,
    Description: str,
    IntegrationId: str,
    IntegrationMethod: str,
    IntegrationResponseSelectionExpression: str,
    IntegrationSubtype: str,
    IntegrationType: IntegrationTypeType,  # (3)
    IntegrationUri: str,
    PassthroughBehavior: PassthroughBehaviorType,  # (4)
    PayloadFormatVersion: str,
    RequestParameters: Dict[str, str],
    RequestTemplates: Dict[str, str],
    ResponseParameters: Dict[str, Dict[str, str]],
    TemplateSelectionExpression: str,
    TimeoutInMillis: int,
    TlsConfig: TlsConfigTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

GetIntegrationResultTypeDef#

# GetIntegrationResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResultTypeDef

def get_value() -> GetIntegrationResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ConnectionId": ...,
        "ConnectionType": ...,
        "ContentHandlingStrategy": ...,
        "CredentialsArn": ...,
        "Description": ...,
        "IntegrationId": ...,
        "IntegrationMethod": ...,
        "IntegrationResponseSelectionExpression": ...,
        "IntegrationSubtype": ...,
        "IntegrationType": ...,
        "IntegrationUri": ...,
        "PassthroughBehavior": ...,
        "PayloadFormatVersion": ...,
        "RequestParameters": ...,
        "RequestTemplates": ...,
        "ResponseParameters": ...,
        "TemplateSelectionExpression": ...,
        "TimeoutInMillis": ...,
        "TlsConfig": ...,
        "ResponseMetadata": ...,
    }

# GetIntegrationResultTypeDef definition

class GetIntegrationResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ConnectionId: str,
    ConnectionType: ConnectionTypeType,  # (1)
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (2)
    CredentialsArn: str,
    Description: str,
    IntegrationId: str,
    IntegrationMethod: str,
    IntegrationResponseSelectionExpression: str,
    IntegrationSubtype: str,
    IntegrationType: IntegrationTypeType,  # (3)
    IntegrationUri: str,
    PassthroughBehavior: PassthroughBehaviorType,  # (4)
    PayloadFormatVersion: str,
    RequestParameters: Dict[str, str],
    RequestTemplates: Dict[str, str],
    ResponseParameters: Dict[str, Dict[str, str]],
    TemplateSelectionExpression: str,
    TimeoutInMillis: int,
    TlsConfig: TlsConfigTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

IntegrationTypeDef#

# IntegrationTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import IntegrationTypeDef

def get_value() -> IntegrationTypeDef:
    return {
        "ApiGatewayManaged": ...,
    }

# IntegrationTypeDef definition

class IntegrationTypeDef(TypedDict):
    ApiGatewayManaged: NotRequired[bool],
    ConnectionId: NotRequired[str],
    ConnectionType: NotRequired[ConnectionTypeType],  # (1)
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (2)
    CredentialsArn: NotRequired[str],
    Description: NotRequired[str],
    IntegrationId: NotRequired[str],
    IntegrationMethod: NotRequired[str],
    IntegrationResponseSelectionExpression: NotRequired[str],
    IntegrationSubtype: NotRequired[str],
    IntegrationType: NotRequired[IntegrationTypeType],  # (3)
    IntegrationUri: NotRequired[str],
    PassthroughBehavior: NotRequired[PassthroughBehaviorType],  # (4)
    PayloadFormatVersion: NotRequired[str],
    RequestParameters: NotRequired[Dict[str, str]],
    RequestTemplates: NotRequired[Dict[str, str]],
    ResponseParameters: NotRequired[Dict[str, Dict[str, str]]],
    TemplateSelectionExpression: NotRequired[str],
    TimeoutInMillis: NotRequired[int],
    TlsConfig: NotRequired[TlsConfigTypeDef],  # (5)

UpdateIntegrationResultTypeDef#

# UpdateIntegrationResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationResultTypeDef

def get_value() -> UpdateIntegrationResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ConnectionId": ...,
        "ConnectionType": ...,
        "ContentHandlingStrategy": ...,
        "CredentialsArn": ...,
        "Description": ...,
        "IntegrationId": ...,
        "IntegrationMethod": ...,
        "IntegrationResponseSelectionExpression": ...,
        "IntegrationSubtype": ...,
        "IntegrationType": ...,
        "IntegrationUri": ...,
        "PassthroughBehavior": ...,
        "PayloadFormatVersion": ...,
        "RequestParameters": ...,
        "RequestTemplates": ...,
        "ResponseParameters": ...,
        "TemplateSelectionExpression": ...,
        "TimeoutInMillis": ...,
        "TlsConfig": ...,
        "ResponseMetadata": ...,
    }

# UpdateIntegrationResultTypeDef definition

class UpdateIntegrationResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ConnectionId: str,
    ConnectionType: ConnectionTypeType,  # (1)
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (2)
    CredentialsArn: str,
    Description: str,
    IntegrationId: str,
    IntegrationMethod: str,
    IntegrationResponseSelectionExpression: str,
    IntegrationSubtype: str,
    IntegrationType: IntegrationTypeType,  # (3)
    IntegrationUri: str,
    PassthroughBehavior: PassthroughBehaviorType,  # (4)
    PayloadFormatVersion: str,
    RequestParameters: Dict[str, str],
    RequestTemplates: Dict[str, str],
    ResponseParameters: Dict[str, Dict[str, str]],
    TemplateSelectionExpression: str,
    TimeoutInMillis: int,
    TlsConfig: TlsConfigTypeDef,  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

CreateRouteRequestRequestTypeDef#

# CreateRouteRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteRequestRequestTypeDef

def get_value() -> CreateRouteRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteKey": ...,
    }

# CreateRouteRequestRequestTypeDef definition

class CreateRouteRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteKey: str,
    ApiKeyRequired: NotRequired[bool],
    AuthorizationScopes: NotRequired[Sequence[str]],
    AuthorizationType: NotRequired[AuthorizationTypeType],  # (1)
    AuthorizerId: NotRequired[str],
    ModelSelectionExpression: NotRequired[str],
    OperationName: NotRequired[str],
    RequestModels: NotRequired[Mapping[str, str]],
    RequestParameters: NotRequired[Mapping[str, ParameterConstraintsTypeDef]],  # (2)
    RouteResponseSelectionExpression: NotRequired[str],
    Target: NotRequired[str],

See AuthorizationTypeType
See ParameterConstraintsTypeDef

CreateRouteResponseRequestRequestTypeDef#

# CreateRouteResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteResponseRequestRequestTypeDef

def get_value() -> CreateRouteResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
        "RouteResponseKey": ...,
    }

# CreateRouteResponseRequestRequestTypeDef definition

class CreateRouteResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    RouteResponseKey: str,
    ModelSelectionExpression: NotRequired[str],
    ResponseModels: NotRequired[Mapping[str, str]],
    ResponseParameters: NotRequired[Mapping[str, ParameterConstraintsTypeDef]],  # (1)

See ParameterConstraintsTypeDef

CreateRouteResponseResponseTypeDef#

# CreateRouteResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteResponseResponseTypeDef

def get_value() -> CreateRouteResponseResponseTypeDef:
    return {
        "ModelSelectionExpression": ...,
        "ResponseModels": ...,
        "ResponseParameters": ...,
        "RouteResponseId": ...,
        "RouteResponseKey": ...,
        "ResponseMetadata": ...,
    }

# CreateRouteResponseResponseTypeDef definition

class CreateRouteResponseResponseTypeDef(TypedDict):
    ModelSelectionExpression: str,
    ResponseModels: Dict[str, str],
    ResponseParameters: Dict[str, ParameterConstraintsTypeDef],  # (1)
    RouteResponseId: str,
    RouteResponseKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ParameterConstraintsTypeDef
See ResponseMetadataTypeDef

CreateRouteResultTypeDef#

# CreateRouteResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteResultTypeDef

def get_value() -> CreateRouteResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ApiKeyRequired": ...,
        "AuthorizationScopes": ...,
        "AuthorizationType": ...,
        "AuthorizerId": ...,
        "ModelSelectionExpression": ...,
        "OperationName": ...,
        "RequestModels": ...,
        "RequestParameters": ...,
        "RouteId": ...,
        "RouteKey": ...,
        "RouteResponseSelectionExpression": ...,
        "Target": ...,
        "ResponseMetadata": ...,
    }

# CreateRouteResultTypeDef definition

class CreateRouteResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ApiKeyRequired: bool,
    AuthorizationScopes: List[str],
    AuthorizationType: AuthorizationTypeType,  # (1)
    AuthorizerId: str,
    ModelSelectionExpression: str,
    OperationName: str,
    RequestModels: Dict[str, str],
    RequestParameters: Dict[str, ParameterConstraintsTypeDef],  # (2)
    RouteId: str,
    RouteKey: str,
    RouteResponseSelectionExpression: str,
    Target: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GetRouteResponseResponseTypeDef#

# GetRouteResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponseResponseTypeDef

def get_value() -> GetRouteResponseResponseTypeDef:
    return {
        "ModelSelectionExpression": ...,
        "ResponseModels": ...,
        "ResponseParameters": ...,
        "RouteResponseId": ...,
        "RouteResponseKey": ...,
        "ResponseMetadata": ...,
    }

# GetRouteResponseResponseTypeDef definition

class GetRouteResponseResponseTypeDef(TypedDict):
    ModelSelectionExpression: str,
    ResponseModels: Dict[str, str],
    ResponseParameters: Dict[str, ParameterConstraintsTypeDef],  # (1)
    RouteResponseId: str,
    RouteResponseKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ParameterConstraintsTypeDef
See ResponseMetadataTypeDef

GetRouteResultTypeDef#

# GetRouteResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResultTypeDef

def get_value() -> GetRouteResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ApiKeyRequired": ...,
        "AuthorizationScopes": ...,
        "AuthorizationType": ...,
        "AuthorizerId": ...,
        "ModelSelectionExpression": ...,
        "OperationName": ...,
        "RequestModels": ...,
        "RequestParameters": ...,
        "RouteId": ...,
        "RouteKey": ...,
        "RouteResponseSelectionExpression": ...,
        "Target": ...,
        "ResponseMetadata": ...,
    }

# GetRouteResultTypeDef definition

class GetRouteResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ApiKeyRequired: bool,
    AuthorizationScopes: List[str],
    AuthorizationType: AuthorizationTypeType,  # (1)
    AuthorizerId: str,
    ModelSelectionExpression: str,
    OperationName: str,
    RequestModels: Dict[str, str],
    RequestParameters: Dict[str, ParameterConstraintsTypeDef],  # (2)
    RouteId: str,
    RouteKey: str,
    RouteResponseSelectionExpression: str,
    Target: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

RouteResponseTypeDef#

# RouteResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import RouteResponseTypeDef

def get_value() -> RouteResponseTypeDef:
    return {
        "RouteResponseKey": ...,
    }

# RouteResponseTypeDef definition

class RouteResponseTypeDef(TypedDict):
    RouteResponseKey: str,
    ModelSelectionExpression: NotRequired[str],
    ResponseModels: NotRequired[Dict[str, str]],
    ResponseParameters: NotRequired[Dict[str, ParameterConstraintsTypeDef]],  # (1)
    RouteResponseId: NotRequired[str],

See ParameterConstraintsTypeDef

RouteTypeDef#

# RouteTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import RouteTypeDef

def get_value() -> RouteTypeDef:
    return {
        "RouteKey": ...,
    }

# RouteTypeDef definition

class RouteTypeDef(TypedDict):
    RouteKey: str,
    ApiGatewayManaged: NotRequired[bool],
    ApiKeyRequired: NotRequired[bool],
    AuthorizationScopes: NotRequired[List[str]],
    AuthorizationType: NotRequired[AuthorizationTypeType],  # (1)
    AuthorizerId: NotRequired[str],
    ModelSelectionExpression: NotRequired[str],
    OperationName: NotRequired[str],
    RequestModels: NotRequired[Dict[str, str]],
    RequestParameters: NotRequired[Dict[str, ParameterConstraintsTypeDef]],  # (2)
    RouteId: NotRequired[str],
    RouteResponseSelectionExpression: NotRequired[str],
    Target: NotRequired[str],

See AuthorizationTypeType
See ParameterConstraintsTypeDef

UpdateRouteRequestRequestTypeDef#

# UpdateRouteRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteRequestRequestTypeDef

def get_value() -> UpdateRouteRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }

# UpdateRouteRequestRequestTypeDef definition

class UpdateRouteRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    ApiKeyRequired: NotRequired[bool],
    AuthorizationScopes: NotRequired[Sequence[str]],
    AuthorizationType: NotRequired[AuthorizationTypeType],  # (1)
    AuthorizerId: NotRequired[str],
    ModelSelectionExpression: NotRequired[str],
    OperationName: NotRequired[str],
    RequestModels: NotRequired[Mapping[str, str]],
    RequestParameters: NotRequired[Mapping[str, ParameterConstraintsTypeDef]],  # (2)
    RouteKey: NotRequired[str],
    RouteResponseSelectionExpression: NotRequired[str],
    Target: NotRequired[str],

See AuthorizationTypeType
See ParameterConstraintsTypeDef

UpdateRouteResponseRequestRequestTypeDef#

# UpdateRouteResponseRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteResponseRequestRequestTypeDef

def get_value() -> UpdateRouteResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
        "RouteResponseId": ...,
    }

# UpdateRouteResponseRequestRequestTypeDef definition

class UpdateRouteResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    RouteResponseId: str,
    ModelSelectionExpression: NotRequired[str],
    ResponseModels: NotRequired[Mapping[str, str]],
    ResponseParameters: NotRequired[Mapping[str, ParameterConstraintsTypeDef]],  # (1)
    RouteResponseKey: NotRequired[str],

See ParameterConstraintsTypeDef

UpdateRouteResponseResponseTypeDef#

# UpdateRouteResponseResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteResponseResponseTypeDef

def get_value() -> UpdateRouteResponseResponseTypeDef:
    return {
        "ModelSelectionExpression": ...,
        "ResponseModels": ...,
        "ResponseParameters": ...,
        "RouteResponseId": ...,
        "RouteResponseKey": ...,
        "ResponseMetadata": ...,
    }

# UpdateRouteResponseResponseTypeDef definition

class UpdateRouteResponseResponseTypeDef(TypedDict):
    ModelSelectionExpression: str,
    ResponseModels: Dict[str, str],
    ResponseParameters: Dict[str, ParameterConstraintsTypeDef],  # (1)
    RouteResponseId: str,
    RouteResponseKey: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ParameterConstraintsTypeDef
See ResponseMetadataTypeDef

UpdateRouteResultTypeDef#

# UpdateRouteResultTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteResultTypeDef

def get_value() -> UpdateRouteResultTypeDef:
    return {
        "ApiGatewayManaged": ...,
        "ApiKeyRequired": ...,
        "AuthorizationScopes": ...,
        "AuthorizationType": ...,
        "AuthorizerId": ...,
        "ModelSelectionExpression": ...,
        "OperationName": ...,
        "RequestModels": ...,
        "RequestParameters": ...,
        "RouteId": ...,
        "RouteKey": ...,
        "RouteResponseSelectionExpression": ...,
        "Target": ...,
        "ResponseMetadata": ...,
    }

# UpdateRouteResultTypeDef definition

class UpdateRouteResultTypeDef(TypedDict):
    ApiGatewayManaged: bool,
    ApiKeyRequired: bool,
    AuthorizationScopes: List[str],
    AuthorizationType: AuthorizationTypeType,  # (1)
    AuthorizerId: str,
    ModelSelectionExpression: str,
    OperationName: str,
    RequestModels: Dict[str, str],
    RequestParameters: Dict[str, ParameterConstraintsTypeDef],  # (2)
    RouteId: str,
    RouteKey: str,
    RouteResponseSelectionExpression: str,
    Target: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

CreateStageRequestRequestTypeDef#

# CreateStageRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateStageRequestRequestTypeDef

def get_value() -> CreateStageRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# CreateStageRequestRequestTypeDef definition

class CreateStageRequestRequestTypeDef(TypedDict):
    ApiId: str,
    StageName: str,
    AccessLogSettings: NotRequired[AccessLogSettingsTypeDef],  # (1)
    AutoDeploy: NotRequired[bool],
    ClientCertificateId: NotRequired[str],
    DefaultRouteSettings: NotRequired[RouteSettingsTypeDef],  # (2)
    DeploymentId: NotRequired[str],
    Description: NotRequired[str],
    RouteSettings: NotRequired[Mapping[str, RouteSettingsTypeDef]],  # (3)
    StageVariables: NotRequired[Mapping[str, str]],
    Tags: NotRequired[Mapping[str, str]],

CreateStageResponseTypeDef#

# CreateStageResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import CreateStageResponseTypeDef

def get_value() -> CreateStageResponseTypeDef:
    return {
        "AccessLogSettings": ...,
        "ApiGatewayManaged": ...,
        "AutoDeploy": ...,
        "ClientCertificateId": ...,
        "CreatedDate": ...,
        "DefaultRouteSettings": ...,
        "DeploymentId": ...,
        "Description": ...,
        "LastDeploymentStatusMessage": ...,
        "LastUpdatedDate": ...,
        "RouteSettings": ...,
        "StageName": ...,
        "StageVariables": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# CreateStageResponseTypeDef definition

class CreateStageResponseTypeDef(TypedDict):
    AccessLogSettings: AccessLogSettingsTypeDef,  # (1)
    ApiGatewayManaged: bool,
    AutoDeploy: bool,
    ClientCertificateId: str,
    CreatedDate: datetime,
    DefaultRouteSettings: RouteSettingsTypeDef,  # (2)
    DeploymentId: str,
    Description: str,
    LastDeploymentStatusMessage: str,
    LastUpdatedDate: datetime,
    RouteSettings: Dict[str, RouteSettingsTypeDef],  # (3)
    StageName: str,
    StageVariables: Dict[str, str],
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

GetStageResponseTypeDef#

# GetStageResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetStageResponseTypeDef

def get_value() -> GetStageResponseTypeDef:
    return {
        "AccessLogSettings": ...,
        "ApiGatewayManaged": ...,
        "AutoDeploy": ...,
        "ClientCertificateId": ...,
        "CreatedDate": ...,
        "DefaultRouteSettings": ...,
        "DeploymentId": ...,
        "Description": ...,
        "LastDeploymentStatusMessage": ...,
        "LastUpdatedDate": ...,
        "RouteSettings": ...,
        "StageName": ...,
        "StageVariables": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# GetStageResponseTypeDef definition

class GetStageResponseTypeDef(TypedDict):
    AccessLogSettings: AccessLogSettingsTypeDef,  # (1)
    ApiGatewayManaged: bool,
    AutoDeploy: bool,
    ClientCertificateId: str,
    CreatedDate: datetime,
    DefaultRouteSettings: RouteSettingsTypeDef,  # (2)
    DeploymentId: str,
    Description: str,
    LastDeploymentStatusMessage: str,
    LastUpdatedDate: datetime,
    RouteSettings: Dict[str, RouteSettingsTypeDef],  # (3)
    StageName: str,
    StageVariables: Dict[str, str],
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

StageTypeDef#

# StageTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import StageTypeDef

def get_value() -> StageTypeDef:
    return {
        "StageName": ...,
    }

# StageTypeDef definition

class StageTypeDef(TypedDict):
    StageName: str,
    AccessLogSettings: NotRequired[AccessLogSettingsTypeDef],  # (1)
    ApiGatewayManaged: NotRequired[bool],
    AutoDeploy: NotRequired[bool],
    ClientCertificateId: NotRequired[str],
    CreatedDate: NotRequired[datetime],
    DefaultRouteSettings: NotRequired[RouteSettingsTypeDef],  # (2)
    DeploymentId: NotRequired[str],
    Description: NotRequired[str],
    LastDeploymentStatusMessage: NotRequired[str],
    LastUpdatedDate: NotRequired[datetime],
    RouteSettings: NotRequired[Dict[str, RouteSettingsTypeDef]],  # (3)
    StageVariables: NotRequired[Dict[str, str]],
    Tags: NotRequired[Dict[str, str]],

UpdateStageRequestRequestTypeDef#

# UpdateStageRequestRequestTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateStageRequestRequestTypeDef

def get_value() -> UpdateStageRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "StageName": ...,
    }

# UpdateStageRequestRequestTypeDef definition

class UpdateStageRequestRequestTypeDef(TypedDict):
    ApiId: str,
    StageName: str,
    AccessLogSettings: NotRequired[AccessLogSettingsTypeDef],  # (1)
    AutoDeploy: NotRequired[bool],
    ClientCertificateId: NotRequired[str],
    DefaultRouteSettings: NotRequired[RouteSettingsTypeDef],  # (2)
    DeploymentId: NotRequired[str],
    Description: NotRequired[str],
    RouteSettings: NotRequired[Mapping[str, RouteSettingsTypeDef]],  # (3)
    StageVariables: NotRequired[Mapping[str, str]],

UpdateStageResponseTypeDef#

# UpdateStageResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import UpdateStageResponseTypeDef

def get_value() -> UpdateStageResponseTypeDef:
    return {
        "AccessLogSettings": ...,
        "ApiGatewayManaged": ...,
        "AutoDeploy": ...,
        "ClientCertificateId": ...,
        "CreatedDate": ...,
        "DefaultRouteSettings": ...,
        "DeploymentId": ...,
        "Description": ...,
        "LastDeploymentStatusMessage": ...,
        "LastUpdatedDate": ...,
        "RouteSettings": ...,
        "StageName": ...,
        "StageVariables": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# UpdateStageResponseTypeDef definition

class UpdateStageResponseTypeDef(TypedDict):
    AccessLogSettings: AccessLogSettingsTypeDef,  # (1)
    ApiGatewayManaged: bool,
    AutoDeploy: bool,
    ClientCertificateId: str,
    CreatedDate: datetime,
    DefaultRouteSettings: RouteSettingsTypeDef,  # (2)
    DeploymentId: str,
    Description: str,
    LastDeploymentStatusMessage: str,
    LastUpdatedDate: datetime,
    RouteSettings: Dict[str, RouteSettingsTypeDef],  # (3)
    StageName: str,
    StageVariables: Dict[str, str],
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

GetDeploymentsResponseTypeDef#

# GetDeploymentsResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsResponseTypeDef

def get_value() -> GetDeploymentsResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetDeploymentsResponseTypeDef definition

class GetDeploymentsResponseTypeDef(TypedDict):
    Items: List[DeploymentTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DeploymentTypeDef
See ResponseMetadataTypeDef

GetIntegrationResponsesResponseTypeDef#

# GetIntegrationResponsesResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesResponseTypeDef

def get_value() -> GetIntegrationResponsesResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetIntegrationResponsesResponseTypeDef definition

class GetIntegrationResponsesResponseTypeDef(TypedDict):
    Items: List[IntegrationResponseTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See IntegrationResponseTypeDef
See ResponseMetadataTypeDef

GetModelsResponseTypeDef#

# GetModelsResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetModelsResponseTypeDef

def get_value() -> GetModelsResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetModelsResponseTypeDef definition

class GetModelsResponseTypeDef(TypedDict):
    Items: List[ModelTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ModelTypeDef
See ResponseMetadataTypeDef

GetVpcLinksResponseTypeDef#

# GetVpcLinksResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetVpcLinksResponseTypeDef

def get_value() -> GetVpcLinksResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetVpcLinksResponseTypeDef definition

class GetVpcLinksResponseTypeDef(TypedDict):
    Items: List[VpcLinkTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See VpcLinkTypeDef
See ResponseMetadataTypeDef

GetApisResponseTypeDef#

# GetApisResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetApisResponseTypeDef

def get_value() -> GetApisResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetApisResponseTypeDef definition

class GetApisResponseTypeDef(TypedDict):
    Items: List[ApiTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ApiTypeDef
See ResponseMetadataTypeDef

GetAuthorizersResponseTypeDef#

# GetAuthorizersResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersResponseTypeDef

def get_value() -> GetAuthorizersResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetAuthorizersResponseTypeDef definition

class GetAuthorizersResponseTypeDef(TypedDict):
    Items: List[AuthorizerTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See AuthorizerTypeDef
See ResponseMetadataTypeDef

GetDomainNamesResponseTypeDef#

# GetDomainNamesResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesResponseTypeDef

def get_value() -> GetDomainNamesResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetDomainNamesResponseTypeDef definition

class GetDomainNamesResponseTypeDef(TypedDict):
    Items: List[DomainNameTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DomainNameTypeDef
See ResponseMetadataTypeDef

GetIntegrationsResponseTypeDef#

# GetIntegrationsResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsResponseTypeDef

def get_value() -> GetIntegrationsResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetIntegrationsResponseTypeDef definition

class GetIntegrationsResponseTypeDef(TypedDict):
    Items: List[IntegrationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See IntegrationTypeDef
See ResponseMetadataTypeDef

GetRouteResponsesResponseTypeDef#

# GetRouteResponsesResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesResponseTypeDef

def get_value() -> GetRouteResponsesResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetRouteResponsesResponseTypeDef definition

class GetRouteResponsesResponseTypeDef(TypedDict):
    Items: List[RouteResponseTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See RouteResponseTypeDef
See ResponseMetadataTypeDef

GetRoutesResponseTypeDef#

# GetRoutesResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetRoutesResponseTypeDef

def get_value() -> GetRoutesResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetRoutesResponseTypeDef definition

class GetRoutesResponseTypeDef(TypedDict):
    Items: List[RouteTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See RouteTypeDef
See ResponseMetadataTypeDef

GetStagesResponseTypeDef#

# GetStagesResponseTypeDef usage example

from mypy_boto3_apigatewayv2.type_defs import GetStagesResponseTypeDef

def get_value() -> GetStagesResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# GetStagesResponseTypeDef definition

class GetStagesResponseTypeDef(TypedDict):
    Items: List[StageTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See StageTypeDef
See ResponseMetadataTypeDef