Skip to content

Typed dictionaries

Index > ApiGatewayV2 > Typed dictionaries

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

AccessLogSettingsTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import AccessLogSettingsTypeDef

def get_value() -> AccessLogSettingsTypeDef:
    return {
        "DestinationArn": ...,
    }
Definition
class AccessLogSettingsTypeDef(TypedDict):
    DestinationArn: NotRequired[str],
    Format: NotRequired[str],

ApiMappingTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ApiMappingTypeDef

def get_value() -> ApiMappingTypeDef:
    return {
        "ApiId": ...,
        "Stage": ...,
    }
Definition
class ApiMappingTypeDef(TypedDict):
    ApiId: str,
    Stage: str,
    ApiMappingId: NotRequired[str],
    ApiMappingKey: NotRequired[str],

CorsTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CorsTypeDef

def get_value() -> CorsTypeDef:
    return {
        "AllowCredentials": ...,
    }
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

Usage Example
from mypy_boto3_apigatewayv2.type_defs import JWTConfigurationTypeDef

def get_value() -> JWTConfigurationTypeDef:
    return {
        "Audience": ...,
    }
Definition
class JWTConfigurationTypeDef(TypedDict):
    Audience: NotRequired[Sequence[str]],
    Issuer: NotRequired[str],

CreateApiMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateApiMappingRequestRequestTypeDef

def get_value() -> CreateApiMappingRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DomainName": ...,
        "Stage": ...,
    }
Definition
class CreateApiMappingRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DomainName: str,
    Stage: str,
    ApiMappingKey: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateDeploymentRequestRequestTypeDef

def get_value() -> CreateDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class CreateDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Description: NotRequired[str],
    StageName: NotRequired[str],

DomainNameConfigurationTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DomainNameConfigurationTypeDef

def get_value() -> DomainNameConfigurationTypeDef:
    return {
        "ApiGatewayDomainName": ...,
    }
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],
  1. See DomainNameStatusType
  2. See EndpointTypeType
  3. See SecurityPolicyType

MutualTlsAuthenticationInputTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import MutualTlsAuthenticationInputTypeDef

def get_value() -> MutualTlsAuthenticationInputTypeDef:
    return {
        "TruststoreUri": ...,
    }
Definition
class MutualTlsAuthenticationInputTypeDef(TypedDict):
    TruststoreUri: NotRequired[str],
    TruststoreVersion: NotRequired[str],

MutualTlsAuthenticationTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import MutualTlsAuthenticationTypeDef

def get_value() -> MutualTlsAuthenticationTypeDef:
    return {
        "TruststoreUri": ...,
    }
Definition
class MutualTlsAuthenticationTypeDef(TypedDict):
    TruststoreUri: NotRequired[str],
    TruststoreVersion: NotRequired[str],
    TruststoreWarnings: NotRequired[List[str]],

TlsConfigInputTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import TlsConfigInputTypeDef

def get_value() -> TlsConfigInputTypeDef:
    return {
        "ServerNameToVerify": ...,
    }
Definition
class TlsConfigInputTypeDef(TypedDict):
    ServerNameToVerify: NotRequired[str],

CreateIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationResponseRequestRequestTypeDef

def get_value() -> CreateIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseKey": ...,
    }
Definition
class CreateIntegrationResponseRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    IntegrationResponseKey: str,
    ContentHandlingStrategy: NotRequired[ContentHandlingStrategyType],  # (1)
    ResponseParameters: NotRequired[Mapping[str, str]],
    ResponseTemplates: NotRequired[Mapping[str, str]],
    TemplateSelectionExpression: NotRequired[str],
  1. See ContentHandlingStrategyType

TlsConfigTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import TlsConfigTypeDef

def get_value() -> TlsConfigTypeDef:
    return {
        "ServerNameToVerify": ...,
    }
Definition
class TlsConfigTypeDef(TypedDict):
    ServerNameToVerify: NotRequired[str],

CreateModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateModelRequestRequestTypeDef

def get_value() -> CreateModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "Name": ...,
        "Schema": ...,
    }
Definition
class CreateModelRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Name: str,
    Schema: str,
    ContentType: NotRequired[str],
    Description: NotRequired[str],

ParameterConstraintsTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ParameterConstraintsTypeDef

def get_value() -> ParameterConstraintsTypeDef:
    return {
        "Required": ...,
    }
Definition
class ParameterConstraintsTypeDef(TypedDict):
    Required: NotRequired[bool],

RouteSettingsTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import RouteSettingsTypeDef

def get_value() -> RouteSettingsTypeDef:
    return {
        "DataTraceEnabled": ...,
    }
Definition
class RouteSettingsTypeDef(TypedDict):
    DataTraceEnabled: NotRequired[bool],
    DetailedMetricsEnabled: NotRequired[bool],
    LoggingLevel: NotRequired[LoggingLevelType],  # (1)
    ThrottlingBurstLimit: NotRequired[int],
    ThrottlingRateLimit: NotRequired[float],
  1. See LoggingLevelType

CreateVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateVpcLinkRequestRequestTypeDef

def get_value() -> CreateVpcLinkRequestRequestTypeDef:
    return {
        "Name": ...,
        "SubnetIds": ...,
    }
Definition
class CreateVpcLinkRequestRequestTypeDef(TypedDict):
    Name: str,
    SubnetIds: Sequence[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Mapping[str, str]],

DeleteAccessLogSettingsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteAccessLogSettingsRequestRequestTypeDef

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

DeleteApiMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteApiMappingRequestRequestTypeDef

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

DeleteApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteApiRequestRequestTypeDef

def get_value() -> DeleteApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class DeleteApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteAuthorizerRequestRequestTypeDef

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

DeleteCorsConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteCorsConfigurationRequestRequestTypeDef

def get_value() -> DeleteCorsConfigurationRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class DeleteCorsConfigurationRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteDeploymentRequestRequestTypeDef

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

DeleteDomainNameRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteDomainNameRequestRequestTypeDef

def get_value() -> DeleteDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteIntegrationRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteIntegrationRequestRequestTypeDef

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

DeleteIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteIntegrationResponseRequestRequestTypeDef

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

DeleteModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteModelRequestRequestTypeDef

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

DeleteRouteRequestParameterRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteRouteRequestParameterRequestRequestTypeDef

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

DeleteRouteRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteRouteRequestRequestTypeDef

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

DeleteRouteResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteRouteResponseRequestRequestTypeDef

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

DeleteRouteSettingsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteRouteSettingsRequestRequestTypeDef

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

DeleteStageRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteStageRequestRequestTypeDef

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

DeleteVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeleteVpcLinkRequestRequestTypeDef

def get_value() -> DeleteVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }
Definition
class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

DeploymentTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import DeploymentTypeDef

def get_value() -> DeploymentTypeDef:
    return {
        "AutoDeployed": ...,
    }
Definition
class DeploymentTypeDef(TypedDict):
    AutoDeployed: NotRequired[bool],
    CreatedDate: NotRequired[datetime],
    DeploymentId: NotRequired[str],
    DeploymentStatus: NotRequired[DeploymentStatusType],  # (1)
    DeploymentStatusMessage: NotRequired[str],
    Description: NotRequired[str],
  1. See DeploymentStatusType

ExportApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ExportApiRequestRequestTypeDef

def get_value() -> ExportApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "OutputType": ...,
        "Specification": ...,
    }
Definition
class ExportApiRequestRequestTypeDef(TypedDict):
    ApiId: str,
    OutputType: JSONYAMLType,  # (1)
    Specification: OAS30Type,  # (2)
    ExportVersion: NotRequired[str],
    IncludeExtensions: NotRequired[bool],
    StageName: NotRequired[str],
  1. See JSONYAMLType
  2. See OAS30Type

GetApiMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApiMappingRequestRequestTypeDef

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

GetApiMappingsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApiMappingsRequestRequestTypeDef

def get_value() -> GetApiMappingsRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetApiMappingsRequestRequestTypeDef(TypedDict):
    DomainName: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApiRequestRequestTypeDef

def get_value() -> GetApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetApisRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApisRequestRequestTypeDef

def get_value() -> GetApisRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class GetApisRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetAuthorizerRequestRequestTypeDef

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

GetAuthorizersRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersRequestRequestTypeDef

def get_value() -> GetAuthorizersRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetAuthorizersRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetDeploymentRequestRequestTypeDef

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

GetDeploymentsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsRequestRequestTypeDef

def get_value() -> GetDeploymentsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetDeploymentsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetDomainNameRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetDomainNameRequestRequestTypeDef

def get_value() -> GetDomainNameRequestRequestTypeDef:
    return {
        "DomainName": ...,
    }
Definition
class GetDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetDomainNamesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesRequestRequestTypeDef

def get_value() -> GetDomainNamesRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class GetDomainNamesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetIntegrationRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetIntegrationRequestRequestTypeDef

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

GetIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponseRequestRequestTypeDef

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

GetIntegrationResponsesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesRequestRequestTypeDef

def get_value() -> GetIntegrationResponsesRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
    }
Definition
class GetIntegrationResponsesRequestRequestTypeDef(TypedDict):
    ApiId: str,
    IntegrationId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

IntegrationResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import IntegrationResponseTypeDef

def get_value() -> IntegrationResponseTypeDef:
    return {
        "IntegrationResponseKey": ...,
    }
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],
  1. See ContentHandlingStrategyType

GetIntegrationsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsRequestRequestTypeDef

def get_value() -> GetIntegrationsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetIntegrationsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetModelRequestRequestTypeDef

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

GetModelTemplateRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetModelTemplateRequestRequestTypeDef

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

GetModelsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetModelsRequestRequestTypeDef

def get_value() -> GetModelsRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetModelsRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

ModelTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ModelTypeDef

def get_value() -> ModelTypeDef:
    return {
        "Name": ...,
    }
Definition
class ModelTypeDef(TypedDict):
    Name: str,
    ContentType: NotRequired[str],
    Description: NotRequired[str],
    ModelId: NotRequired[str],
    Schema: NotRequired[str],

GetRouteRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetRouteRequestRequestTypeDef

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

GetRouteResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetRouteResponseRequestRequestTypeDef

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

GetRouteResponsesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesRequestRequestTypeDef

def get_value() -> GetRouteResponsesRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "RouteId": ...,
    }
Definition
class GetRouteResponsesRequestRequestTypeDef(TypedDict):
    ApiId: str,
    RouteId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetRoutesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetRoutesRequestRequestTypeDef

def get_value() -> GetRoutesRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetRoutesRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetStageRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetStageRequestRequestTypeDef

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

GetStagesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetStagesRequestRequestTypeDef

def get_value() -> GetStagesRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
Definition
class GetStagesRequestRequestTypeDef(TypedDict):
    ApiId: str,
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

GetTagsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetTagsRequestRequestTypeDef

def get_value() -> GetTagsRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class GetTagsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetVpcLinkRequestRequestTypeDef

def get_value() -> GetVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }
Definition
class GetVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

GetVpcLinksRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetVpcLinksRequestRequestTypeDef

def get_value() -> GetVpcLinksRequestRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class GetVpcLinksRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[str],
    NextToken: NotRequired[str],

VpcLinkTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import VpcLinkTypeDef

def get_value() -> VpcLinkTypeDef:
    return {
        "Name": ...,
        "SecurityGroupIds": ...,
        "SubnetIds": ...,
        "VpcLinkId": ...,
    }
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)
  1. See VpcLinkStatusType
  2. See VpcLinkVersionType

ImportApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ImportApiRequestRequestTypeDef

def get_value() -> ImportApiRequestRequestTypeDef:
    return {
        "Body": ...,
    }
Definition
class ImportApiRequestRequestTypeDef(TypedDict):
    Body: str,
    Basepath: NotRequired[str],
    FailOnWarnings: NotRequired[bool],

ReimportApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ReimportApiRequestRequestTypeDef

def get_value() -> ReimportApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "Body": ...,
    }
Definition
class ReimportApiRequestRequestTypeDef(TypedDict):
    ApiId: str,
    Body: str,
    Basepath: NotRequired[str],
    FailOnWarnings: NotRequired[bool],

ResetAuthorizersCacheRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ResetAuthorizersCacheRequestRequestTypeDef

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

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: NotRequired[Mapping[str, str]],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateApiMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateApiMappingRequestRequestTypeDef

def get_value() -> UpdateApiMappingRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "DomainName": ...,
    }
Definition
class UpdateApiMappingRequestRequestTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    DomainName: str,
    ApiMappingKey: NotRequired[str],
    Stage: NotRequired[str],

UpdateDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateDeploymentRequestRequestTypeDef

def get_value() -> UpdateDeploymentRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "DeploymentId": ...,
    }
Definition
class UpdateDeploymentRequestRequestTypeDef(TypedDict):
    ApiId: str,
    DeploymentId: str,
    Description: NotRequired[str],

UpdateIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationResponseRequestRequestTypeDef

def get_value() -> UpdateIntegrationResponseRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "IntegrationId": ...,
        "IntegrationResponseId": ...,
    }
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],
  1. See ContentHandlingStrategyType

UpdateModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateModelRequestRequestTypeDef

def get_value() -> UpdateModelRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "ModelId": ...,
    }
Definition
class UpdateModelRequestRequestTypeDef(TypedDict):
    ApiId: str,
    ModelId: str,
    ContentType: NotRequired[str],
    Description: NotRequired[str],
    Name: NotRequired[str],
    Schema: NotRequired[str],

UpdateVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateVpcLinkRequestRequestTypeDef

def get_value() -> UpdateVpcLinkRequestRequestTypeDef:
    return {
        "VpcLinkId": ...,
    }
Definition
class UpdateVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,
    Name: NotRequired[str],

ApiTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ApiTypeDef

def get_value() -> ApiTypeDef:
    return {
        "Name": ...,
        "ProtocolType": ...,
        "RouteSelectionExpression": ...,
    }
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]],
  1. See CorsTypeDef
  2. See ProtocolTypeType

CreateApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateApiRequestRequestTypeDef

def get_value() -> CreateApiRequestRequestTypeDef:
    return {
        "Name": ...,
        "ProtocolType": ...,
    }
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],
  1. See ProtocolTypeType
  2. See CorsTypeDef

UpdateApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateApiRequestRequestTypeDef

def get_value() -> UpdateApiRequestRequestTypeDef:
    return {
        "ApiId": ...,
    }
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],
  1. See CorsTypeDef

AuthorizerTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import AuthorizerTypeDef

def get_value() -> AuthorizerTypeDef:
    return {
        "Name": ...,
    }
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)
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef

CreateAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateAuthorizerRequestRequestTypeDef

def get_value() -> CreateAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerType": ...,
        "IdentitySource": ...,
        "Name": ...,
    }
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)
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef

UpdateAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateAuthorizerRequestRequestTypeDef

def get_value() -> UpdateAuthorizerRequestRequestTypeDef:
    return {
        "ApiId": ...,
        "AuthorizerId": ...,
    }
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],
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef

CreateApiMappingResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateApiMappingResponseTypeDef

def get_value() -> CreateApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See CorsTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef
  3. See ResponseMetadataTypeDef

CreateDeploymentResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateDeploymentResponseTypeDef

def get_value() -> CreateDeploymentResponseTypeDef:
    return {
        "AutoDeployed": ...,
        "CreatedDate": ...,
        "DeploymentId": ...,
        "DeploymentStatus": ...,
        "DeploymentStatusMessage": ...,
        "Description": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDeploymentResponseTypeDef(TypedDict):
    AutoDeployed: bool,
    CreatedDate: datetime,
    DeploymentId: str,
    DeploymentStatus: DeploymentStatusType,  # (1)
    DeploymentStatusMessage: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeploymentStatusType
  2. See ResponseMetadataTypeDef

CreateIntegrationResponseResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationResponseResponseTypeDef

def get_value() -> CreateIntegrationResponseResponseTypeDef:
    return {
        "ContentHandlingStrategy": ...,
        "IntegrationResponseId": ...,
        "IntegrationResponseKey": ...,
        "ResponseParameters": ...,
        "ResponseTemplates": ...,
        "TemplateSelectionExpression": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateIntegrationResponseResponseTypeDef(TypedDict):
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (1)
    IntegrationResponseId: str,
    IntegrationResponseKey: str,
    ResponseParameters: Dict[str, str],
    ResponseTemplates: Dict[str, str],
    TemplateSelectionExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentHandlingStrategyType
  2. See ResponseMetadataTypeDef

CreateModelResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import CreateModelResponseTypeDef

def get_value() -> CreateModelResponseTypeDef:
    return {
        "ContentType": ...,
        "Description": ...,
        "ModelId": ...,
        "Name": ...,
        "Schema": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateModelResponseTypeDef(TypedDict):
    ContentType: str,
    Description: str,
    ModelId: str,
    Name: str,
    Schema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See VpcLinkStatusType
  2. See VpcLinkVersionType
  3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportApiResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import ExportApiResponseTypeDef

def get_value() -> ExportApiResponseTypeDef:
    return {
        "body": ...,
        "ResponseMetadata": ...,
    }
Definition
class ExportApiResponseTypeDef(TypedDict):
    body: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetApiMappingResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApiMappingResponseTypeDef

def get_value() -> GetApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetApiMappingsResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetApiMappingsResponseTypeDef

def get_value() -> GetApiMappingsResponseTypeDef:
    return {
        "Items": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetApiMappingsResponseTypeDef(TypedDict):
    Items: List[ApiMappingTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiMappingTypeDef
  2. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See CorsTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See AuthorizerTypeType
  2. See JWTConfigurationTypeDef
  3. See ResponseMetadataTypeDef

GetDeploymentResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetDeploymentResponseTypeDef

def get_value() -> GetDeploymentResponseTypeDef:
    return {
        "AutoDeployed": ...,
        "CreatedDate": ...,
        "DeploymentId": ...,
        "DeploymentStatus": ...,
        "DeploymentStatusMessage": ...,
        "Description": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDeploymentResponseTypeDef(TypedDict):
    AutoDeployed: bool,
    CreatedDate: datetime,
    DeploymentId: str,
    DeploymentStatus: DeploymentStatusType,  # (1)
    DeploymentStatusMessage: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeploymentStatusType
  2. See ResponseMetadataTypeDef

GetIntegrationResponseResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponseResponseTypeDef

def get_value() -> GetIntegrationResponseResponseTypeDef:
    return {
        "ContentHandlingStrategy": ...,
        "IntegrationResponseId": ...,
        "IntegrationResponseKey": ...,
        "ResponseParameters": ...,
        "ResponseTemplates": ...,
        "TemplateSelectionExpression": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetIntegrationResponseResponseTypeDef(TypedDict):
    ContentHandlingStrategy: ContentHandlingStrategyType,  # (1)
    IntegrationResponseId: str,
    IntegrationResponseKey: str,
    ResponseParameters: Dict[str, str],
    ResponseTemplates: Dict[str, str],
    TemplateSelectionExpression: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentHandlingStrategyType
  2. See ResponseMetadataTypeDef

GetModelResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetModelResponseTypeDef

def get_value() -> GetModelResponseTypeDef:
    return {
        "ContentType": ...,
        "Description": ...,
        "ModelId": ...,
        "Name": ...,
        "Schema": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetModelResponseTypeDef(TypedDict):
    ContentType: str,
    Description: str,
    ModelId: str,
    Name: str,
    Schema: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetModelTemplateResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetModelTemplateResponseTypeDef

def get_value() -> GetModelTemplateResponseTypeDef:
    return {
        "Value": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetModelTemplateResponseTypeDef(TypedDict):
    Value: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTagsResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import GetTagsResponseTypeDef

def get_value() -> GetTagsResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetTagsResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See VpcLinkStatusType
  2. See VpcLinkVersionType
  3. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See CorsTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See CorsTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

UpdateApiMappingResponseTypeDef

Usage Example
from mypy_boto3_apigatewayv2.type_defs import UpdateApiMappingResponseTypeDef

def get_value() -> UpdateApiMappingResponseTypeDef:
    return {
        "ApiId": ...,
        "ApiMappingId": ...,
        "ApiMappingKey": ...,
        "Stage": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateApiMappingResponseTypeDef(TypedDict):
    ApiId: str,
    ApiMappingId: str,
    ApiMappingKey: str,
    Stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See