CloudFrontClient#
Index > CloudFront > CloudFrontClient
Auto-generated documentation for CloudFront type annotations stubs module mypy-boto3-cloudfront.
CloudFrontClient#
Type annotations and code completion for boto3.client("cloudfront").
boto3 documentation
# CloudFrontClient usage example
from boto3.session import Session
from mypy_boto3_cloudfront.client import CloudFrontClient
def get_cloudfront_client() -> CloudFrontClient:
return Session().client("cloudfront")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("cloudfront").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("cloudfront")
try:
do_something(client)
except (
client.exceptions.AccessDenied,
client.exceptions.BatchTooLarge,
client.exceptions.CNAMEAlreadyExists,
client.exceptions.CachePolicyAlreadyExists,
client.exceptions.CachePolicyInUse,
client.exceptions.CannotChangeImmutablePublicKeyFields,
client.exceptions.ClientError,
client.exceptions.CloudFrontOriginAccessIdentityAlreadyExists,
client.exceptions.CloudFrontOriginAccessIdentityInUse,
client.exceptions.ContinuousDeploymentPolicyAlreadyExists,
client.exceptions.ContinuousDeploymentPolicyInUse,
client.exceptions.DistributionAlreadyExists,
client.exceptions.DistributionNotDisabled,
client.exceptions.FieldLevelEncryptionConfigAlreadyExists,
client.exceptions.FieldLevelEncryptionConfigInUse,
client.exceptions.FieldLevelEncryptionProfileAlreadyExists,
client.exceptions.FieldLevelEncryptionProfileInUse,
client.exceptions.FieldLevelEncryptionProfileSizeExceeded,
client.exceptions.FunctionAlreadyExists,
client.exceptions.FunctionInUse,
client.exceptions.FunctionSizeLimitExceeded,
client.exceptions.IllegalDelete,
client.exceptions.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior,
client.exceptions.IllegalOriginAccessConfiguration,
client.exceptions.IllegalUpdate,
client.exceptions.InconsistentQuantities,
client.exceptions.InvalidArgument,
client.exceptions.InvalidDefaultRootObject,
client.exceptions.InvalidDomainNameForOriginAccessControl,
client.exceptions.InvalidErrorCode,
client.exceptions.InvalidForwardCookies,
client.exceptions.InvalidFunctionAssociation,
client.exceptions.InvalidGeoRestrictionParameter,
client.exceptions.InvalidHeadersForS3Origin,
client.exceptions.InvalidIfMatchVersion,
client.exceptions.InvalidLambdaFunctionAssociation,
client.exceptions.InvalidLocationCode,
client.exceptions.InvalidMinimumProtocolVersion,
client.exceptions.InvalidOrigin,
client.exceptions.InvalidOriginAccessControl,
client.exceptions.InvalidOriginAccessIdentity,
client.exceptions.InvalidOriginKeepaliveTimeout,
client.exceptions.InvalidOriginReadTimeout,
client.exceptions.InvalidProtocolSettings,
client.exceptions.InvalidQueryStringParameters,
client.exceptions.InvalidRelativePath,
client.exceptions.InvalidRequiredProtocol,
client.exceptions.InvalidResponseCode,
client.exceptions.InvalidTTLOrder,
client.exceptions.InvalidTagging,
client.exceptions.InvalidViewerCertificate,
client.exceptions.InvalidWebACLId,
client.exceptions.KeyGroupAlreadyExists,
client.exceptions.MissingBody,
client.exceptions.MonitoringSubscriptionAlreadyExists,
client.exceptions.NoSuchCachePolicy,
client.exceptions.NoSuchCloudFrontOriginAccessIdentity,
client.exceptions.NoSuchContinuousDeploymentPolicy,
client.exceptions.NoSuchDistribution,
client.exceptions.NoSuchFieldLevelEncryptionConfig,
client.exceptions.NoSuchFieldLevelEncryptionProfile,
client.exceptions.NoSuchFunctionExists,
client.exceptions.NoSuchInvalidation,
client.exceptions.NoSuchMonitoringSubscription,
client.exceptions.NoSuchOrigin,
client.exceptions.NoSuchOriginAccessControl,
client.exceptions.NoSuchOriginRequestPolicy,
client.exceptions.NoSuchPublicKey,
client.exceptions.NoSuchRealtimeLogConfig,
client.exceptions.NoSuchResource,
client.exceptions.NoSuchResponseHeadersPolicy,
client.exceptions.NoSuchStreamingDistribution,
client.exceptions.OriginAccessControlAlreadyExists,
client.exceptions.OriginAccessControlInUse,
client.exceptions.OriginRequestPolicyAlreadyExists,
client.exceptions.OriginRequestPolicyInUse,
client.exceptions.PreconditionFailed,
client.exceptions.PublicKeyAlreadyExists,
client.exceptions.PublicKeyInUse,
client.exceptions.QueryArgProfileEmpty,
client.exceptions.RealtimeLogConfigAlreadyExists,
client.exceptions.RealtimeLogConfigInUse,
client.exceptions.RealtimeLogConfigOwnerMismatch,
client.exceptions.ResourceInUse,
client.exceptions.ResponseHeadersPolicyAlreadyExists,
client.exceptions.ResponseHeadersPolicyInUse,
client.exceptions.StagingDistributionInUse,
client.exceptions.StreamingDistributionAlreadyExists,
client.exceptions.StreamingDistributionNotDisabled,
client.exceptions.TestFunctionFailed,
client.exceptions.TooLongCSPInResponseHeadersPolicy,
client.exceptions.TooManyCacheBehaviors,
client.exceptions.TooManyCachePolicies,
client.exceptions.TooManyCertificates,
client.exceptions.TooManyCloudFrontOriginAccessIdentities,
client.exceptions.TooManyContinuousDeploymentPolicies,
client.exceptions.TooManyCookieNamesInWhiteList,
client.exceptions.TooManyCookiesInCachePolicy,
client.exceptions.TooManyCookiesInOriginRequestPolicy,
client.exceptions.TooManyCustomHeadersInResponseHeadersPolicy,
client.exceptions.TooManyDistributionCNAMEs,
client.exceptions.TooManyDistributions,
client.exceptions.TooManyDistributionsAssociatedToCachePolicy,
client.exceptions.TooManyDistributionsAssociatedToFieldLevelEncryptionConfig,
client.exceptions.TooManyDistributionsAssociatedToKeyGroup,
client.exceptions.TooManyDistributionsAssociatedToOriginAccessControl,
client.exceptions.TooManyDistributionsAssociatedToOriginRequestPolicy,
client.exceptions.TooManyDistributionsAssociatedToResponseHeadersPolicy,
client.exceptions.TooManyDistributionsWithFunctionAssociations,
client.exceptions.TooManyDistributionsWithLambdaAssociations,
client.exceptions.TooManyDistributionsWithSingleFunctionARN,
client.exceptions.TooManyFieldLevelEncryptionConfigs,
client.exceptions.TooManyFieldLevelEncryptionContentTypeProfiles,
client.exceptions.TooManyFieldLevelEncryptionEncryptionEntities,
client.exceptions.TooManyFieldLevelEncryptionFieldPatterns,
client.exceptions.TooManyFieldLevelEncryptionProfiles,
client.exceptions.TooManyFieldLevelEncryptionQueryArgProfiles,
client.exceptions.TooManyFunctionAssociations,
client.exceptions.TooManyFunctions,
client.exceptions.TooManyHeadersInCachePolicy,
client.exceptions.TooManyHeadersInForwardedValues,
client.exceptions.TooManyHeadersInOriginRequestPolicy,
client.exceptions.TooManyInvalidationsInProgress,
client.exceptions.TooManyKeyGroups,
client.exceptions.TooManyKeyGroupsAssociatedToDistribution,
client.exceptions.TooManyLambdaFunctionAssociations,
client.exceptions.TooManyOriginAccessControls,
client.exceptions.TooManyOriginCustomHeaders,
client.exceptions.TooManyOriginGroupsPerDistribution,
client.exceptions.TooManyOriginRequestPolicies,
client.exceptions.TooManyOrigins,
client.exceptions.TooManyPublicKeys,
client.exceptions.TooManyPublicKeysInKeyGroup,
client.exceptions.TooManyQueryStringParameters,
client.exceptions.TooManyQueryStringsInCachePolicy,
client.exceptions.TooManyQueryStringsInOriginRequestPolicy,
client.exceptions.TooManyRealtimeLogConfigs,
client.exceptions.TooManyRemoveHeadersInResponseHeadersPolicy,
client.exceptions.TooManyResponseHeadersPolicies,
client.exceptions.TooManyStreamingDistributionCNAMEs,
client.exceptions.TooManyStreamingDistributions,
client.exceptions.TooManyTrustedSigners,
client.exceptions.TrustedKeyGroupDoesNotExist,
client.exceptions.TrustedSignerDoesNotExist,
client.exceptions.UnsupportedOperation,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_cloudfront.client import Exceptions
def handle_error(exc: Exceptions.AccessDenied) -> None:
...Methods#
associate_alias#
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
Type annotations and code completion for boto3.client("cloudfront").associate_alias method.
boto3 documentation
# associate_alias method definition
def associate_alias(
self,
*,
TargetDistributionId: str,
Alias: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_alias method usage example with argument unpacking
kwargs: AssociateAliasRequestRequestTypeDef = { # (1)
"TargetDistributionId": ...,
"Alias": ...,
}
parent.associate_alias(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("cloudfront").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("cloudfront").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...copy_distribution#
Creates a staging distribution using the configuration of the provided primary distribution.
Type annotations and code completion for boto3.client("cloudfront").copy_distribution method.
boto3 documentation
# copy_distribution method definition
def copy_distribution(
self,
*,
PrimaryDistributionId: str,
CallerReference: str,
Staging: bool = ...,
IfMatch: str = ...,
) -> CopyDistributionResultTypeDef: # (1)
...# copy_distribution method usage example with argument unpacking
kwargs: CopyDistributionRequestRequestTypeDef = { # (1)
"PrimaryDistributionId": ...,
"CallerReference": ...,
}
parent.copy_distribution(**kwargs)create_cache_policy#
Creates a cache policy.
Type annotations and code completion for boto3.client("cloudfront").create_cache_policy method.
boto3 documentation
# create_cache_policy method definition
def create_cache_policy(
self,
*,
CachePolicyConfig: CachePolicyConfigTypeDef, # (1)
) -> CreateCachePolicyResultTypeDef: # (2)
...# create_cache_policy method usage example with argument unpacking
kwargs: CreateCachePolicyRequestRequestTypeDef = { # (1)
"CachePolicyConfig": ...,
}
parent.create_cache_policy(**kwargs)create_cloud_front_origin_access_identity#
Creates a new origin access identity.
Type annotations and code completion for boto3.client("cloudfront").create_cloud_front_origin_access_identity method.
boto3 documentation
# create_cloud_front_origin_access_identity method definition
def create_cloud_front_origin_access_identity(
self,
*,
CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef, # (1)
) -> CreateCloudFrontOriginAccessIdentityResultTypeDef: # (2)
...- See CloudFrontOriginAccessIdentityConfigTypeDef
- See CreateCloudFrontOriginAccessIdentityResultTypeDef
# create_cloud_front_origin_access_identity method usage example with argument unpacking
kwargs: CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef = { # (1)
"CloudFrontOriginAccessIdentityConfig": ...,
}
parent.create_cloud_front_origin_access_identity(**kwargs)create_continuous_deployment_policy#
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
Type annotations and code completion for boto3.client("cloudfront").create_continuous_deployment_policy method.
boto3 documentation
# create_continuous_deployment_policy method definition
def create_continuous_deployment_policy(
self,
*,
ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfigTypeDef, # (1)
) -> CreateContinuousDeploymentPolicyResultTypeDef: # (2)
...# create_continuous_deployment_policy method usage example with argument unpacking
kwargs: CreateContinuousDeploymentPolicyRequestRequestTypeDef = { # (1)
"ContinuousDeploymentPolicyConfig": ...,
}
parent.create_continuous_deployment_policy(**kwargs)create_distribution#
Creates a CloudFront distribution.
Type annotations and code completion for boto3.client("cloudfront").create_distribution method.
boto3 documentation
# create_distribution method definition
def create_distribution(
self,
*,
DistributionConfig: DistributionConfigTypeDef, # (1)
) -> CreateDistributionResultTypeDef: # (2)
...# create_distribution method usage example with argument unpacking
kwargs: CreateDistributionRequestRequestTypeDef = { # (1)
"DistributionConfig": ...,
}
parent.create_distribution(**kwargs)create_distribution_with_tags#
Create a new distribution with tags.
Type annotations and code completion for boto3.client("cloudfront").create_distribution_with_tags method.
boto3 documentation
# create_distribution_with_tags method definition
def create_distribution_with_tags(
self,
*,
DistributionConfigWithTags: DistributionConfigWithTagsTypeDef, # (1)
) -> CreateDistributionWithTagsResultTypeDef: # (2)
...# create_distribution_with_tags method usage example with argument unpacking
kwargs: CreateDistributionWithTagsRequestRequestTypeDef = { # (1)
"DistributionConfigWithTags": ...,
}
parent.create_distribution_with_tags(**kwargs)create_field_level_encryption_config#
Create a new field-level encryption configuration.
Type annotations and code completion for boto3.client("cloudfront").create_field_level_encryption_config method.
boto3 documentation
# create_field_level_encryption_config method definition
def create_field_level_encryption_config(
self,
*,
FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef, # (1)
) -> CreateFieldLevelEncryptionConfigResultTypeDef: # (2)
...# create_field_level_encryption_config method usage example with argument unpacking
kwargs: CreateFieldLevelEncryptionConfigRequestRequestTypeDef = { # (1)
"FieldLevelEncryptionConfig": ...,
}
parent.create_field_level_encryption_config(**kwargs)create_field_level_encryption_profile#
Create a field-level encryption profile.
Type annotations and code completion for boto3.client("cloudfront").create_field_level_encryption_profile method.
boto3 documentation
# create_field_level_encryption_profile method definition
def create_field_level_encryption_profile(
self,
*,
FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef, # (1)
) -> CreateFieldLevelEncryptionProfileResultTypeDef: # (2)
...# create_field_level_encryption_profile method usage example with argument unpacking
kwargs: CreateFieldLevelEncryptionProfileRequestRequestTypeDef = { # (1)
"FieldLevelEncryptionProfileConfig": ...,
}
parent.create_field_level_encryption_profile(**kwargs)create_function#
Creates a CloudFront function.
Type annotations and code completion for boto3.client("cloudfront").create_function method.
boto3 documentation
# create_function method definition
def create_function(
self,
*,
Name: str,
FunctionConfig: FunctionConfigTypeDef, # (1)
FunctionCode: Union[str, bytes, IO[Any], StreamingBody],
) -> CreateFunctionResultTypeDef: # (2)
...# create_function method usage example with argument unpacking
kwargs: CreateFunctionRequestRequestTypeDef = { # (1)
"Name": ...,
"FunctionConfig": ...,
"FunctionCode": ...,
}
parent.create_function(**kwargs)create_invalidation#
Create a new invalidation.
Type annotations and code completion for boto3.client("cloudfront").create_invalidation method.
boto3 documentation
# create_invalidation method definition
def create_invalidation(
self,
*,
DistributionId: str,
InvalidationBatch: InvalidationBatchTypeDef, # (1)
) -> CreateInvalidationResultTypeDef: # (2)
...# create_invalidation method usage example with argument unpacking
kwargs: CreateInvalidationRequestRequestTypeDef = { # (1)
"DistributionId": ...,
"InvalidationBatch": ...,
}
parent.create_invalidation(**kwargs)create_key_group#
Creates a key group that you can use with CloudFront signed URLs and signed cookies_.
Type annotations and code completion for boto3.client("cloudfront").create_key_group method.
boto3 documentation
# create_key_group method definition
def create_key_group(
self,
*,
KeyGroupConfig: KeyGroupConfigTypeDef, # (1)
) -> CreateKeyGroupResultTypeDef: # (2)
...# create_key_group method usage example with argument unpacking
kwargs: CreateKeyGroupRequestRequestTypeDef = { # (1)
"KeyGroupConfig": ...,
}
parent.create_key_group(**kwargs)create_monitoring_subscription#
Enables additional CloudWatch metrics for the specified CloudFront distribution.
Type annotations and code completion for boto3.client("cloudfront").create_monitoring_subscription method.
boto3 documentation
# create_monitoring_subscription method definition
def create_monitoring_subscription(
self,
*,
DistributionId: str,
MonitoringSubscription: MonitoringSubscriptionTypeDef, # (1)
) -> CreateMonitoringSubscriptionResultTypeDef: # (2)
...# create_monitoring_subscription method usage example with argument unpacking
kwargs: CreateMonitoringSubscriptionRequestRequestTypeDef = { # (1)
"DistributionId": ...,
"MonitoringSubscription": ...,
}
parent.create_monitoring_subscription(**kwargs)create_origin_access_control#
Creates a new origin access control in CloudFront.
Type annotations and code completion for boto3.client("cloudfront").create_origin_access_control method.
boto3 documentation
# create_origin_access_control method definition
def create_origin_access_control(
self,
*,
OriginAccessControlConfig: OriginAccessControlConfigTypeDef, # (1)
) -> CreateOriginAccessControlResultTypeDef: # (2)
...# create_origin_access_control method usage example with argument unpacking
kwargs: CreateOriginAccessControlRequestRequestTypeDef = { # (1)
"OriginAccessControlConfig": ...,
}
parent.create_origin_access_control(**kwargs)create_origin_request_policy#
Creates an origin request policy.
Type annotations and code completion for boto3.client("cloudfront").create_origin_request_policy method.
boto3 documentation
# create_origin_request_policy method definition
def create_origin_request_policy(
self,
*,
OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef, # (1)
) -> CreateOriginRequestPolicyResultTypeDef: # (2)
...# create_origin_request_policy method usage example with argument unpacking
kwargs: CreateOriginRequestPolicyRequestRequestTypeDef = { # (1)
"OriginRequestPolicyConfig": ...,
}
parent.create_origin_request_policy(**kwargs)create_public_key#
Uploads a public key to CloudFront that you can use with signed URLs and signed
cookies_,
or with field-level encryption
<https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-
enc....
Type annotations and code completion for boto3.client("cloudfront").create_public_key method.
boto3 documentation
# create_public_key method definition
def create_public_key(
self,
*,
PublicKeyConfig: PublicKeyConfigTypeDef, # (1)
) -> CreatePublicKeyResultTypeDef: # (2)
...# create_public_key method usage example with argument unpacking
kwargs: CreatePublicKeyRequestRequestTypeDef = { # (1)
"PublicKeyConfig": ...,
}
parent.create_public_key(**kwargs)create_realtime_log_config#
Creates a real-time log configuration.
Type annotations and code completion for boto3.client("cloudfront").create_realtime_log_config method.
boto3 documentation
# create_realtime_log_config method definition
def create_realtime_log_config(
self,
*,
EndPoints: Sequence[EndPointTypeDef], # (1)
Fields: Sequence[str],
Name: str,
SamplingRate: int,
) -> CreateRealtimeLogConfigResultTypeDef: # (2)
...# create_realtime_log_config method usage example with argument unpacking
kwargs: CreateRealtimeLogConfigRequestRequestTypeDef = { # (1)
"EndPoints": ...,
"Fields": ...,
"Name": ...,
"SamplingRate": ...,
}
parent.create_realtime_log_config(**kwargs)create_response_headers_policy#
Creates a response headers policy.
Type annotations and code completion for boto3.client("cloudfront").create_response_headers_policy method.
boto3 documentation
# create_response_headers_policy method definition
def create_response_headers_policy(
self,
*,
ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef, # (1)
) -> CreateResponseHeadersPolicyResultTypeDef: # (2)
...# create_response_headers_policy method usage example with argument unpacking
kwargs: CreateResponseHeadersPolicyRequestRequestTypeDef = { # (1)
"ResponseHeadersPolicyConfig": ...,
}
parent.create_response_headers_policy(**kwargs)create_streaming_distribution#
This API is deprecated.
Type annotations and code completion for boto3.client("cloudfront").create_streaming_distribution method.
boto3 documentation
# create_streaming_distribution method definition
def create_streaming_distribution(
self,
*,
StreamingDistributionConfig: StreamingDistributionConfigTypeDef, # (1)
) -> CreateStreamingDistributionResultTypeDef: # (2)
...# create_streaming_distribution method usage example with argument unpacking
kwargs: CreateStreamingDistributionRequestRequestTypeDef = { # (1)
"StreamingDistributionConfig": ...,
}
parent.create_streaming_distribution(**kwargs)create_streaming_distribution_with_tags#
This API is deprecated.
Type annotations and code completion for boto3.client("cloudfront").create_streaming_distribution_with_tags method.
boto3 documentation
# create_streaming_distribution_with_tags method definition
def create_streaming_distribution_with_tags(
self,
*,
StreamingDistributionConfigWithTags: StreamingDistributionConfigWithTagsTypeDef, # (1)
) -> CreateStreamingDistributionWithTagsResultTypeDef: # (2)
...# create_streaming_distribution_with_tags method usage example with argument unpacking
kwargs: CreateStreamingDistributionWithTagsRequestRequestTypeDef = { # (1)
"StreamingDistributionConfigWithTags": ...,
}
parent.create_streaming_distribution_with_tags(**kwargs)delete_cache_policy#
Deletes a cache policy.
Type annotations and code completion for boto3.client("cloudfront").delete_cache_policy method.
boto3 documentation
# delete_cache_policy method definition
def delete_cache_policy(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_cache_policy method usage example with argument unpacking
kwargs: DeleteCachePolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_cache_policy(**kwargs)delete_cloud_front_origin_access_identity#
Delete an origin access identity.
Type annotations and code completion for boto3.client("cloudfront").delete_cloud_front_origin_access_identity method.
boto3 documentation
# delete_cloud_front_origin_access_identity method definition
def delete_cloud_front_origin_access_identity(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_cloud_front_origin_access_identity method usage example with argument unpacking
kwargs: DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_cloud_front_origin_access_identity(**kwargs)delete_continuous_deployment_policy#
Deletes a continuous deployment policy.
Type annotations and code completion for boto3.client("cloudfront").delete_continuous_deployment_policy method.
boto3 documentation
# delete_continuous_deployment_policy method definition
def delete_continuous_deployment_policy(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_continuous_deployment_policy method usage example with argument unpacking
kwargs: DeleteContinuousDeploymentPolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_continuous_deployment_policy(**kwargs)delete_distribution#
Delete a distribution.
Type annotations and code completion for boto3.client("cloudfront").delete_distribution method.
boto3 documentation
# delete_distribution method definition
def delete_distribution(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_distribution method usage example with argument unpacking
kwargs: DeleteDistributionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_distribution(**kwargs)delete_field_level_encryption_config#
Remove a field-level encryption configuration.
Type annotations and code completion for boto3.client("cloudfront").delete_field_level_encryption_config method.
boto3 documentation
# delete_field_level_encryption_config method definition
def delete_field_level_encryption_config(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_field_level_encryption_config method usage example with argument unpacking
kwargs: DeleteFieldLevelEncryptionConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_field_level_encryption_config(**kwargs)delete_field_level_encryption_profile#
Remove a field-level encryption profile.
Type annotations and code completion for boto3.client("cloudfront").delete_field_level_encryption_profile method.
boto3 documentation
# delete_field_level_encryption_profile method definition
def delete_field_level_encryption_profile(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_field_level_encryption_profile method usage example with argument unpacking
kwargs: DeleteFieldLevelEncryptionProfileRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_field_level_encryption_profile(**kwargs)delete_function#
Deletes a CloudFront function.
Type annotations and code completion for boto3.client("cloudfront").delete_function method.
boto3 documentation
# delete_function method definition
def delete_function(
self,
*,
Name: str,
IfMatch: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_function method usage example with argument unpacking
kwargs: DeleteFunctionRequestRequestTypeDef = { # (1)
"Name": ...,
"IfMatch": ...,
}
parent.delete_function(**kwargs)delete_key_group#
Deletes a key group.
Type annotations and code completion for boto3.client("cloudfront").delete_key_group method.
boto3 documentation
# delete_key_group method definition
def delete_key_group(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_key_group method usage example with argument unpacking
kwargs: DeleteKeyGroupRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_key_group(**kwargs)delete_monitoring_subscription#
Disables additional CloudWatch metrics for the specified CloudFront distribution.
Type annotations and code completion for boto3.client("cloudfront").delete_monitoring_subscription method.
boto3 documentation
# delete_monitoring_subscription method definition
def delete_monitoring_subscription(
self,
*,
DistributionId: str,
) -> Dict[str, Any]:
...# delete_monitoring_subscription method usage example with argument unpacking
kwargs: DeleteMonitoringSubscriptionRequestRequestTypeDef = { # (1)
"DistributionId": ...,
}
parent.delete_monitoring_subscription(**kwargs)delete_origin_access_control#
Deletes a CloudFront origin access control.
Type annotations and code completion for boto3.client("cloudfront").delete_origin_access_control method.
boto3 documentation
# delete_origin_access_control method definition
def delete_origin_access_control(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_origin_access_control method usage example with argument unpacking
kwargs: DeleteOriginAccessControlRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_origin_access_control(**kwargs)delete_origin_request_policy#
Deletes an origin request policy.
Type annotations and code completion for boto3.client("cloudfront").delete_origin_request_policy method.
boto3 documentation
# delete_origin_request_policy method definition
def delete_origin_request_policy(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_origin_request_policy method usage example with argument unpacking
kwargs: DeleteOriginRequestPolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_origin_request_policy(**kwargs)delete_public_key#
Remove a public key you previously added to CloudFront.
Type annotations and code completion for boto3.client("cloudfront").delete_public_key method.
boto3 documentation
# delete_public_key method definition
def delete_public_key(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_public_key method usage example with argument unpacking
kwargs: DeletePublicKeyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_public_key(**kwargs)delete_realtime_log_config#
Deletes a real-time log configuration.
Type annotations and code completion for boto3.client("cloudfront").delete_realtime_log_config method.
boto3 documentation
# delete_realtime_log_config method definition
def delete_realtime_log_config(
self,
*,
Name: str = ...,
ARN: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_realtime_log_config method usage example with argument unpacking
kwargs: DeleteRealtimeLogConfigRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_realtime_log_config(**kwargs)delete_response_headers_policy#
Deletes a response headers policy.
Type annotations and code completion for boto3.client("cloudfront").delete_response_headers_policy method.
boto3 documentation
# delete_response_headers_policy method definition
def delete_response_headers_policy(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_response_headers_policy method usage example with argument unpacking
kwargs: DeleteResponseHeadersPolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_response_headers_policy(**kwargs)delete_streaming_distribution#
Delete a streaming distribution.
Type annotations and code completion for boto3.client("cloudfront").delete_streaming_distribution method.
boto3 documentation
# delete_streaming_distribution method definition
def delete_streaming_distribution(
self,
*,
Id: str,
IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_streaming_distribution method usage example with argument unpacking
kwargs: DeleteStreamingDistributionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_streaming_distribution(**kwargs)describe_function#
Gets configuration information and metadata about a CloudFront function, but not the function's code.
Type annotations and code completion for boto3.client("cloudfront").describe_function method.
boto3 documentation
# describe_function method definition
def describe_function(
self,
*,
Name: str,
Stage: FunctionStageType = ..., # (1)
) -> DescribeFunctionResultTypeDef: # (2)
...# describe_function method usage example with argument unpacking
kwargs: DescribeFunctionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_function(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("cloudfront").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_cache_policy#
Gets a cache policy, including the following metadata: * The policy's identifier.
Type annotations and code completion for boto3.client("cloudfront").get_cache_policy method.
boto3 documentation
# get_cache_policy method definition
def get_cache_policy(
self,
*,
Id: str,
) -> GetCachePolicyResultTypeDef: # (1)
...# get_cache_policy method usage example with argument unpacking
kwargs: GetCachePolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_cache_policy(**kwargs)get_cache_policy_config#
Gets a cache policy configuration.
Type annotations and code completion for boto3.client("cloudfront").get_cache_policy_config method.
boto3 documentation
# get_cache_policy_config method definition
def get_cache_policy_config(
self,
*,
Id: str,
) -> GetCachePolicyConfigResultTypeDef: # (1)
...# get_cache_policy_config method usage example with argument unpacking
kwargs: GetCachePolicyConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_cache_policy_config(**kwargs)get_cloud_front_origin_access_identity#
Get the information about an origin access identity.
Type annotations and code completion for boto3.client("cloudfront").get_cloud_front_origin_access_identity method.
boto3 documentation
# get_cloud_front_origin_access_identity method definition
def get_cloud_front_origin_access_identity(
self,
*,
Id: str,
) -> GetCloudFrontOriginAccessIdentityResultTypeDef: # (1)
...# get_cloud_front_origin_access_identity method usage example with argument unpacking
kwargs: GetCloudFrontOriginAccessIdentityRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_cloud_front_origin_access_identity(**kwargs)get_cloud_front_origin_access_identity_config#
Get the configuration information about an origin access identity.
Type annotations and code completion for boto3.client("cloudfront").get_cloud_front_origin_access_identity_config method.
boto3 documentation
# get_cloud_front_origin_access_identity_config method definition
def get_cloud_front_origin_access_identity_config(
self,
*,
Id: str,
) -> GetCloudFrontOriginAccessIdentityConfigResultTypeDef: # (1)
...# get_cloud_front_origin_access_identity_config method usage example with argument unpacking
kwargs: GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_cloud_front_origin_access_identity_config(**kwargs)get_continuous_deployment_policy#
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
Type annotations and code completion for boto3.client("cloudfront").get_continuous_deployment_policy method.
boto3 documentation
# get_continuous_deployment_policy method definition
def get_continuous_deployment_policy(
self,
*,
Id: str,
) -> GetContinuousDeploymentPolicyResultTypeDef: # (1)
...# get_continuous_deployment_policy method usage example with argument unpacking
kwargs: GetContinuousDeploymentPolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_continuous_deployment_policy(**kwargs)get_continuous_deployment_policy_config#
Gets configuration information about a continuous deployment policy.
Type annotations and code completion for boto3.client("cloudfront").get_continuous_deployment_policy_config method.
boto3 documentation
# get_continuous_deployment_policy_config method definition
def get_continuous_deployment_policy_config(
self,
*,
Id: str,
) -> GetContinuousDeploymentPolicyConfigResultTypeDef: # (1)
...# get_continuous_deployment_policy_config method usage example with argument unpacking
kwargs: GetContinuousDeploymentPolicyConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_continuous_deployment_policy_config(**kwargs)get_distribution#
Get the information about a distribution.
Type annotations and code completion for boto3.client("cloudfront").get_distribution method.
boto3 documentation
# get_distribution method definition
def get_distribution(
self,
*,
Id: str,
) -> GetDistributionResultTypeDef: # (1)
...# get_distribution method usage example with argument unpacking
kwargs: GetDistributionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_distribution(**kwargs)get_distribution_config#
Get the configuration information about a distribution.
Type annotations and code completion for boto3.client("cloudfront").get_distribution_config method.
boto3 documentation
# get_distribution_config method definition
def get_distribution_config(
self,
*,
Id: str,
) -> GetDistributionConfigResultTypeDef: # (1)
...# get_distribution_config method usage example with argument unpacking
kwargs: GetDistributionConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_distribution_config(**kwargs)get_field_level_encryption#
Get the field-level encryption configuration information.
Type annotations and code completion for boto3.client("cloudfront").get_field_level_encryption method.
boto3 documentation
# get_field_level_encryption method definition
def get_field_level_encryption(
self,
*,
Id: str,
) -> GetFieldLevelEncryptionResultTypeDef: # (1)
...# get_field_level_encryption method usage example with argument unpacking
kwargs: GetFieldLevelEncryptionRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_field_level_encryption(**kwargs)get_field_level_encryption_config#
Get the field-level encryption configuration information.
Type annotations and code completion for boto3.client("cloudfront").get_field_level_encryption_config method.
boto3 documentation
# get_field_level_encryption_config method definition
def get_field_level_encryption_config(
self,
*,
Id: str,
) -> GetFieldLevelEncryptionConfigResultTypeDef: # (1)
...# get_field_level_encryption_config method usage example with argument unpacking
kwargs: GetFieldLevelEncryptionConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_field_level_encryption_config(**kwargs)get_field_level_encryption_profile#
Get the field-level encryption profile information.
Type annotations and code completion for boto3.client("cloudfront").get_field_level_encryption_profile method.
boto3 documentation
# get_field_level_encryption_profile method definition
def get_field_level_encryption_profile(
self,
*,
Id: str,
) -> GetFieldLevelEncryptionProfileResultTypeDef: # (1)
...# get_field_level_encryption_profile method usage example with argument unpacking
kwargs: GetFieldLevelEncryptionProfileRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_field_level_encryption_profile(**kwargs)get_field_level_encryption_profile_config#
Get the field-level encryption profile configuration information.
Type annotations and code completion for boto3.client("cloudfront").get_field_level_encryption_profile_config method.
boto3 documentation
# get_field_level_encryption_profile_config method definition
def get_field_level_encryption_profile_config(
self,
*,
Id: str,
) -> GetFieldLevelEncryptionProfileConfigResultTypeDef: # (1)
...# get_field_level_encryption_profile_config method usage example with argument unpacking
kwargs: GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_field_level_encryption_profile_config(**kwargs)get_function#
Gets the code of a CloudFront function.
Type annotations and code completion for boto3.client("cloudfront").get_function method.
boto3 documentation
# get_function method definition
def get_function(
self,
*,
Name: str,
Stage: FunctionStageType = ..., # (1)
) -> GetFunctionResultTypeDef: # (2)
...# get_function method usage example with argument unpacking
kwargs: GetFunctionRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_function(**kwargs)get_invalidation#
Get the information about an invalidation.
Type annotations and code completion for boto3.client("cloudfront").get_invalidation method.
boto3 documentation
# get_invalidation method definition
def get_invalidation(
self,
*,
DistributionId: str,
Id: str,
) -> GetInvalidationResultTypeDef: # (1)
...# get_invalidation method usage example with argument unpacking
kwargs: GetInvalidationRequestRequestTypeDef = { # (1)
"DistributionId": ...,
"Id": ...,
}
parent.get_invalidation(**kwargs)get_key_group#
Gets a key group, including the date and time when the key group was last modified.
Type annotations and code completion for boto3.client("cloudfront").get_key_group method.
boto3 documentation
# get_key_group method definition
def get_key_group(
self,
*,
Id: str,
) -> GetKeyGroupResultTypeDef: # (1)
...# get_key_group method usage example with argument unpacking
kwargs: GetKeyGroupRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_key_group(**kwargs)get_key_group_config#
Gets a key group configuration.
Type annotations and code completion for boto3.client("cloudfront").get_key_group_config method.
boto3 documentation
# get_key_group_config method definition
def get_key_group_config(
self,
*,
Id: str,
) -> GetKeyGroupConfigResultTypeDef: # (1)
...# get_key_group_config method usage example with argument unpacking
kwargs: GetKeyGroupConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_key_group_config(**kwargs)get_monitoring_subscription#
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
Type annotations and code completion for boto3.client("cloudfront").get_monitoring_subscription method.
boto3 documentation
# get_monitoring_subscription method definition
def get_monitoring_subscription(
self,
*,
DistributionId: str,
) -> GetMonitoringSubscriptionResultTypeDef: # (1)
...# get_monitoring_subscription method usage example with argument unpacking
kwargs: GetMonitoringSubscriptionRequestRequestTypeDef = { # (1)
"DistributionId": ...,
}
parent.get_monitoring_subscription(**kwargs)get_origin_access_control#
Gets a CloudFront origin access control, including its unique identifier.
Type annotations and code completion for boto3.client("cloudfront").get_origin_access_control method.
boto3 documentation
# get_origin_access_control method definition
def get_origin_access_control(
self,
*,
Id: str,
) -> GetOriginAccessControlResultTypeDef: # (1)
...# get_origin_access_control method usage example with argument unpacking
kwargs: GetOriginAccessControlRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_origin_access_control(**kwargs)get_origin_access_control_config#
Gets a CloudFront origin access control configuration.
Type annotations and code completion for boto3.client("cloudfront").get_origin_access_control_config method.
boto3 documentation
# get_origin_access_control_config method definition
def get_origin_access_control_config(
self,
*,
Id: str,
) -> GetOriginAccessControlConfigResultTypeDef: # (1)
...# get_origin_access_control_config method usage example with argument unpacking
kwargs: GetOriginAccessControlConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_origin_access_control_config(**kwargs)get_origin_request_policy#
Gets an origin request policy, including the following metadata: * The policy's identifier.
Type annotations and code completion for boto3.client("cloudfront").get_origin_request_policy method.
boto3 documentation
# get_origin_request_policy method definition
def get_origin_request_policy(
self,
*,
Id: str,
) -> GetOriginRequestPolicyResultTypeDef: # (1)
...# get_origin_request_policy method usage example with argument unpacking
kwargs: GetOriginRequestPolicyRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_origin_request_policy(**kwargs)get_origin_request_policy_config#
Gets an origin request policy configuration.
Type annotations and code completion for boto3.client("cloudfront").get_origin_request_policy_config method.
boto3 documentation
# get_origin_request_policy_config method definition
def get_origin_request_policy_config(
self,
*,
Id: str,
) -> GetOriginRequestPolicyConfigResultTypeDef: # (1)
...# get_origin_request_policy_config method usage example with argument unpacking
kwargs: GetOriginRequestPolicyConfigRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_origin_request_policy_config(**kwargs)get_public_key#
Gets a public key.
Type annotations and code completion for boto3.client("cloudfront").get_public_key method.