Skip to content

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

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.

Usage example
client = boto3.client("cloudfront")

try:
    do_something(client)
except (
    client.AccessDenied,
    client.BatchTooLarge,
    client.CNAMEAlreadyExists,
    client.CachePolicyAlreadyExists,
    client.CachePolicyInUse,
    client.CannotChangeImmutablePublicKeyFields,
    client.ClientError,
    client.CloudFrontOriginAccessIdentityAlreadyExists,
    client.CloudFrontOriginAccessIdentityInUse,
    client.DistributionAlreadyExists,
    client.DistributionNotDisabled,
    client.FieldLevelEncryptionConfigAlreadyExists,
    client.FieldLevelEncryptionConfigInUse,
    client.FieldLevelEncryptionProfileAlreadyExists,
    client.FieldLevelEncryptionProfileInUse,
    client.FieldLevelEncryptionProfileSizeExceeded,
    client.FunctionAlreadyExists,
    client.FunctionInUse,
    client.FunctionSizeLimitExceeded,
    client.IllegalDelete,
    client.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior,
    client.IllegalOriginAccessConfiguration,
    client.IllegalUpdate,
    client.InconsistentQuantities,
    client.InvalidArgument,
    client.InvalidDefaultRootObject,
    client.InvalidDomainNameForOriginAccessControl,
    client.InvalidErrorCode,
    client.InvalidForwardCookies,
    client.InvalidFunctionAssociation,
    client.InvalidGeoRestrictionParameter,
    client.InvalidHeadersForS3Origin,
    client.InvalidIfMatchVersion,
    client.InvalidLambdaFunctionAssociation,
    client.InvalidLocationCode,
    client.InvalidMinimumProtocolVersion,
    client.InvalidOrigin,
    client.InvalidOriginAccessControl,
    client.InvalidOriginAccessIdentity,
    client.InvalidOriginKeepaliveTimeout,
    client.InvalidOriginReadTimeout,
    client.InvalidProtocolSettings,
    client.InvalidQueryStringParameters,
    client.InvalidRelativePath,
    client.InvalidRequiredProtocol,
    client.InvalidResponseCode,
    client.InvalidTTLOrder,
    client.InvalidTagging,
    client.InvalidViewerCertificate,
    client.InvalidWebACLId,
    client.KeyGroupAlreadyExists,
    client.MissingBody,
    client.MonitoringSubscriptionAlreadyExists,
    client.NoSuchCachePolicy,
    client.NoSuchCloudFrontOriginAccessIdentity,
    client.NoSuchDistribution,
    client.NoSuchFieldLevelEncryptionConfig,
    client.NoSuchFieldLevelEncryptionProfile,
    client.NoSuchFunctionExists,
    client.NoSuchInvalidation,
    client.NoSuchMonitoringSubscription,
    client.NoSuchOrigin,
    client.NoSuchOriginAccessControl,
    client.NoSuchOriginRequestPolicy,
    client.NoSuchPublicKey,
    client.NoSuchRealtimeLogConfig,
    client.NoSuchResource,
    client.NoSuchResponseHeadersPolicy,
    client.NoSuchStreamingDistribution,
    client.OriginAccessControlAlreadyExists,
    client.OriginAccessControlInUse,
    client.OriginRequestPolicyAlreadyExists,
    client.OriginRequestPolicyInUse,
    client.PreconditionFailed,
    client.PublicKeyAlreadyExists,
    client.PublicKeyInUse,
    client.QueryArgProfileEmpty,
    client.RealtimeLogConfigAlreadyExists,
    client.RealtimeLogConfigInUse,
    client.RealtimeLogConfigOwnerMismatch,
    client.ResourceInUse,
    client.ResponseHeadersPolicyAlreadyExists,
    client.ResponseHeadersPolicyInUse,
    client.StreamingDistributionAlreadyExists,
    client.StreamingDistributionNotDisabled,
    client.TestFunctionFailed,
    client.TooLongCSPInResponseHeadersPolicy,
    client.TooManyCacheBehaviors,
    client.TooManyCachePolicies,
    client.TooManyCertificates,
    client.TooManyCloudFrontOriginAccessIdentities,
    client.TooManyCookieNamesInWhiteList,
    client.TooManyCookiesInCachePolicy,
    client.TooManyCookiesInOriginRequestPolicy,
    client.TooManyCustomHeadersInResponseHeadersPolicy,
    client.TooManyDistributionCNAMEs,
    client.TooManyDistributions,
    client.TooManyDistributionsAssociatedToCachePolicy,
    client.TooManyDistributionsAssociatedToFieldLevelEncryptionConfig,
    client.TooManyDistributionsAssociatedToKeyGroup,
    client.TooManyDistributionsAssociatedToOriginAccessControl,
    client.TooManyDistributionsAssociatedToOriginRequestPolicy,
    client.TooManyDistributionsAssociatedToResponseHeadersPolicy,
    client.TooManyDistributionsWithFunctionAssociations,
    client.TooManyDistributionsWithLambdaAssociations,
    client.TooManyDistributionsWithSingleFunctionARN,
    client.TooManyFieldLevelEncryptionConfigs,
    client.TooManyFieldLevelEncryptionContentTypeProfiles,
    client.TooManyFieldLevelEncryptionEncryptionEntities,
    client.TooManyFieldLevelEncryptionFieldPatterns,
    client.TooManyFieldLevelEncryptionProfiles,
    client.TooManyFieldLevelEncryptionQueryArgProfiles,
    client.TooManyFunctionAssociations,
    client.TooManyFunctions,
    client.TooManyHeadersInCachePolicy,
    client.TooManyHeadersInForwardedValues,
    client.TooManyHeadersInOriginRequestPolicy,
    client.TooManyInvalidationsInProgress,
    client.TooManyKeyGroups,
    client.TooManyKeyGroupsAssociatedToDistribution,
    client.TooManyLambdaFunctionAssociations,
    client.TooManyOriginAccessControls,
    client.TooManyOriginCustomHeaders,
    client.TooManyOriginGroupsPerDistribution,
    client.TooManyOriginRequestPolicies,
    client.TooManyOrigins,
    client.TooManyPublicKeys,
    client.TooManyPublicKeysInKeyGroup,
    client.TooManyQueryStringParameters,
    client.TooManyQueryStringsInCachePolicy,
    client.TooManyQueryStringsInOriginRequestPolicy,
    client.TooManyRealtimeLogConfigs,
    client.TooManyResponseHeadersPolicies,
    client.TooManyStreamingDistributionCNAMEs,
    client.TooManyStreamingDistributions,
    client.TooManyTrustedSigners,
    client.TrustedKeyGroupDoesNotExist,
    client.TrustedSignerDoesNotExist,
    client.UnsupportedOperation,
) as e:
    print(e)
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

Method definition
def associate_alias(
    self,
    *,
    TargetDistributionId: str,
    Alias: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateAliasRequestRequestTypeDef = {  # (1)
    "TargetDistributionId": ...,
    "Alias": ...,
}

parent.associate_alias(**kwargs)
  1. See AssociateAliasRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudfront").can_paginate method. boto3 documentation

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

Method definition
def close(
    self,
) -> None:
    ...

create_cache_policy

Creates a cache policy.

Type annotations and code completion for boto3.client("cloudfront").create_cache_policy method. boto3 documentation

Method definition
def create_cache_policy(
    self,
    *,
    CachePolicyConfig: CachePolicyConfigTypeDef,  # (1)
) -> CreateCachePolicyResultTypeDef:  # (2)
    ...
  1. See CachePolicyConfigTypeDef
  2. See CreateCachePolicyResultTypeDef
Usage example with kwargs
kwargs: CreateCachePolicyRequestRequestTypeDef = {  # (1)
    "CachePolicyConfig": ...,
}

parent.create_cache_policy(**kwargs)
  1. See CreateCachePolicyRequestRequestTypeDef

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

Method definition
def create_cloud_front_origin_access_identity(
    self,
    *,
    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef,  # (1)
) -> CreateCloudFrontOriginAccessIdentityResultTypeDef:  # (2)
    ...
  1. See CloudFrontOriginAccessIdentityConfigTypeDef
  2. See CreateCloudFrontOriginAccessIdentityResultTypeDef
Usage example with kwargs
kwargs: CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef = {  # (1)
    "CloudFrontOriginAccessIdentityConfig": ...,
}

parent.create_cloud_front_origin_access_identity(**kwargs)
  1. See CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef

create_distribution

Creates a new web distribution.

Type annotations and code completion for boto3.client("cloudfront").create_distribution method. boto3 documentation

Method definition
def create_distribution(
    self,
    *,
    DistributionConfig: DistributionConfigTypeDef,  # (1)
) -> CreateDistributionResultTypeDef:  # (2)
    ...
  1. See DistributionConfigTypeDef
  2. See CreateDistributionResultTypeDef
Usage example with kwargs
kwargs: CreateDistributionRequestRequestTypeDef = {  # (1)
    "DistributionConfig": ...,
}

parent.create_distribution(**kwargs)
  1. See CreateDistributionRequestRequestTypeDef

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

Method definition
def create_distribution_with_tags(
    self,
    *,
    DistributionConfigWithTags: DistributionConfigWithTagsTypeDef,  # (1)
) -> CreateDistributionWithTagsResultTypeDef:  # (2)
    ...
  1. See DistributionConfigWithTagsTypeDef
  2. See CreateDistributionWithTagsResultTypeDef
Usage example with kwargs
kwargs: CreateDistributionWithTagsRequestRequestTypeDef = {  # (1)
    "DistributionConfigWithTags": ...,
}

parent.create_distribution_with_tags(**kwargs)
  1. See CreateDistributionWithTagsRequestRequestTypeDef

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

Method definition
def create_field_level_encryption_config(
    self,
    *,
    FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionConfigResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionConfigTypeDef
  2. See CreateFieldLevelEncryptionConfigResultTypeDef
Usage example with kwargs
kwargs: CreateFieldLevelEncryptionConfigRequestRequestTypeDef = {  # (1)
    "FieldLevelEncryptionConfig": ...,
}

parent.create_field_level_encryption_config(**kwargs)
  1. See CreateFieldLevelEncryptionConfigRequestRequestTypeDef

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

Method definition
def create_field_level_encryption_profile(
    self,
    *,
    FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionProfileResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionProfileConfigTypeDef
  2. See CreateFieldLevelEncryptionProfileResultTypeDef
Usage example with kwargs
kwargs: CreateFieldLevelEncryptionProfileRequestRequestTypeDef = {  # (1)
    "FieldLevelEncryptionProfileConfig": ...,
}

parent.create_field_level_encryption_profile(**kwargs)
  1. See CreateFieldLevelEncryptionProfileRequestRequestTypeDef

create_function

Creates a CloudFront function.

Type annotations and code completion for boto3.client("cloudfront").create_function method. boto3 documentation

Method definition
def create_function(
    self,
    *,
    Name: str,
    FunctionConfig: FunctionConfigTypeDef,  # (1)
    FunctionCode: Union[str, bytes, IO[Any], StreamingBody],
) -> CreateFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionConfigTypeDef
  2. See CreateFunctionResultTypeDef
Usage example with kwargs
kwargs: CreateFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "FunctionConfig": ...,
    "FunctionCode": ...,
}

parent.create_function(**kwargs)
  1. See CreateFunctionRequestRequestTypeDef

create_invalidation

Create a new invalidation.

Type annotations and code completion for boto3.client("cloudfront").create_invalidation method. boto3 documentation

Method definition
def create_invalidation(
    self,
    *,
    DistributionId: str,
    InvalidationBatch: InvalidationBatchTypeDef,  # (1)
) -> CreateInvalidationResultTypeDef:  # (2)
    ...
  1. See InvalidationBatchTypeDef
  2. See CreateInvalidationResultTypeDef
Usage example with kwargs
kwargs: CreateInvalidationRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
    "InvalidationBatch": ...,
}

parent.create_invalidation(**kwargs)
  1. See CreateInvalidationRequestRequestTypeDef

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

Method definition
def create_key_group(
    self,
    *,
    KeyGroupConfig: KeyGroupConfigTypeDef,  # (1)
) -> CreateKeyGroupResultTypeDef:  # (2)
    ...
  1. See KeyGroupConfigTypeDef
  2. See CreateKeyGroupResultTypeDef
Usage example with kwargs
kwargs: CreateKeyGroupRequestRequestTypeDef = {  # (1)
    "KeyGroupConfig": ...,
}

parent.create_key_group(**kwargs)
  1. See CreateKeyGroupRequestRequestTypeDef

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

Method definition
def create_monitoring_subscription(
    self,
    *,
    DistributionId: str,
    MonitoringSubscription: MonitoringSubscriptionTypeDef,  # (1)
) -> CreateMonitoringSubscriptionResultTypeDef:  # (2)
    ...
  1. See MonitoringSubscriptionTypeDef
  2. See CreateMonitoringSubscriptionResultTypeDef
Usage example with kwargs
kwargs: CreateMonitoringSubscriptionRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
    "MonitoringSubscription": ...,
}

parent.create_monitoring_subscription(**kwargs)
  1. See CreateMonitoringSubscriptionRequestRequestTypeDef

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

Method definition
def create_origin_access_control(
    self,
    *,
    OriginAccessControlConfig: OriginAccessControlConfigTypeDef,  # (1)
) -> CreateOriginAccessControlResultTypeDef:  # (2)
    ...
  1. See OriginAccessControlConfigTypeDef
  2. See CreateOriginAccessControlResultTypeDef
Usage example with kwargs
kwargs: CreateOriginAccessControlRequestRequestTypeDef = {  # (1)
    "OriginAccessControlConfig": ...,
}

parent.create_origin_access_control(**kwargs)
  1. See CreateOriginAccessControlRequestRequestTypeDef

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

Method definition
def create_origin_request_policy(
    self,
    *,
    OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef,  # (1)
) -> CreateOriginRequestPolicyResultTypeDef:  # (2)
    ...
  1. See OriginRequestPolicyConfigTypeDef
  2. See CreateOriginRequestPolicyResultTypeDef
Usage example with kwargs
kwargs: CreateOriginRequestPolicyRequestRequestTypeDef = {  # (1)
    "OriginRequestPolicyConfig": ...,
}

parent.create_origin_request_policy(**kwargs)
  1. See CreateOriginRequestPolicyRequestRequestTypeDef

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- en....

Type annotations and code completion for boto3.client("cloudfront").create_public_key method. boto3 documentation

Method definition
def create_public_key(
    self,
    *,
    PublicKeyConfig: PublicKeyConfigTypeDef,  # (1)
) -> CreatePublicKeyResultTypeDef:  # (2)
    ...
  1. See PublicKeyConfigTypeDef
  2. See CreatePublicKeyResultTypeDef
Usage example with kwargs
kwargs: CreatePublicKeyRequestRequestTypeDef = {  # (1)
    "PublicKeyConfig": ...,
}

parent.create_public_key(**kwargs)
  1. See CreatePublicKeyRequestRequestTypeDef

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

Method definition
def create_realtime_log_config(
    self,
    *,
    EndPoints: Sequence[EndPointTypeDef],  # (1)
    Fields: Sequence[str],
    Name: str,
    SamplingRate: int,
) -> CreateRealtimeLogConfigResultTypeDef:  # (2)
    ...
  1. See EndPointTypeDef
  2. See CreateRealtimeLogConfigResultTypeDef
Usage example with kwargs
kwargs: CreateRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "EndPoints": ...,
    "Fields": ...,
    "Name": ...,
    "SamplingRate": ...,
}

parent.create_realtime_log_config(**kwargs)
  1. See CreateRealtimeLogConfigRequestRequestTypeDef

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

Method definition
def create_response_headers_policy(
    self,
    *,
    ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef,  # (1)
) -> CreateResponseHeadersPolicyResultTypeDef:  # (2)
    ...
  1. See ResponseHeadersPolicyConfigTypeDef
  2. See CreateResponseHeadersPolicyResultTypeDef
Usage example with kwargs
kwargs: CreateResponseHeadersPolicyRequestRequestTypeDef = {  # (1)
    "ResponseHeadersPolicyConfig": ...,
}

parent.create_response_headers_policy(**kwargs)
  1. See CreateResponseHeadersPolicyRequestRequestTypeDef

create_streaming_distribution

This API is deprecated.

Type annotations and code completion for boto3.client("cloudfront").create_streaming_distribution method. boto3 documentation

Method definition
def create_streaming_distribution(
    self,
    *,
    StreamingDistributionConfig: StreamingDistributionConfigTypeDef,  # (1)
) -> CreateStreamingDistributionResultTypeDef:  # (2)
    ...
  1. See StreamingDistributionConfigTypeDef
  2. See CreateStreamingDistributionResultTypeDef
Usage example with kwargs
kwargs: CreateStreamingDistributionRequestRequestTypeDef = {  # (1)
    "StreamingDistributionConfig": ...,
}

parent.create_streaming_distribution(**kwargs)
  1. See CreateStreamingDistributionRequestRequestTypeDef

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

Method definition
def create_streaming_distribution_with_tags(
    self,
    *,
    StreamingDistributionConfigWithTags: StreamingDistributionConfigWithTagsTypeDef,  # (1)
) -> CreateStreamingDistributionWithTagsResultTypeDef:  # (2)
    ...
  1. See StreamingDistributionConfigWithTagsTypeDef
  2. See CreateStreamingDistributionWithTagsResultTypeDef
Usage example with kwargs
kwargs: CreateStreamingDistributionWithTagsRequestRequestTypeDef = {  # (1)
    "StreamingDistributionConfigWithTags": ...,
}

parent.create_streaming_distribution_with_tags(**kwargs)
  1. See CreateStreamingDistributionWithTagsRequestRequestTypeDef

delete_cache_policy

Deletes a cache policy.

Type annotations and code completion for boto3.client("cloudfront").delete_cache_policy method. boto3 documentation

Method definition
def delete_cache_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteCachePolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_cache_policy(**kwargs)
  1. See DeleteCachePolicyRequestRequestTypeDef

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

Method definition
def delete_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_cloud_front_origin_access_identity(**kwargs)
  1. See DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef

delete_distribution

Delete a distribution.

Type annotations and code completion for boto3.client("cloudfront").delete_distribution method. boto3 documentation

Method definition
def delete_distribution(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_distribution(**kwargs)
  1. See DeleteDistributionRequestRequestTypeDef

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

Method definition
def delete_field_level_encryption_config(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFieldLevelEncryptionConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_field_level_encryption_config(**kwargs)
  1. See DeleteFieldLevelEncryptionConfigRequestRequestTypeDef

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

Method definition
def delete_field_level_encryption_profile(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFieldLevelEncryptionProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_field_level_encryption_profile(**kwargs)
  1. See DeleteFieldLevelEncryptionProfileRequestRequestTypeDef

delete_function

Deletes a CloudFront function.

Type annotations and code completion for boto3.client("cloudfront").delete_function method. boto3 documentation

Method definition
def delete_function(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IfMatch": ...,
}

parent.delete_function(**kwargs)
  1. See DeleteFunctionRequestRequestTypeDef

delete_key_group

Deletes a key group.

Type annotations and code completion for boto3.client("cloudfront").delete_key_group method. boto3 documentation

Method definition
def delete_key_group(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteKeyGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_key_group(**kwargs)
  1. See DeleteKeyGroupRequestRequestTypeDef

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

Method definition
def delete_monitoring_subscription(
    self,
    *,
    DistributionId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMonitoringSubscriptionRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
}

parent.delete_monitoring_subscription(**kwargs)
  1. See DeleteMonitoringSubscriptionRequestRequestTypeDef

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

Method definition
def delete_origin_access_control(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteOriginAccessControlRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_origin_access_control(**kwargs)
  1. See DeleteOriginAccessControlRequestRequestTypeDef

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

Method definition
def delete_origin_request_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteOriginRequestPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_origin_request_policy(**kwargs)
  1. See DeleteOriginRequestPolicyRequestRequestTypeDef

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

Method definition
def delete_public_key(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePublicKeyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_public_key(**kwargs)
  1. See DeletePublicKeyRequestRequestTypeDef

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

Method definition
def delete_realtime_log_config(
    self,
    *,
    Name: str = ...,
    ARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_realtime_log_config(**kwargs)
  1. See DeleteRealtimeLogConfigRequestRequestTypeDef

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

Method definition
def delete_response_headers_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteResponseHeadersPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_response_headers_policy(**kwargs)
  1. See DeleteResponseHeadersPolicyRequestRequestTypeDef

delete_streaming_distribution

Delete a streaming distribution.

Type annotations and code completion for boto3.client("cloudfront").delete_streaming_distribution method. boto3 documentation

Method definition
def delete_streaming_distribution(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteStreamingDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_streaming_distribution(**kwargs)
  1. See DeleteStreamingDistributionRequestRequestTypeDef

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

Method definition
def describe_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> DescribeFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See DescribeFunctionResultTypeDef
Usage example with kwargs
kwargs: DescribeFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_function(**kwargs)
  1. See DescribeFunctionRequestRequestTypeDef

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

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

Method definition
def get_cache_policy(
    self,
    *,
    Id: str,
) -> GetCachePolicyResultTypeDef:  # (1)
    ...
  1. See GetCachePolicyResultTypeDef
Usage example with kwargs
kwargs: GetCachePolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_cache_policy(**kwargs)
  1. See GetCachePolicyRequestRequestTypeDef

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

Method definition
def get_cache_policy_config(
    self,
    *,
    Id: str,
) -> GetCachePolicyConfigResultTypeDef:  # (1)
    ...
  1. See GetCachePolicyConfigResultTypeDef
Usage example with kwargs
kwargs: GetCachePolicyConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_cache_policy_config(**kwargs)
  1. See GetCachePolicyConfigRequestRequestTypeDef

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

Method definition
def get_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityResultTypeDef:  # (1)
    ...
  1. See GetCloudFrontOriginAccessIdentityResultTypeDef
Usage example with kwargs
kwargs: GetCloudFrontOriginAccessIdentityRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_cloud_front_origin_access_identity(**kwargs)
  1. See GetCloudFrontOriginAccessIdentityRequestRequestTypeDef

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

Method definition
def get_cloud_front_origin_access_identity_config(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityConfigResultTypeDef:  # (1)
    ...
  1. See GetCloudFrontOriginAccessIdentityConfigResultTypeDef
Usage example with kwargs
kwargs: GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_cloud_front_origin_access_identity_config(**kwargs)
  1. See GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef

get_distribution

Get the information about a distribution.

Type annotations and code completion for boto3.client("cloudfront").get_distribution method. boto3 documentation

Method definition
def get_distribution(
    self,
    *,
    Id: str,
) -> GetDistributionResultTypeDef:  # (1)
    ...
  1. See GetDistributionResultTypeDef
Usage example with kwargs
kwargs: GetDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_distribution(**kwargs)
  1. See GetDistributionRequestRequestTypeDef

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

Method definition
def get_distribution_config(
    self,
    *,
    Id: str,
) -> GetDistributionConfigResultTypeDef:  # (1)
    ...
  1. See GetDistributionConfigResultTypeDef
Usage example with kwargs
kwargs: GetDistributionConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_distribution_config(**kwargs)
  1. See GetDistributionConfigRequestRequestTypeDef

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

Method definition
def get_field_level_encryption(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionResultTypeDef
Usage example with kwargs
kwargs: GetFieldLevelEncryptionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_field_level_encryption(**kwargs)
  1. See GetFieldLevelEncryptionRequestRequestTypeDef

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

Method definition
def get_field_level_encryption_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionConfigResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionConfigResultTypeDef
Usage example with kwargs
kwargs: GetFieldLevelEncryptionConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_field_level_encryption_config(**kwargs)
  1. See GetFieldLevelEncryptionConfigRequestRequestTypeDef

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

Method definition
def get_field_level_encryption_profile(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionProfileResultTypeDef
Usage example with kwargs
kwargs: GetFieldLevelEncryptionProfileRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_field_level_encryption_profile(**kwargs)
  1. See GetFieldLevelEncryptionProfileRequestRequestTypeDef

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

Method definition
def get_field_level_encryption_profile_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileConfigResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionProfileConfigResultTypeDef
Usage example with kwargs
kwargs: GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_field_level_encryption_profile_config(**kwargs)
  1. See GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef

get_function

Gets the code of a CloudFront function.

Type annotations and code completion for boto3.client("cloudfront").get_function method. boto3 documentation

Method definition
def get_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> GetFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See GetFunctionResultTypeDef
Usage example with kwargs
kwargs: GetFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_function(**kwargs)
  1. See GetFunctionRequestRequestTypeDef

get_invalidation

Get the information about an invalidation.

Type annotations and code completion for boto3.client("cloudfront").get_invalidation method. boto3 documentation

Method definition
def get_invalidation(
    self,
    *,
    DistributionId: str,
    Id: str,
) -> GetInvalidationResultTypeDef:  # (1)
    ...
  1. See GetInvalidationResultTypeDef
Usage example with kwargs
kwargs: GetInvalidationRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
    "Id": ...,
}

parent.get_invalidation(**kwargs)
  1. See GetInvalidationRequestRequestTypeDef

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

Method definition
def get_key_group(
    self,
    *,
    Id: str,
) -> GetKeyGroupResultTypeDef:  # (1)
    ...
  1. See GetKeyGroupResultTypeDef
Usage example with kwargs
kwargs: GetKeyGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_key_group(**kwargs)
  1. See GetKeyGroupRequestRequestTypeDef

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

Method definition
def get_key_group_config(
    self,
    *,
    Id: str,
) -> GetKeyGroupConfigResultTypeDef:  # (1)
    ...
  1. See GetKeyGroupConfigResultTypeDef
Usage example with kwargs
kwargs: GetKeyGroupConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_key_group_config(**kwargs)
  1. See GetKeyGroupConfigRequestRequestTypeDef

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

Method definition
def get_monitoring_subscription(
    self,
    *,
    DistributionId: str,