CloudFront module#
Index > CloudFront
Auto-generated documentation for CloudFront type annotations stubs module mypy-boto3-cloudfront.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CloudFront
.
From PyPI with pip#
Install boto3-stubs
for CloudFront
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudfront]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudfront]'
# standalone installation
python -m pip install mypy-boto3-cloudfront
How to uninstall#
python -m pip uninstall -y mypy-boto3-cloudfront
Usage#
Code samples can be found in Examples.
CloudFrontClient#
Type annotations and code completion for boto3.client("cloudfront")
as CloudFrontClient
boto3 documentation
# CloudFrontClient usage example
from boto3.session import Session
from mypy_boto3_cloudfront.client import CloudFrontClient
def get_client() -> CloudFrontClient:
return Session().client("cloudfront")
Paginators#
Type annotations and code completion for paginators
from boto3.client("cloudfront").get_paginator("...")
.
# ListCloudFrontOriginAccessIdentitiesPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudfront.paginator import ListCloudFrontOriginAccessIdentitiesPaginator
def get_list_cloud_front_origin_access_identities_paginator() -> ListCloudFrontOriginAccessIdentitiesPaginator:
return Session().client("cloudfront").get_paginator("list_cloud_front_origin_access_identities"))
- ListCloudFrontOriginAccessIdentitiesPaginator
- ListDistributionsPaginator
- ListInvalidationsPaginator
- ListStreamingDistributionsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("cloudfront").get_waiter("...")
.
# DistributionDeployedWaiter usage example
from boto3.session import Session
from mypy_boto3_cloudfront.waiter import DistributionDeployedWaiter
def get_distribution_deployed_waiter() -> DistributionDeployedWaiter:
return Session().client("cloudfront").get_waiter("distribution_deployed")
Literals#
Type annotations for literals used in methods and schemas.
# CachePolicyCookieBehaviorType usage example
from mypy_boto3_cloudfront.literals import CachePolicyCookieBehaviorType
def get_value() -> CachePolicyCookieBehaviorType:
return "all"
- CachePolicyCookieBehaviorType
- CachePolicyHeaderBehaviorType
- CachePolicyQueryStringBehaviorType
- CachePolicyTypeType
- CertificateSourceType
- ContinuousDeploymentPolicyTypeType
- DistributionDeployedWaiterName
- EventTypeType
- FormatType
- FrameOptionsListType
- FunctionRuntimeType
- FunctionStageType
- GeoRestrictionTypeType
- HttpVersionType
- ICPRecordalStatusType
- InvalidationCompletedWaiterName
- ItemSelectionType
- ListCloudFrontOriginAccessIdentitiesPaginatorName
- ListDistributionsPaginatorName
- ListInvalidationsPaginatorName
- ListStreamingDistributionsPaginatorName
- MethodType
- MinimumProtocolVersionType
- OriginAccessControlOriginTypesType
- OriginAccessControlSigningBehaviorsType
- OriginAccessControlSigningProtocolsType
- OriginProtocolPolicyType
- OriginRequestPolicyCookieBehaviorType
- OriginRequestPolicyHeaderBehaviorType
- OriginRequestPolicyQueryStringBehaviorType
- OriginRequestPolicyTypeType
- PriceClassType
- RealtimeMetricsSubscriptionStatusType
- ReferrerPolicyListType
- ResponseHeadersPolicyAccessControlAllowMethodsValuesType
- ResponseHeadersPolicyTypeType
- SSLSupportMethodType
- SslProtocolType
- StreamingDistributionDeployedWaiterName
- ViewerProtocolPolicyType
- CloudFrontServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AliasICPRecordalTypeDef usage example
from mypy_boto3_cloudfront.type_defs import AliasICPRecordalTypeDef
def get_value() -> AliasICPRecordalTypeDef:
return {
"CNAME": ...,
}
- AliasICPRecordalTypeDef
- AliasesTypeDef
- CachedMethodsTypeDef
- AssociateAliasRequestRequestTypeDef
- TrustedKeyGroupsTypeDef
- TrustedSignersTypeDef
- CookieNamesTypeDef
- HeadersTypeDef
- QueryStringNamesTypeDef
- CloudFrontOriginAccessIdentityConfigTypeDef
- CloudFrontOriginAccessIdentitySummaryTypeDef
- ConflictingAliasTypeDef
- ContentTypeProfileTypeDef
- StagingDistributionDnsNamesTypeDef
- ContinuousDeploymentSingleHeaderConfigTypeDef
- SessionStickinessConfigTypeDef
- CopyDistributionRequestRequestTypeDef
- FunctionConfigTypeDef
- KeyGroupConfigTypeDef
- OriginAccessControlConfigTypeDef
- PublicKeyConfigTypeDef
- CustomErrorResponseTypeDef
- OriginCustomHeaderTypeDef
- OriginSslProtocolsTypeDef
- DeleteCachePolicyRequestRequestTypeDef
- DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef
- DeleteContinuousDeploymentPolicyRequestRequestTypeDef
- DeleteDistributionRequestRequestTypeDef
- DeleteFieldLevelEncryptionConfigRequestRequestTypeDef
- DeleteFieldLevelEncryptionProfileRequestRequestTypeDef
- DeleteFunctionRequestRequestTypeDef
- DeleteKeyGroupRequestRequestTypeDef
- DeleteMonitoringSubscriptionRequestRequestTypeDef
- DeleteOriginAccessControlRequestRequestTypeDef
- DeleteOriginRequestPolicyRequestRequestTypeDef
- DeletePublicKeyRequestRequestTypeDef
- DeleteRealtimeLogConfigRequestRequestTypeDef
- DeleteResponseHeadersPolicyRequestRequestTypeDef
- DeleteStreamingDistributionRequestRequestTypeDef
- DescribeFunctionRequestRequestTypeDef
- LoggingConfigTypeDef
- ViewerCertificateTypeDef
- DistributionIdListTypeDef
- EmptyResponseMetadataTypeDef
- FieldPatternsTypeDef
- KinesisStreamConfigTypeDef
- QueryStringCacheKeysTypeDef
- FunctionAssociationTypeDef
- FunctionMetadataTypeDef
- GeoRestrictionTypeDef
- GetCachePolicyConfigRequestRequestTypeDef
- GetCachePolicyRequestRequestTypeDef
- GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef
- GetCloudFrontOriginAccessIdentityRequestRequestTypeDef
- GetContinuousDeploymentPolicyConfigRequestRequestTypeDef
- GetContinuousDeploymentPolicyRequestRequestTypeDef
- GetDistributionConfigRequestRequestTypeDef
- WaiterConfigTypeDef
- GetDistributionRequestRequestTypeDef
- GetFieldLevelEncryptionConfigRequestRequestTypeDef
- GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef
- GetFieldLevelEncryptionProfileRequestRequestTypeDef
- GetFieldLevelEncryptionRequestRequestTypeDef
- GetFunctionRequestRequestTypeDef
- GetFunctionResultTypeDef
- GetInvalidationRequestRequestTypeDef
- GetKeyGroupConfigRequestRequestTypeDef
- GetKeyGroupRequestRequestTypeDef
- GetMonitoringSubscriptionRequestRequestTypeDef
- GetOriginAccessControlConfigRequestRequestTypeDef
- GetOriginAccessControlRequestRequestTypeDef
- GetOriginRequestPolicyConfigRequestRequestTypeDef
- GetOriginRequestPolicyRequestRequestTypeDef
- GetPublicKeyConfigRequestRequestTypeDef
- GetPublicKeyRequestRequestTypeDef
- GetRealtimeLogConfigRequestRequestTypeDef
- GetResponseHeadersPolicyConfigRequestRequestTypeDef
- GetResponseHeadersPolicyRequestRequestTypeDef
- GetStreamingDistributionConfigRequestRequestTypeDef
- GetStreamingDistributionRequestRequestTypeDef
- PathsTypeDef
- InvalidationSummaryTypeDef
- KeyPairIdsTypeDef
- LambdaFunctionAssociationTypeDef
- ListCachePoliciesRequestRequestTypeDef
- ListCloudFrontOriginAccessIdentitiesRequestListCloudFrontOriginAccessIdentitiesPaginateTypeDef
- ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef
- ListConflictingAliasesRequestRequestTypeDef
- ListContinuousDeploymentPoliciesRequestRequestTypeDef
- ListDistributionsByCachePolicyIdRequestRequestTypeDef
- ListDistributionsByKeyGroupRequestRequestTypeDef
- ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef
- ListDistributionsByRealtimeLogConfigRequestRequestTypeDef
- ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef
- ListDistributionsByWebACLIdRequestRequestTypeDef
- ListDistributionsRequestListDistributionsPaginateTypeDef
- ListDistributionsRequestRequestTypeDef
- ListFieldLevelEncryptionConfigsRequestRequestTypeDef
- ListFieldLevelEncryptionProfilesRequestRequestTypeDef
- ListFunctionsRequestRequestTypeDef
- ListInvalidationsRequestListInvalidationsPaginateTypeDef
- ListInvalidationsRequestRequestTypeDef
- ListKeyGroupsRequestRequestTypeDef
- ListOriginAccessControlsRequestRequestTypeDef
- ListOriginRequestPoliciesRequestRequestTypeDef
- ListPublicKeysRequestRequestTypeDef
- ListRealtimeLogConfigsRequestRequestTypeDef
- ListResponseHeadersPoliciesRequestRequestTypeDef
- ListStreamingDistributionsRequestListStreamingDistributionsPaginateTypeDef
- ListStreamingDistributionsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- RealtimeMetricsSubscriptionConfigTypeDef
- OriginAccessControlSummaryTypeDef
- StatusCodesTypeDef
- OriginGroupMemberTypeDef
- OriginShieldTypeDef
- S3OriginConfigTypeDef
- PaginatorConfigTypeDef
- PublicKeySummaryTypeDef
- PublishFunctionRequestRequestTypeDef
- QueryArgProfileTypeDef
- ResponseHeadersPolicyAccessControlAllowHeadersTypeDef
- ResponseHeadersPolicyAccessControlAllowMethodsTypeDef
- ResponseHeadersPolicyAccessControlAllowOriginsTypeDef
- ResponseHeadersPolicyAccessControlExposeHeadersTypeDef
- ResponseHeadersPolicyServerTimingHeadersConfigTypeDef
- ResponseHeadersPolicyContentSecurityPolicyTypeDef
- ResponseHeadersPolicyContentTypeOptionsTypeDef
- ResponseHeadersPolicyCustomHeaderTypeDef
- ResponseHeadersPolicyFrameOptionsTypeDef
- ResponseHeadersPolicyReferrerPolicyTypeDef
- ResponseHeadersPolicyRemoveHeaderTypeDef
- ResponseHeadersPolicyStrictTransportSecurityTypeDef
- ResponseHeadersPolicyXSSProtectionTypeDef
- ResponseMetadataTypeDef
- S3OriginTypeDef
- StreamingLoggingConfigTypeDef
- TagKeysTypeDef
- TagTypeDef
- TestFunctionRequestRequestTypeDef
- UpdateDistributionWithStagingConfigRequestRequestTypeDef
- AllowedMethodsTypeDef
- CachePolicyCookiesConfigTypeDef
- CookiePreferenceTypeDef
- OriginRequestPolicyCookiesConfigTypeDef
- CachePolicyHeadersConfigTypeDef
- OriginRequestPolicyHeadersConfigTypeDef
- CachePolicyQueryStringsConfigTypeDef
- OriginRequestPolicyQueryStringsConfigTypeDef
- CloudFrontOriginAccessIdentityTypeDef
- CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef
- GetCloudFrontOriginAccessIdentityConfigResultTypeDef
- UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef
- CloudFrontOriginAccessIdentityListTypeDef
- ConflictingAliasesListTypeDef
- ContentTypeProfilesTypeDef
- ContinuousDeploymentSingleWeightConfigTypeDef
- CreateFunctionRequestRequestTypeDef
- UpdateFunctionRequestRequestTypeDef
- CreateKeyGroupRequestRequestTypeDef
- GetKeyGroupConfigResultTypeDef
- KeyGroupTypeDef
- UpdateKeyGroupRequestRequestTypeDef
- CreateOriginAccessControlRequestRequestTypeDef
- GetOriginAccessControlConfigResultTypeDef
- OriginAccessControlTypeDef
- UpdateOriginAccessControlRequestRequestTypeDef
- CreatePublicKeyRequestRequestTypeDef
- GetPublicKeyConfigResultTypeDef
- PublicKeyTypeDef
- UpdatePublicKeyRequestRequestTypeDef
- CustomErrorResponsesTypeDef
- CustomHeadersTypeDef
- CustomOriginConfigTypeDef
- ListDistributionsByCachePolicyIdResultTypeDef
- ListDistributionsByKeyGroupResultTypeDef
- ListDistributionsByOriginRequestPolicyIdResultTypeDef
- ListDistributionsByResponseHeadersPolicyIdResultTypeDef
- EncryptionEntityTypeDef
- EndPointTypeDef
- FunctionAssociationsTypeDef
- FunctionSummaryTypeDef
- RestrictionsTypeDef
- GetDistributionRequestDistributionDeployedWaitTypeDef
- GetInvalidationRequestInvalidationCompletedWaitTypeDef
- GetStreamingDistributionRequestStreamingDistributionDeployedWaitTypeDef
- InvalidationBatchTypeDef
- InvalidationListTypeDef
- KGKeyPairIdsTypeDef
- SignerTypeDef
- LambdaFunctionAssociationsTypeDef
- MonitoringSubscriptionTypeDef
- OriginAccessControlListTypeDef
- OriginGroupFailoverCriteriaTypeDef
- OriginGroupMembersTypeDef
- PublicKeyListTypeDef
- QueryArgProfilesTypeDef
- ResponseHeadersPolicyCorsConfigTypeDef
- ResponseHeadersPolicyCustomHeadersConfigTypeDef
- ResponseHeadersPolicyRemoveHeadersConfigTypeDef
- ResponseHeadersPolicySecurityHeadersConfigTypeDef
- StreamingDistributionSummaryTypeDef
- StreamingDistributionConfigTypeDef
- UntagResourceRequestRequestTypeDef
- TagsTypeDef
- ForwardedValuesTypeDef
- ParametersInCacheKeyAndForwardedToOriginTypeDef
- OriginRequestPolicyConfigTypeDef
- CreateCloudFrontOriginAccessIdentityResultTypeDef
- GetCloudFrontOriginAccessIdentityResultTypeDef
- UpdateCloudFrontOriginAccessIdentityResultTypeDef
- ListCloudFrontOriginAccessIdentitiesResultTypeDef
- ListConflictingAliasesResultTypeDef
- ContentTypeProfileConfigTypeDef
- TrafficConfigTypeDef
- CreateKeyGroupResultTypeDef
- GetKeyGroupResultTypeDef
- KeyGroupSummaryTypeDef
- UpdateKeyGroupResultTypeDef
- CreateOriginAccessControlResultTypeDef
- GetOriginAccessControlResultTypeDef
- UpdateOriginAccessControlResultTypeDef
- CreatePublicKeyResultTypeDef
- GetPublicKeyResultTypeDef
- UpdatePublicKeyResultTypeDef
- OriginTypeDef
- EncryptionEntitiesTypeDef
- CreateRealtimeLogConfigRequestRequestTypeDef
- RealtimeLogConfigTypeDef
- UpdateRealtimeLogConfigRequestRequestTypeDef
- CreateFunctionResultTypeDef
- DescribeFunctionResultTypeDef
- FunctionListTypeDef
- PublishFunctionResultTypeDef
- TestResultTypeDef
- UpdateFunctionResultTypeDef
- CreateInvalidationRequestRequestTypeDef
- InvalidationTypeDef
- ListInvalidationsResultTypeDef
- ActiveTrustedKeyGroupsTypeDef
- ActiveTrustedSignersTypeDef
- CreateMonitoringSubscriptionRequestRequestTypeDef
- CreateMonitoringSubscriptionResultTypeDef
- GetMonitoringSubscriptionResultTypeDef
- ListOriginAccessControlsResultTypeDef
- OriginGroupTypeDef
- ListPublicKeysResultTypeDef
- QueryArgProfileConfigTypeDef
- ResponseHeadersPolicyConfigTypeDef
- StreamingDistributionListTypeDef
- CreateStreamingDistributionRequestRequestTypeDef
- GetStreamingDistributionConfigResultTypeDef
- UpdateStreamingDistributionRequestRequestTypeDef
- ListTagsForResourceResultTypeDef
- StreamingDistributionConfigWithTagsTypeDef
- TagResourceRequestRequestTypeDef
- CacheBehaviorTypeDef
- DefaultCacheBehaviorTypeDef
- CachePolicyConfigTypeDef
- CreateOriginRequestPolicyRequestRequestTypeDef
- GetOriginRequestPolicyConfigResultTypeDef
- OriginRequestPolicyTypeDef
- UpdateOriginRequestPolicyRequestRequestTypeDef
- ContinuousDeploymentPolicyConfigTypeDef
- KeyGroupListTypeDef
- OriginsTypeDef
- FieldLevelEncryptionProfileConfigTypeDef
- FieldLevelEncryptionProfileSummaryTypeDef
- CreateRealtimeLogConfigResultTypeDef
- GetRealtimeLogConfigResultTypeDef
- RealtimeLogConfigsTypeDef
- UpdateRealtimeLogConfigResultTypeDef
- ListFunctionsResultTypeDef
- TestFunctionResultTypeDef
- CreateInvalidationResultTypeDef
- GetInvalidationResultTypeDef
- StreamingDistributionTypeDef
- OriginGroupsTypeDef
- FieldLevelEncryptionConfigTypeDef
- FieldLevelEncryptionSummaryTypeDef
- CreateResponseHeadersPolicyRequestRequestTypeDef
- GetResponseHeadersPolicyConfigResultTypeDef
- ResponseHeadersPolicyTypeDef
- UpdateResponseHeadersPolicyRequestRequestTypeDef
- ListStreamingDistributionsResultTypeDef
- CreateStreamingDistributionWithTagsRequestRequestTypeDef
- CacheBehaviorsTypeDef
- CachePolicyTypeDef
- CreateCachePolicyRequestRequestTypeDef
- GetCachePolicyConfigResultTypeDef
- UpdateCachePolicyRequestRequestTypeDef
- CreateOriginRequestPolicyResultTypeDef
- GetOriginRequestPolicyResultTypeDef
- OriginRequestPolicySummaryTypeDef
- UpdateOriginRequestPolicyResultTypeDef
- ContinuousDeploymentPolicyTypeDef
- CreateContinuousDeploymentPolicyRequestRequestTypeDef
- GetContinuousDeploymentPolicyConfigResultTypeDef
- UpdateContinuousDeploymentPolicyRequestRequestTypeDef
- ListKeyGroupsResultTypeDef
- CreateFieldLevelEncryptionProfileRequestRequestTypeDef
- FieldLevelEncryptionProfileTypeDef
- GetFieldLevelEncryptionProfileConfigResultTypeDef
- UpdateFieldLevelEncryptionProfileRequestRequestTypeDef
- FieldLevelEncryptionProfileListTypeDef
- ListRealtimeLogConfigsResultTypeDef
- CreateStreamingDistributionResultTypeDef
- CreateStreamingDistributionWithTagsResultTypeDef
- GetStreamingDistributionResultTypeDef
- UpdateStreamingDistributionResultTypeDef
- CreateFieldLevelEncryptionConfigRequestRequestTypeDef
- FieldLevelEncryptionTypeDef
- GetFieldLevelEncryptionConfigResultTypeDef
- UpdateFieldLevelEncryptionConfigRequestRequestTypeDef
- FieldLevelEncryptionListTypeDef
- CreateResponseHeadersPolicyResultTypeDef
- GetResponseHeadersPolicyResultTypeDef
- ResponseHeadersPolicySummaryTypeDef
- UpdateResponseHeadersPolicyResultTypeDef
- DistributionConfigTypeDef
- DistributionSummaryTypeDef
- CachePolicySummaryTypeDef
- CreateCachePolicyResultTypeDef
- GetCachePolicyResultTypeDef
- UpdateCachePolicyResultTypeDef
- OriginRequestPolicyListTypeDef
- ContinuousDeploymentPolicySummaryTypeDef
- CreateContinuousDeploymentPolicyResultTypeDef
- GetContinuousDeploymentPolicyResultTypeDef
- UpdateContinuousDeploymentPolicyResultTypeDef
- CreateFieldLevelEncryptionProfileResultTypeDef
- GetFieldLevelEncryptionProfileResultTypeDef
- UpdateFieldLevelEncryptionProfileResultTypeDef
- ListFieldLevelEncryptionProfilesResultTypeDef
- CreateFieldLevelEncryptionConfigResultTypeDef
- GetFieldLevelEncryptionResultTypeDef
- UpdateFieldLevelEncryptionConfigResultTypeDef
- ListFieldLevelEncryptionConfigsResultTypeDef
- ResponseHeadersPolicyListTypeDef
- CreateDistributionRequestRequestTypeDef
- DistributionConfigWithTagsTypeDef
- DistributionTypeDef
- GetDistributionConfigResultTypeDef
- UpdateDistributionRequestRequestTypeDef
- DistributionListTypeDef
- CachePolicyListTypeDef
- ListOriginRequestPoliciesResultTypeDef
- ContinuousDeploymentPolicyListTypeDef
- ListResponseHeadersPoliciesResultTypeDef
- CreateDistributionWithTagsRequestRequestTypeDef
- CopyDistributionResultTypeDef
- CreateDistributionResultTypeDef
- CreateDistributionWithTagsResultTypeDef
- GetDistributionResultTypeDef
- UpdateDistributionResultTypeDef
- UpdateDistributionWithStagingConfigResultTypeDef
- ListDistributionsByRealtimeLogConfigResultTypeDef
- ListDistributionsByWebACLIdResultTypeDef
- ListDistributionsResultTypeDef
- ListCachePoliciesResultTypeDef
- ListContinuousDeploymentPoliciesResultTypeDef