Skip to content

Type definitions#

Index > ApiGatewayV2 > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

DomainNameConfigurationUnionTypeDef#

# DomainNameConfigurationUnionTypeDef definition

DomainNameConfigurationUnionTypeDef = Union[
    DomainNameConfigurationTypeDef,  # (1)
    DomainNameConfigurationOutputTypeDef,  # (2)
]
  1. See DomainNameConfigurationTypeDef
  2. See DomainNameConfigurationOutputTypeDef

AccessLogSettingsTypeDef#

# AccessLogSettingsTypeDef definition

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

ApiMappingTypeDef#

# ApiMappingTypeDef definition

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

CorsOutputTypeDef#

# CorsOutputTypeDef definition

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

JWTConfigurationOutputTypeDef#

# JWTConfigurationOutputTypeDef definition

class JWTConfigurationOutputTypeDef(TypedDict):
    Audience: NotRequired[list[str]],
    Issuer: NotRequired[str],

CorsTypeDef#

# CorsTypeDef definition

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

CreateApiMappingRequestRequestTypeDef#

# CreateApiMappingRequestRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

JWTConfigurationTypeDef#

# JWTConfigurationTypeDef definition

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

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef definition

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

MutualTlsAuthenticationInputTypeDef#

# MutualTlsAuthenticationInputTypeDef definition

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

DomainNameConfigurationOutputTypeDef#

# DomainNameConfigurationOutputTypeDef definition

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

MutualTlsAuthenticationTypeDef#

# MutualTlsAuthenticationTypeDef definition

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

TlsConfigInputTypeDef#

# TlsConfigInputTypeDef definition

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

CreateIntegrationResponseRequestRequestTypeDef#

# CreateIntegrationResponseRequestRequestTypeDef definition

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

TlsConfigTypeDef#

# TlsConfigTypeDef definition

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

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef definition

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

ParameterConstraintsTypeDef#

# ParameterConstraintsTypeDef definition

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

RouteSettingsTypeDef#

# RouteSettingsTypeDef definition

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

CreateVpcLinkRequestRequestTypeDef#

# CreateVpcLinkRequestRequestTypeDef definition

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

DeleteAccessLogSettingsRequestRequestTypeDef#

# DeleteAccessLogSettingsRequestRequestTypeDef definition

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

DeleteApiMappingRequestRequestTypeDef#

# DeleteApiMappingRequestRequestTypeDef definition

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

DeleteApiRequestRequestTypeDef#

# DeleteApiRequestRequestTypeDef definition

class DeleteApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteAuthorizerRequestRequestTypeDef#

# DeleteAuthorizerRequestRequestTypeDef definition

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

DeleteCorsConfigurationRequestRequestTypeDef#

# DeleteCorsConfigurationRequestRequestTypeDef definition

class DeleteCorsConfigurationRequestRequestTypeDef(TypedDict):
    ApiId: str,

DeleteDeploymentRequestRequestTypeDef#

# DeleteDeploymentRequestRequestTypeDef definition

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

DeleteDomainNameRequestRequestTypeDef#

# DeleteDomainNameRequestRequestTypeDef definition

class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

DeleteIntegrationRequestRequestTypeDef#

# DeleteIntegrationRequestRequestTypeDef definition

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

DeleteIntegrationResponseRequestRequestTypeDef#

# DeleteIntegrationResponseRequestRequestTypeDef definition

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

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef definition

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

DeleteRouteRequestParameterRequestRequestTypeDef#

# DeleteRouteRequestParameterRequestRequestTypeDef definition

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

DeleteRouteRequestRequestTypeDef#

# DeleteRouteRequestRequestTypeDef definition

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

DeleteRouteResponseRequestRequestTypeDef#

# DeleteRouteResponseRequestRequestTypeDef definition

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

DeleteRouteSettingsRequestRequestTypeDef#

# DeleteRouteSettingsRequestRequestTypeDef definition

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

DeleteStageRequestRequestTypeDef#

# DeleteStageRequestRequestTypeDef definition

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

DeleteVpcLinkRequestRequestTypeDef#

# DeleteVpcLinkRequestRequestTypeDef definition

class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

DeploymentTypeDef#

# DeploymentTypeDef definition

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

ExportApiRequestRequestTypeDef#

# ExportApiRequestRequestTypeDef definition

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

GetApiMappingRequestRequestTypeDef#

# GetApiMappingRequestRequestTypeDef definition

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

GetApiMappingsRequestRequestTypeDef#

# GetApiMappingsRequestRequestTypeDef definition

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

GetApiRequestRequestTypeDef#

# GetApiRequestRequestTypeDef definition

class GetApiRequestRequestTypeDef(TypedDict):
    ApiId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetApisRequestRequestTypeDef#

# GetApisRequestRequestTypeDef definition

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

GetAuthorizerRequestRequestTypeDef#

# GetAuthorizerRequestRequestTypeDef definition

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

GetAuthorizersRequestRequestTypeDef#

# GetAuthorizersRequestRequestTypeDef definition

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

GetDeploymentRequestRequestTypeDef#

# GetDeploymentRequestRequestTypeDef definition

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

GetDeploymentsRequestRequestTypeDef#

# GetDeploymentsRequestRequestTypeDef definition

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

GetDomainNameRequestRequestTypeDef#

# GetDomainNameRequestRequestTypeDef definition

class GetDomainNameRequestRequestTypeDef(TypedDict):
    DomainName: str,

GetDomainNamesRequestRequestTypeDef#

# GetDomainNamesRequestRequestTypeDef definition

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

GetIntegrationRequestRequestTypeDef#

# GetIntegrationRequestRequestTypeDef definition

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

GetIntegrationResponseRequestRequestTypeDef#

# GetIntegrationResponseRequestRequestTypeDef definition

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

GetIntegrationResponsesRequestRequestTypeDef#

# GetIntegrationResponsesRequestRequestTypeDef definition

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

IntegrationResponseTypeDef#

# IntegrationResponseTypeDef definition

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

GetIntegrationsRequestRequestTypeDef#

# GetIntegrationsRequestRequestTypeDef definition

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

GetModelRequestRequestTypeDef#

# GetModelRequestRequestTypeDef definition

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

GetModelTemplateRequestRequestTypeDef#

# GetModelTemplateRequestRequestTypeDef definition

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

GetModelsRequestRequestTypeDef#

# GetModelsRequestRequestTypeDef definition

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

ModelTypeDef#

# ModelTypeDef definition

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

GetRouteRequestRequestTypeDef#

# GetRouteRequestRequestTypeDef definition

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

GetRouteResponseRequestRequestTypeDef#

# GetRouteResponseRequestRequestTypeDef definition

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

GetRouteResponsesRequestRequestTypeDef#

# GetRouteResponsesRequestRequestTypeDef definition

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

GetRoutesRequestRequestTypeDef#

# GetRoutesRequestRequestTypeDef definition

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

GetStageRequestRequestTypeDef#

# GetStageRequestRequestTypeDef definition

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

GetStagesRequestRequestTypeDef#

# GetStagesRequestRequestTypeDef definition

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

GetTagsRequestRequestTypeDef#

# GetTagsRequestRequestTypeDef definition

class GetTagsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

GetVpcLinkRequestRequestTypeDef#

# GetVpcLinkRequestRequestTypeDef definition

class GetVpcLinkRequestRequestTypeDef(TypedDict):
    VpcLinkId: str,

GetVpcLinksRequestRequestTypeDef#

# GetVpcLinksRequestRequestTypeDef definition

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

VpcLinkTypeDef#

# VpcLinkTypeDef definition

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

ImportApiRequestRequestTypeDef#

# ImportApiRequestRequestTypeDef definition

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

ReimportApiRequestRequestTypeDef#

# ReimportApiRequestRequestTypeDef definition

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

ResetAuthorizersCacheRequestRequestTypeDef#

# ResetAuthorizersCacheRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateApiMappingRequestRequestTypeDef#

# UpdateApiMappingRequestRequestTypeDef definition

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

UpdateDeploymentRequestRequestTypeDef#

# UpdateDeploymentRequestRequestTypeDef definition

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

UpdateIntegrationResponseRequestRequestTypeDef#

# UpdateIntegrationResponseRequestRequestTypeDef definition

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

UpdateModelRequestRequestTypeDef#

# UpdateModelRequestRequestTypeDef definition

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

UpdateVpcLinkRequestRequestTypeDef#

# UpdateVpcLinkRequestRequestTypeDef definition

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

ApiTypeDef#

# ApiTypeDef definition

class ApiTypeDef(TypedDict):
    Name: str,
    ProtocolType: ProtocolTypeType,  # (2)
    RouteSelectionExpression: str,
    ApiEndpoint: NotRequired[str],
    ApiGatewayManaged: NotRequired[bool],
    ApiId: NotRequired[str],
    ApiKeySelectionExpression: NotRequired[str],
    CorsConfiguration: NotRequired[CorsOutputTypeDef],  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType

AuthorizerTypeDef#

# AuthorizerTypeDef definition

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

CreateApiRequestRequestTypeDef#

# CreateApiRequestRequestTypeDef definition

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

UpdateApiRequestRequestTypeDef#

# UpdateApiRequestRequestTypeDef definition

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

CreateApiMappingResponseTypeDef#

# CreateApiMappingResponseTypeDef definition

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

CreateApiResponseTypeDef#

# CreateApiResponseTypeDef definition

class CreateApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsOutputTypeDef,  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

CreateAuthorizerResponseTypeDef#

# CreateAuthorizerResponseTypeDef definition

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

CreateDeploymentResponseTypeDef#

# CreateDeploymentResponseTypeDef 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#

# CreateIntegrationResponseResponseTypeDef definition

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

CreateModelResponseTypeDef#

# CreateModelResponseTypeDef definition

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

CreateVpcLinkResponseTypeDef#

# CreateVpcLinkResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ExportApiResponseTypeDef#

# ExportApiResponseTypeDef definition

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

GetApiMappingResponseTypeDef#

# GetApiMappingResponseTypeDef definition

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

GetApiMappingsResponseTypeDef#

# GetApiMappingsResponseTypeDef definition

class GetApiMappingsResponseTypeDef(TypedDict):
    Items: list[ApiMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ApiMappingTypeDef
  2. See ResponseMetadataTypeDef

GetApiResponseTypeDef#

# GetApiResponseTypeDef definition

class GetApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsOutputTypeDef,  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

GetAuthorizerResponseTypeDef#

# GetAuthorizerResponseTypeDef definition

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

GetDeploymentResponseTypeDef#

# GetDeploymentResponseTypeDef 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#

# GetIntegrationResponseResponseTypeDef definition

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

GetModelResponseTypeDef#

# GetModelResponseTypeDef definition

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

GetModelTemplateResponseTypeDef#

# GetModelTemplateResponseTypeDef definition

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

GetTagsResponseTypeDef#

# GetTagsResponseTypeDef definition

class GetTagsResponseTypeDef(TypedDict):
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetVpcLinkResponseTypeDef#

# GetVpcLinkResponseTypeDef definition

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

ImportApiResponseTypeDef#

# ImportApiResponseTypeDef definition

class ImportApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsOutputTypeDef,  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

ReimportApiResponseTypeDef#

# ReimportApiResponseTypeDef definition

class ReimportApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsOutputTypeDef,  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

UpdateApiMappingResponseTypeDef#

# UpdateApiMappingResponseTypeDef definition

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

UpdateApiResponseTypeDef#

# UpdateApiResponseTypeDef definition

class UpdateApiResponseTypeDef(TypedDict):
    ApiEndpoint: str,
    ApiGatewayManaged: bool,
    ApiId: str,
    ApiKeySelectionExpression: str,
    CorsConfiguration: CorsOutputTypeDef,  # (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 CorsOutputTypeDef
  2. See ProtocolTypeType
  3. See ResponseMetadataTypeDef

UpdateAuthorizerResponseTypeDef#

# UpdateAuthorizerResponseTypeDef definition

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

UpdateDeploymentResponseTypeDef#

# UpdateDeploymentResponseTypeDef 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#

# UpdateIntegrationResponseResponseTypeDef definition

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

UpdateModelResponseTypeDef#

# UpdateModelResponseTypeDef definition

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

UpdateVpcLinkResponseTypeDef#

# UpdateVpcLinkResponseTypeDef definition

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

CreateAuthorizerRequestRequestTypeDef#

# CreateAuthorizerRequestRequestTypeDef definition

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

UpdateAuthorizerRequestRequestTypeDef#

# UpdateAuthorizerRequestRequestTypeDef definition

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

CreateDomainNameResponseTypeDef#

# CreateDomainNameResponseTypeDef definition

class CreateDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: list[DomainNameConfigurationOutputTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DomainNameConfigurationOutputTypeDef
  2. See MutualTlsAuthenticationTypeDef
  3. See ResponseMetadataTypeDef

DomainNameTypeDef#

# DomainNameTypeDef definition

class DomainNameTypeDef(TypedDict):
    DomainName: str,
    ApiMappingSelectionExpression: NotRequired[str],
    DomainNameConfigurations: NotRequired[list[DomainNameConfigurationOutputTypeDef]],  # (1)
    MutualTlsAuthentication: NotRequired[MutualTlsAuthenticationTypeDef],  # (2)
    Tags: NotRequired[dict[str, str]],
  1. See DomainNameConfigurationOutputTypeDef
  2. See MutualTlsAuthenticationTypeDef

GetDomainNameResponseTypeDef#

# GetDomainNameResponseTypeDef definition

class GetDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: list[DomainNameConfigurationOutputTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DomainNameConfigurationOutputTypeDef
  2. See MutualTlsAuthenticationTypeDef
  3. See ResponseMetadataTypeDef

UpdateDomainNameResponseTypeDef#

# UpdateDomainNameResponseTypeDef definition

class UpdateDomainNameResponseTypeDef(TypedDict):
    ApiMappingSelectionExpression: str,
    DomainName: str,
    DomainNameConfigurations: list[DomainNameConfigurationOutputTypeDef],  # (1)
    MutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (2)
    Tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DomainNameConfigurationOutputTypeDef
  2. See MutualTlsAuthenticationTypeDef
  3. See ResponseMetadataTypeDef

CreateIntegrationRequestRequestTypeDef#

# CreateIntegrationRequestRequestTypeDef definition

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

UpdateIntegrationRequestRequestTypeDef#

# UpdateIntegrationRequestRequestTypeDef definition

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

CreateIntegrationResultTypeDef#

# CreateIntegrationResultTypeDef definition

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

GetIntegrationResultTypeDef#

# GetIntegrationResultTypeDef definition

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

IntegrationTypeDef#

# IntegrationTypeDef definition

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

UpdateIntegrationResultTypeDef#

# UpdateIntegrationResultTypeDef definition

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

CreateRouteRequestRequestTypeDef#

# CreateRouteRequestRequestTypeDef definition

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

CreateRouteResponseRequestRequestTypeDef#

# CreateRouteResponseRequestRequestTypeDef definition

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

CreateRouteResponseResponseTypeDef#

# CreateRouteResponseResponseTypeDef 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#

# CreateRouteResultTypeDef definition

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

GetRouteResponseResponseTypeDef#

# GetRouteResponseResponseTypeDef 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#

# GetRouteResultTypeDef definition

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

RouteResponseTypeDef#

# RouteResponseTypeDef 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#

# RouteTypeDef definition

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

UpdateRouteRequestRequestTypeDef#

# UpdateRouteRequestRequestTypeDef definition

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

UpdateRouteResponseRequestRequestTypeDef#

# UpdateRouteResponseRequestRequestTypeDef definition

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

UpdateRouteResponseResponseTypeDef#

# UpdateRouteResponseResponseTypeDef 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#

# UpdateRouteResultTypeDef definition

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

CreateStageRequestRequestTypeDef#

# CreateStageRequestRequestTypeDef definition

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

CreateStageResponseTypeDef#

# CreateStageResponseTypeDef definition

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

GetStageResponseTypeDef#

# GetStageResponseTypeDef definition

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

StageTypeDef#

# StageTypeDef definition

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

UpdateStageRequestRequestTypeDef#

# UpdateStageRequestRequestTypeDef definition

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

UpdateStageResponseTypeDef#

# UpdateStageResponseTypeDef definition

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

GetDeploymentsResponseTypeDef#

# GetDeploymentsResponseTypeDef definition

class GetDeploymentsResponseTypeDef(TypedDict):
    Items: list[DeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DeploymentTypeDef
  2. See ResponseMetadataTypeDef

DomainNameConfigurationTypeDef#

# DomainNameConfigurationTypeDef definition

class DomainNameConfigurationTypeDef(TypedDict):
    ApiGatewayDomainName: NotRequired[str],
    CertificateArn: NotRequired[str],
    CertificateName: NotRequired[str],
    CertificateUploadDate: NotRequired[TimestampTypeDef],
    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

GetApisRequestPaginateTypeDef#

# GetApisRequestPaginateTypeDef definition

class GetApisRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetAuthorizersRequestPaginateTypeDef#

# GetAuthorizersRequestPaginateTypeDef definition

class GetAuthorizersRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetDeploymentsRequestPaginateTypeDef#

# GetDeploymentsRequestPaginateTypeDef definition

class GetDeploymentsRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetDomainNamesRequestPaginateTypeDef#

# GetDomainNamesRequestPaginateTypeDef definition

class GetDomainNamesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetIntegrationResponsesRequestPaginateTypeDef#

# GetIntegrationResponsesRequestPaginateTypeDef definition

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

GetIntegrationsRequestPaginateTypeDef#

# GetIntegrationsRequestPaginateTypeDef definition

class GetIntegrationsRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetModelsRequestPaginateTypeDef#

# GetModelsRequestPaginateTypeDef definition

class GetModelsRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetRouteResponsesRequestPaginateTypeDef#

# GetRouteResponsesRequestPaginateTypeDef definition

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

GetRoutesRequestPaginateTypeDef#

# GetRoutesRequestPaginateTypeDef definition

class GetRoutesRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetStagesRequestPaginateTypeDef#

# GetStagesRequestPaginateTypeDef definition

class GetStagesRequestPaginateTypeDef(TypedDict):
    ApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetIntegrationResponsesResponseTypeDef#

# GetIntegrationResponsesResponseTypeDef definition

class GetIntegrationResponsesResponseTypeDef(TypedDict):
    Items: list[IntegrationResponseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See IntegrationResponseTypeDef
  2. See ResponseMetadataTypeDef

GetModelsResponseTypeDef#

# GetModelsResponseTypeDef definition

class GetModelsResponseTypeDef(TypedDict):
    Items: list[ModelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ModelTypeDef
  2. See ResponseMetadataTypeDef

GetVpcLinksResponseTypeDef#

# GetVpcLinksResponseTypeDef definition

class GetVpcLinksResponseTypeDef(TypedDict):
    Items: list[VpcLinkTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See VpcLinkTypeDef
  2. See ResponseMetadataTypeDef

GetApisResponseTypeDef#

# GetApisResponseTypeDef definition

class GetApisResponseTypeDef(TypedDict):
    Items: list[ApiTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ApiTypeDef
  2. See ResponseMetadataTypeDef

GetAuthorizersResponseTypeDef#

# GetAuthorizersResponseTypeDef definition

class GetAuthorizersResponseTypeDef(TypedDict):
    Items: list[AuthorizerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AuthorizerTypeDef
  2. See ResponseMetadataTypeDef

GetDomainNamesResponseTypeDef#

# GetDomainNamesResponseTypeDef definition

class GetDomainNamesResponseTypeDef(TypedDict):
    Items: list[DomainNameTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See DomainNameTypeDef
  2. See ResponseMetadataTypeDef

GetIntegrationsResponseTypeDef#

# GetIntegrationsResponseTypeDef definition

class GetIntegrationsResponseTypeDef(TypedDict):
    Items: list[IntegrationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See IntegrationTypeDef
  2. See ResponseMetadataTypeDef

GetRouteResponsesResponseTypeDef#

# GetRouteResponsesResponseTypeDef definition

class GetRouteResponsesResponseTypeDef(TypedDict):
    Items: list[RouteResponseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RouteResponseTypeDef
  2. See ResponseMetadataTypeDef

GetRoutesResponseTypeDef#

# GetRoutesResponseTypeDef definition

class GetRoutesResponseTypeDef(TypedDict):
    Items: list[RouteTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See RouteTypeDef
  2. See ResponseMetadataTypeDef

GetStagesResponseTypeDef#

# GetStagesResponseTypeDef definition

class GetStagesResponseTypeDef(TypedDict):
    Items: list[StageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See StageTypeDef
  2. See ResponseMetadataTypeDef

UpdateDomainNameRequestRequestTypeDef#

# UpdateDomainNameRequestRequestTypeDef definition

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

CreateDomainNameRequestRequestTypeDef#

# CreateDomainNameRequestRequestTypeDef definition

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