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 ResponseMetadataTypeDef

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": ...,
    }

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)

1. See CorsTypeDef
2. See ProtocolTypeType
3. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See AuthorizerTypeType
2. See JWTConfigurationTypeDef
3. See ResponseMetadataTypeDef

UpdateDeploymentResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateDeploymentResponseTypeDef

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

Definition

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

1. See DeploymentStatusType
2. See ResponseMetadataTypeDef

UpdateIntegrationResponseResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationResponseResponseTypeDef

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

Definition

class UpdateIntegrationResponseResponseTypeDef(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

UpdateModelResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateModelResponseTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See VpcLinkStatusType
2. See VpcLinkVersionType
3. See ResponseMetadataTypeDef

CreateDomainNameRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateDomainNameRequestRequestTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationInputTypeDef

UpdateDomainNameRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateDomainNameRequestRequestTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationInputTypeDef

CreateDomainNameResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateDomainNameResponseTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationTypeDef
3. See ResponseMetadataTypeDef

DomainNameTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import DomainNameTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationTypeDef

GetDomainNameResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNameResponseTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationTypeDef
3. See ResponseMetadataTypeDef

UpdateDomainNameResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateDomainNameResponseTypeDef

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

Definition

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

1. See DomainNameConfigurationTypeDef
2. See MutualTlsAuthenticationTypeDef
3. See ResponseMetadataTypeDef

CreateIntegrationRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateIntegrationRequestRequestTypeDef

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

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)

1. See IntegrationTypeType
2. See ConnectionTypeType
3. See ContentHandlingStrategyType
4. See PassthroughBehaviorType
5. See TlsConfigInputTypeDef

UpdateIntegrationRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateIntegrationRequestRequestTypeDef

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

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)

1. See ConnectionTypeType
2. See ContentHandlingStrategyType
3. See IntegrationTypeType
4. See PassthroughBehaviorType
5. See TlsConfigInputTypeDef

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": ...,
    }

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)

1. See ConnectionTypeType
2. See ContentHandlingStrategyType
3. See IntegrationTypeType
4. See PassthroughBehaviorType
5. See TlsConfigTypeDef
6. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See ConnectionTypeType
2. See ContentHandlingStrategyType
3. See IntegrationTypeType
4. See PassthroughBehaviorType
5. See TlsConfigTypeDef
6. See ResponseMetadataTypeDef

IntegrationTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import IntegrationTypeDef

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

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)

1. See ConnectionTypeType
2. See ContentHandlingStrategyType
3. See IntegrationTypeType
4. See PassthroughBehaviorType
5. See TlsConfigTypeDef

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": ...,
    }

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)

1. See ConnectionTypeType
2. See ContentHandlingStrategyType
3. See IntegrationTypeType
4. See PassthroughBehaviorType
5. See TlsConfigTypeDef
6. See ResponseMetadataTypeDef

CreateRouteRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteRequestRequestTypeDef

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

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

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef

CreateRouteResponseRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteResponseRequestRequestTypeDef

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

Definition

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

1. See ParameterConstraintsTypeDef

CreateRouteResponseResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateRouteResponseResponseTypeDef

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

Definition

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

1. See ParameterConstraintsTypeDef
2. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef
3. See ResponseMetadataTypeDef

GetRouteResponseResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponseResponseTypeDef

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

Definition

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

1. See ParameterConstraintsTypeDef
2. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef
3. See ResponseMetadataTypeDef

RouteResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import RouteResponseTypeDef

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

Definition

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

1. See ParameterConstraintsTypeDef

RouteTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import RouteTypeDef

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

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

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef

UpdateRouteRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteRequestRequestTypeDef

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

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

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef

UpdateRouteResponseRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteResponseRequestRequestTypeDef

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

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

1. See ParameterConstraintsTypeDef

UpdateRouteResponseResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateRouteResponseResponseTypeDef

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

Definition

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

1. See ParameterConstraintsTypeDef
2. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See AuthorizationTypeType
2. See ParameterConstraintsTypeDef
3. See ResponseMetadataTypeDef

CreateStageRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import CreateStageRequestRequestTypeDef

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

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

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef

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": ...,
    }

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)

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef
4. See ResponseMetadataTypeDef

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": ...,
    }

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)

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef
4. See ResponseMetadataTypeDef

StageTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import StageTypeDef

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

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

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef

UpdateStageRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import UpdateStageRequestRequestTypeDef

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

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

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef

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": ...,
    }

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)

1. See AccessLogSettingsTypeDef
2. See RouteSettingsTypeDef
3. See RouteSettingsTypeDef
4. See ResponseMetadataTypeDef

GetDeploymentsResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsResponseTypeDef

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

Definition

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

1. See DeploymentTypeDef
2. See ResponseMetadataTypeDef

GetApisRequestGetApisPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetApisRequestGetApisPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetAuthorizersRequestGetAuthorizersPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersRequestGetAuthorizersPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetDeploymentsRequestGetDeploymentsPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetDeploymentsRequestGetDeploymentsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetDomainNamesRequestGetDomainNamesPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesRequestGetDomainNamesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesRequestGetIntegrationResponsesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetIntegrationsRequestGetIntegrationsPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsRequestGetIntegrationsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetModelsRequestGetModelsPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetModelsRequestGetModelsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesRequestGetRouteResponsesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetRoutesRequestGetRoutesPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetRoutesRequestGetRoutesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetStagesRequestGetStagesPaginateTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetStagesRequestGetStagesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

GetIntegrationResponsesResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationResponsesResponseTypeDef

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

Definition

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

1. See IntegrationResponseTypeDef
2. See ResponseMetadataTypeDef

GetModelsResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetModelsResponseTypeDef

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

Definition

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

1. See ModelTypeDef
2. See ResponseMetadataTypeDef

GetVpcLinksResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetVpcLinksResponseTypeDef

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

Definition

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

1. See VpcLinkTypeDef
2. See ResponseMetadataTypeDef

GetApisResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetApisResponseTypeDef

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

Definition

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

1. See ApiTypeDef
2. See ResponseMetadataTypeDef

GetAuthorizersResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetAuthorizersResponseTypeDef

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

Definition

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

1. See AuthorizerTypeDef
2. See ResponseMetadataTypeDef

GetDomainNamesResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetDomainNamesResponseTypeDef

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

Definition

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

1. See DomainNameTypeDef
2. See ResponseMetadataTypeDef

GetIntegrationsResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetIntegrationsResponseTypeDef

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

Definition

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

1. See IntegrationTypeDef
2. See ResponseMetadataTypeDef

GetRouteResponsesResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetRouteResponsesResponseTypeDef

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

Definition

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

1. See RouteResponseTypeDef
2. See ResponseMetadataTypeDef

GetRoutesResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetRoutesResponseTypeDef

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

Definition

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

1. See RouteTypeDef
2. See ResponseMetadataTypeDef

GetStagesResponseTypeDef

Usage Example

from mypy_boto3_apigatewayv2.type_defs import GetStagesResponseTypeDef

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

Definition

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

1. See StageTypeDef
2. See ResponseMetadataTypeDef