Skip to content

Type definitions#

Index > CloudFront > Type definitions

Auto-generated documentation for CloudFront type annotations stubs module mypy-boto3-cloudfront.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AliasICPRecordalTypeDef#

# AliasICPRecordalTypeDef definition

class AliasICPRecordalTypeDef(TypedDict):
    CNAME: NotRequired[str],
    ICPRecordalStatus: NotRequired[ICPRecordalStatusType],  # (1)
  1. See ICPRecordalStatusType

AliasesTypeDef#

# AliasesTypeDef definition

class AliasesTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[List[str]],

CachedMethodsTypeDef#

# CachedMethodsTypeDef definition

class CachedMethodsTypeDef(TypedDict):
    Quantity: int,
    Items: List[MethodType],  # (1)
  1. See MethodType

AssociateAliasRequestRequestTypeDef#

# AssociateAliasRequestRequestTypeDef definition

class AssociateAliasRequestRequestTypeDef(TypedDict):
    TargetDistributionId: str,
    Alias: str,

TrustedKeyGroupsTypeDef#

# TrustedKeyGroupsTypeDef definition

class TrustedKeyGroupsTypeDef(TypedDict):
    Enabled: bool,
    Quantity: int,
    Items: NotRequired[List[str]],

TrustedSignersTypeDef#

# TrustedSignersTypeDef definition

class TrustedSignersTypeDef(TypedDict):
    Enabled: bool,
    Quantity: int,
    Items: NotRequired[List[str]],

CookieNamesTypeDef#

# CookieNamesTypeDef definition

class CookieNamesTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[List[str]],

HeadersTypeDef#

# HeadersTypeDef definition

class HeadersTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[List[str]],

QueryStringNamesTypeDef#

# QueryStringNamesTypeDef definition

class QueryStringNamesTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[Sequence[str]],

CloudFrontOriginAccessIdentityConfigTypeDef#

# CloudFrontOriginAccessIdentityConfigTypeDef definition

class CloudFrontOriginAccessIdentityConfigTypeDef(TypedDict):
    CallerReference: str,
    Comment: str,

CloudFrontOriginAccessIdentitySummaryTypeDef#

# CloudFrontOriginAccessIdentitySummaryTypeDef definition

class CloudFrontOriginAccessIdentitySummaryTypeDef(TypedDict):
    Id: str,
    S3CanonicalUserId: str,
    Comment: str,

ConflictingAliasTypeDef#

# ConflictingAliasTypeDef definition

class ConflictingAliasTypeDef(TypedDict):
    Alias: NotRequired[str],
    DistributionId: NotRequired[str],
    AccountId: NotRequired[str],

ContentTypeProfileTypeDef#

# ContentTypeProfileTypeDef definition

class ContentTypeProfileTypeDef(TypedDict):
    Format: FormatType,  # (1)
    ContentType: str,
    ProfileId: NotRequired[str],
  1. See FormatType

StagingDistributionDnsNamesTypeDef#

# StagingDistributionDnsNamesTypeDef definition

class StagingDistributionDnsNamesTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[Sequence[str]],

ContinuousDeploymentSingleHeaderConfigTypeDef#

# ContinuousDeploymentSingleHeaderConfigTypeDef definition

class ContinuousDeploymentSingleHeaderConfigTypeDef(TypedDict):
    Header: str,
    Value: str,

SessionStickinessConfigTypeDef#

# SessionStickinessConfigTypeDef definition

class SessionStickinessConfigTypeDef(TypedDict):
    IdleTTL: int,
    MaximumTTL: int,

CopyDistributionRequestRequestTypeDef#

# CopyDistributionRequestRequestTypeDef definition

class CopyDistributionRequestRequestTypeDef(TypedDict):
    PrimaryDistributionId: str,
    CallerReference: str,
    Staging: NotRequired[bool],
    IfMatch: NotRequired[str],
    Enabled: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

FunctionConfigTypeDef#

# FunctionConfigTypeDef definition

class FunctionConfigTypeDef(TypedDict):
    Comment: str,
    Runtime: FunctionRuntimeType,  # (1)
  1. See FunctionRuntimeType

KeyGroupConfigTypeDef#

# KeyGroupConfigTypeDef definition

class KeyGroupConfigTypeDef(TypedDict):
    Name: str,
    Items: Sequence[str],
    Comment: NotRequired[str],

OriginAccessControlConfigTypeDef#

# OriginAccessControlConfigTypeDef definition

class OriginAccessControlConfigTypeDef(TypedDict):
    Name: str,
    SigningProtocol: OriginAccessControlSigningProtocolsType,  # (1)
    SigningBehavior: OriginAccessControlSigningBehaviorsType,  # (2)
    OriginAccessControlOriginType: OriginAccessControlOriginTypesType,  # (3)
    Description: NotRequired[str],
  1. See OriginAccessControlSigningProtocolsType
  2. See OriginAccessControlSigningBehaviorsType
  3. See OriginAccessControlOriginTypesType

PublicKeyConfigTypeDef#

# PublicKeyConfigTypeDef definition

class PublicKeyConfigTypeDef(TypedDict):
    CallerReference: str,
    Name: str,
    EncodedKey: str,
    Comment: NotRequired[str],

CustomErrorResponseTypeDef#

# CustomErrorResponseTypeDef definition

class CustomErrorResponseTypeDef(TypedDict):
    ErrorCode: int,
    ResponsePagePath: NotRequired[str],
    ResponseCode: NotRequired[str],
    ErrorCachingMinTTL: NotRequired[int],

OriginCustomHeaderTypeDef#

# OriginCustomHeaderTypeDef definition

class OriginCustomHeaderTypeDef(TypedDict):
    HeaderName: str,
    HeaderValue: str,

OriginSslProtocolsTypeDef#

# OriginSslProtocolsTypeDef definition

class OriginSslProtocolsTypeDef(TypedDict):
    Quantity: int,
    Items: List[SslProtocolType],  # (1)
  1. See SslProtocolType

DeleteCachePolicyRequestRequestTypeDef#

# DeleteCachePolicyRequestRequestTypeDef definition

class DeleteCachePolicyRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef#

# DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef definition

class DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteContinuousDeploymentPolicyRequestRequestTypeDef#

# DeleteContinuousDeploymentPolicyRequestRequestTypeDef definition

class DeleteContinuousDeploymentPolicyRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteDistributionRequestRequestTypeDef#

# DeleteDistributionRequestRequestTypeDef definition

class DeleteDistributionRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteFieldLevelEncryptionConfigRequestRequestTypeDef#

# DeleteFieldLevelEncryptionConfigRequestRequestTypeDef definition

class DeleteFieldLevelEncryptionConfigRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteFieldLevelEncryptionProfileRequestRequestTypeDef#

# DeleteFieldLevelEncryptionProfileRequestRequestTypeDef definition

class DeleteFieldLevelEncryptionProfileRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteFunctionRequestRequestTypeDef#

# DeleteFunctionRequestRequestTypeDef definition

class DeleteFunctionRequestRequestTypeDef(TypedDict):
    Name: str,
    IfMatch: str,

DeleteKeyGroupRequestRequestTypeDef#

# DeleteKeyGroupRequestRequestTypeDef definition

class DeleteKeyGroupRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteMonitoringSubscriptionRequestRequestTypeDef#

# DeleteMonitoringSubscriptionRequestRequestTypeDef definition

class DeleteMonitoringSubscriptionRequestRequestTypeDef(TypedDict):
    DistributionId: str,

DeleteOriginAccessControlRequestRequestTypeDef#

# DeleteOriginAccessControlRequestRequestTypeDef definition

class DeleteOriginAccessControlRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteOriginRequestPolicyRequestRequestTypeDef#

# DeleteOriginRequestPolicyRequestRequestTypeDef definition

class DeleteOriginRequestPolicyRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeletePublicKeyRequestRequestTypeDef#

# DeletePublicKeyRequestRequestTypeDef definition

class DeletePublicKeyRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteRealtimeLogConfigRequestRequestTypeDef#

# DeleteRealtimeLogConfigRequestRequestTypeDef definition

class DeleteRealtimeLogConfigRequestRequestTypeDef(TypedDict):
    Name: NotRequired[str],
    ARN: NotRequired[str],

DeleteResponseHeadersPolicyRequestRequestTypeDef#

# DeleteResponseHeadersPolicyRequestRequestTypeDef definition

class DeleteResponseHeadersPolicyRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DeleteStreamingDistributionRequestRequestTypeDef#

# DeleteStreamingDistributionRequestRequestTypeDef definition

class DeleteStreamingDistributionRequestRequestTypeDef(TypedDict):
    Id: str,
    IfMatch: NotRequired[str],

DescribeFunctionRequestRequestTypeDef#

# DescribeFunctionRequestRequestTypeDef definition

class DescribeFunctionRequestRequestTypeDef(TypedDict):
    Name: str,
    Stage: NotRequired[FunctionStageType],  # (1)
  1. See FunctionStageType

LoggingConfigTypeDef#

# LoggingConfigTypeDef definition

class LoggingConfigTypeDef(TypedDict):
    Enabled: bool,
    IncludeCookies: bool,
    Bucket: str,
    Prefix: str,

ViewerCertificateTypeDef#

# ViewerCertificateTypeDef definition

class ViewerCertificateTypeDef(TypedDict):
    CloudFrontDefaultCertificate: NotRequired[bool],
    IAMCertificateId: NotRequired[str],
    ACMCertificateArn: NotRequired[str],
    SSLSupportMethod: NotRequired[SSLSupportMethodType],  # (1)
    MinimumProtocolVersion: NotRequired[MinimumProtocolVersionType],  # (2)
    Certificate: NotRequired[str],
    CertificateSource: NotRequired[CertificateSourceType],  # (3)
  1. See SSLSupportMethodType
  2. See MinimumProtocolVersionType
  3. See CertificateSourceType

DistributionIdListTypeDef#

# DistributionIdListTypeDef definition

class DistributionIdListTypeDef(TypedDict):
    Marker: str,
    MaxItems: int,
    IsTruncated: bool,
    Quantity: int,
    NextMarker: NotRequired[str],
    Items: NotRequired[List[str]],

FieldPatternsTypeDef#

# FieldPatternsTypeDef definition

class FieldPatternsTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[Sequence[str]],

KinesisStreamConfigTypeDef#

# KinesisStreamConfigTypeDef definition

class KinesisStreamConfigTypeDef(TypedDict):
    RoleARN: str,
    StreamARN: str,

QueryStringCacheKeysTypeDef#

# QueryStringCacheKeysTypeDef definition

class QueryStringCacheKeysTypeDef(TypedDict):
    Quantity: int,
    Items: NotRequired[List[str]],

FunctionAssociationTypeDef#

# FunctionAssociationTypeDef definition

class FunctionAssociationTypeDef(TypedDict):
    FunctionARN: str,
    EventType: EventTypeType,  # (1)
  1. See EventTypeType

FunctionMetadataTypeDef#

# FunctionMetadataTypeDef definition

class FunctionMetadataTypeDef(TypedDict):
    FunctionARN: str,
    LastModifiedTime: datetime,
    Stage: NotRequired[FunctionStageType],  # (1)
    CreatedTime: NotRequired[datetime],
  1. See FunctionStageType

GeoRestrictionTypeDef#

# GeoRestrictionTypeDef definition

class GeoRestrictionTypeDef(TypedDict):
    RestrictionType: GeoRestrictionTypeType,  # (1)
    Quantity: int,
    Items: NotRequired[List[str]],
  1. See GeoRestrictionTypeType

GetCachePolicyConfigRequestRequestTypeDef#

# GetCachePolicyConfigRequestRequestTypeDef definition

class GetCachePolicyConfigRequestRequestTypeDef(TypedDict):
    Id: str,

GetCachePolicyRequestRequestTypeDef#

# GetCachePolicyRequestRequestTypeDef definition

class GetCachePolicyRequestRequestTypeDef(TypedDict):
    Id: str,

GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef#

# GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef definition

class GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef(TypedDict):
    Id: str,

GetCloudFrontOriginAccessIdentityRequestRequestTypeDef#

# GetCloudFrontOriginAccessIdentityRequestRequestTypeDef definition

class GetCloudFrontOriginAccessIdentityRequestRequestTypeDef(TypedDict):
    Id: str,

GetContinuousDeploymentPolicyConfigRequestRequestTypeDef#

# GetContinuousDeploymentPolicyConfigRequestRequestTypeDef definition

class GetContinuousDeploymentPolicyConfigRequestRequestTypeDef(TypedDict):
    Id: str,

GetContinuousDeploymentPolicyRequestRequestTypeDef#

# GetContinuousDeploymentPolicyRequestRequestTypeDef definition

class GetContinuousDeploymentPolicyRequestRequestTypeDef(TypedDict):
    Id: str,

GetDistributionConfigRequestRequestTypeDef#

# GetDistributionConfigRequestRequestTypeDef definition

class GetDistributionConfigRequestRequestTypeDef(TypedDict):
    Id: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

GetDistributionRequestRequestTypeDef#

# GetDistributionRequestRequestTypeDef definition

class GetDistributionRequestRequestTypeDef(TypedDict):
    Id: str,

GetFieldLevelEncryptionConfigRequestRequestTypeDef#

# GetFieldLevelEncryptionConfigRequestRequestTypeDef definition

class GetFieldLevelEncryptionConfigRequestRequestTypeDef(TypedDict):
    Id: str,

GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef#

# GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef definition

class GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef(TypedDict):
    Id: str,

GetFieldLevelEncryptionProfileRequestRequestTypeDef#

# GetFieldLevelEncryptionProfileRequestRequestTypeDef definition

class GetFieldLevelEncryptionProfileRequestRequestTypeDef(TypedDict):
    Id: str,

GetFieldLevelEncryptionRequestRequestTypeDef