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

# 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.CannotDeleteEntityWhileInUse,
    client.exceptions.ClientError,
    client.exceptions.CloudFrontOriginAccessIdentityAlreadyExists,
    client.exceptions.CloudFrontOriginAccessIdentityInUse,
    client.exceptions.ContinuousDeploymentPolicyAlreadyExists,
    client.exceptions.ContinuousDeploymentPolicyInUse,
    client.exceptions.DistributionAlreadyExists,
    client.exceptions.DistributionNotDisabled,
    client.exceptions.EntityAlreadyExists,
    client.exceptions.EntityLimitExceeded,
    client.exceptions.EntityNotFound,
    client.exceptions.EntitySizeLimitExceeded,
    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)
    ...
  1. See EmptyResponseMetadataTypeDef
# associate_alias method usage example with argument unpacking

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

# 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 = ...,
    Enabled: bool = ...,
) -> CopyDistributionResultTypeDef:  # (1)
    ...
  1. See CopyDistributionResultTypeDef
# copy_distribution method usage example with argument unpacking

kwargs: CopyDistributionRequestRequestTypeDef = {  # (1)
    "PrimaryDistributionId": ...,
    "CallerReference": ...,
}

parent.copy_distribution(**kwargs)
  1. See CopyDistributionRequestRequestTypeDef

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)
    ...
  1. See CachePolicyConfigTypeDef
  2. See CreateCachePolicyResultTypeDef
# create_cache_policy method usage example with argument unpacking

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

# create_cloud_front_origin_access_identity method definition

def create_cloud_front_origin_access_identity(
    self,
    *,
    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef,  # (1)
) -> CreateCloudFrontOriginAccessIdentityResultTypeDef:  # (2)
    ...
  1. See CloudFrontOriginAccessIdentityConfigTypeDef
  2. 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)
  1. See CreateCloudFrontOriginAccessIdentityRequestRequestTypeDef

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)
    ...
  1. See ContinuousDeploymentPolicyConfigTypeDef
  2. See CreateContinuousDeploymentPolicyResultTypeDef
# create_continuous_deployment_policy method usage example with argument unpacking

kwargs: CreateContinuousDeploymentPolicyRequestRequestTypeDef = {  # (1)
    "ContinuousDeploymentPolicyConfig": ...,
}

parent.create_continuous_deployment_policy(**kwargs)
  1. See CreateContinuousDeploymentPolicyRequestRequestTypeDef

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)
    ...
  1. See DistributionConfigTypeDef
  2. See CreateDistributionResultTypeDef
# create_distribution method usage example with argument unpacking

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

# create_distribution_with_tags method definition

def create_distribution_with_tags(
    self,
    *,
    DistributionConfigWithTags: DistributionConfigWithTagsTypeDef,  # (1)
) -> CreateDistributionWithTagsResultTypeDef:  # (2)
    ...
  1. See DistributionConfigWithTagsTypeDef
  2. See CreateDistributionWithTagsResultTypeDef
# create_distribution_with_tags method usage example with argument unpacking

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

# create_field_level_encryption_config method definition

def create_field_level_encryption_config(
    self,
    *,
    FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionConfigResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionConfigTypeDef
  2. See CreateFieldLevelEncryptionConfigResultTypeDef
# create_field_level_encryption_config method usage example with argument unpacking

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

# create_field_level_encryption_profile method definition

def create_field_level_encryption_profile(
    self,
    *,
    FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionProfileResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionProfileConfigTypeDef
  2. See CreateFieldLevelEncryptionProfileResultTypeDef
# create_field_level_encryption_profile method usage example with argument unpacking

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

# create_function 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
# create_function method usage example with argument unpacking

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

# create_invalidation method definition

def create_invalidation(
    self,
    *,
    DistributionId: str,
    InvalidationBatch: InvalidationBatchTypeDef,  # (1)
) -> CreateInvalidationResultTypeDef:  # (2)
    ...
  1. See InvalidationBatchTypeDef
  2. See CreateInvalidationResultTypeDef
# create_invalidation method usage example with argument unpacking

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

# create_key_group method definition

def create_key_group(
    self,
    *,
    KeyGroupConfig: KeyGroupConfigTypeDef,  # (1)
) -> CreateKeyGroupResultTypeDef:  # (2)
    ...
  1. See KeyGroupConfigTypeDef
  2. See CreateKeyGroupResultTypeDef
# create_key_group method usage example with argument unpacking

kwargs: CreateKeyGroupRequestRequestTypeDef = {  # (1)
    "KeyGroupConfig": ...,
}

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

create_key_value_store#

Specifies the Key Value Store resource to add to your account.

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

# create_key_value_store method definition

def create_key_value_store(
    self,
    *,
    Name: str,
    Comment: str = ...,
    ImportSource: ImportSourceTypeDef = ...,  # (1)
) -> CreateKeyValueStoreResultTypeDef:  # (2)
    ...
  1. See ImportSourceTypeDef
  2. See CreateKeyValueStoreResultTypeDef
# create_key_value_store method usage example with argument unpacking

kwargs: CreateKeyValueStoreRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_key_value_store(**kwargs)
  1. See CreateKeyValueStoreRequestRequestTypeDef

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)
    ...
  1. See MonitoringSubscriptionTypeDef
  2. See CreateMonitoringSubscriptionResultTypeDef
# create_monitoring_subscription method usage example with argument unpacking

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

# create_origin_access_control method definition

def create_origin_access_control(
    self,
    *,
    OriginAccessControlConfig: OriginAccessControlConfigTypeDef,  # (1)
) -> CreateOriginAccessControlResultTypeDef:  # (2)
    ...
  1. See OriginAccessControlConfigTypeDef
  2. See CreateOriginAccessControlResultTypeDef
# create_origin_access_control method usage example with argument unpacking

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

# create_origin_request_policy method definition

def create_origin_request_policy(
    self,
    *,
    OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef,  # (1)
) -> CreateOriginRequestPolicyResultTypeDef:  # (2)
    ...
  1. See OriginRequestPolicyConfigTypeDef
  2. See CreateOriginRequestPolicyResultTypeDef
# create_origin_request_policy method usage example with argument unpacking

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-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)
    ...
  1. See PublicKeyConfigTypeDef
  2. See CreatePublicKeyResultTypeDef
# create_public_key method usage example with argument unpacking

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

# 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)
    ...
  1. See EndPointTypeDef
  2. See CreateRealtimeLogConfigResultTypeDef
# create_realtime_log_config method usage example with argument unpacking

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

# create_response_headers_policy method definition

def create_response_headers_policy(
    self,
    *,
    ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef,  # (1)
) -> CreateResponseHeadersPolicyResultTypeDef:  # (2)
    ...
  1. See ResponseHeadersPolicyConfigTypeDef
  2. See CreateResponseHeadersPolicyResultTypeDef
# create_response_headers_policy method usage example with argument unpacking

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

# create_streaming_distribution method definition

def create_streaming_distribution(
    self,
    *,
    StreamingDistributionConfig: StreamingDistributionConfigTypeDef,  # (1)
) -> CreateStreamingDistributionResultTypeDef:  # (2)
    ...
  1. See StreamingDistributionConfigTypeDef
  2. See CreateStreamingDistributionResultTypeDef
# create_streaming_distribution method usage example with argument unpacking

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

# create_streaming_distribution_with_tags method definition

def create_streaming_distribution_with_tags(
    self,
    *,
    StreamingDistributionConfigWithTags: StreamingDistributionConfigWithTagsTypeDef,  # (1)
) -> CreateStreamingDistributionWithTagsResultTypeDef:  # (2)
    ...
  1. See StreamingDistributionConfigWithTagsTypeDef
  2. See CreateStreamingDistributionWithTagsResultTypeDef
# create_streaming_distribution_with_tags method usage example with argument unpacking

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

# delete_cache_policy method definition

def delete_cache_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_cache_policy method usage example with argument unpacking

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

# delete_cloud_front_origin_access_identity method definition

def delete_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_cloud_front_origin_access_identity method usage example with argument unpacking

kwargs: DeleteCloudFrontOriginAccessIdentityRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

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

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_continuous_deployment_policy method usage example with argument unpacking

kwargs: DeleteContinuousDeploymentPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_continuous_deployment_policy(**kwargs)
  1. See DeleteContinuousDeploymentPolicyRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_distribution method usage example with argument unpacking

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

# delete_field_level_encryption_config method definition

def delete_field_level_encryption_config(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_field_level_encryption_config method usage example with argument unpacking

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

# delete_field_level_encryption_profile method definition

def delete_field_level_encryption_profile(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_field_level_encryption_profile method usage example with argument unpacking

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

# delete_function method definition

def delete_function(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_function method usage example with argument unpacking

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

# delete_key_group method definition

def delete_key_group(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_key_group method usage example with argument unpacking

kwargs: DeleteKeyGroupRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

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

delete_key_value_store#

Specifies the Key Value Store to delete.

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

# delete_key_value_store method definition

def delete_key_value_store(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_key_value_store method usage example with argument unpacking

kwargs: DeleteKeyValueStoreRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IfMatch": ...,
}

parent.delete_key_value_store(**kwargs)
  1. See DeleteKeyValueStoreRequestRequestTypeDef

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)
  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

# delete_origin_access_control method definition

def delete_origin_access_control(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_origin_access_control method usage example with argument unpacking

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

# delete_origin_request_policy method definition

def delete_origin_request_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_origin_request_policy method usage example with argument unpacking

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

# delete_public_key method definition

def delete_public_key(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_public_key method usage example with argument unpacking

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

# delete_realtime_log_config method definition

def delete_realtime_log_config(
    self,
    *,
    Name: str = ...,
    ARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_realtime_log_config method usage example with argument unpacking

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

# delete_response_headers_policy method definition

def delete_response_headers_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_response_headers_policy method usage example with argument unpacking

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

# delete_streaming_distribution method definition

def delete_streaming_distribution(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_streaming_distribution method usage example with argument unpacking

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

# describe_function method definition

def describe_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> DescribeFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See DescribeFunctionResultTypeDef
# describe_function method usage example with argument unpacking

kwargs: DescribeFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

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

describe_key_value_store#

Specifies the Key Value Store and its configuration.

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

# describe_key_value_store method definition

def describe_key_value_store(
    self,
    *,
    Name: str,
) -> DescribeKeyValueStoreResultTypeDef:  # (1)
    ...
  1. See DescribeKeyValueStoreResultTypeDef
# describe_key_value_store method usage example with argument unpacking

kwargs: DescribeKeyValueStoreRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_key_value_store(**kwargs)
  1. See DescribeKeyValueStoreRequestRequestTypeDef

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)
    ...
  1. See GetCachePolicyResultTypeDef
# get_cache_policy method usage example with argument unpacking

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

# get_cache_policy_config method definition

def get_cache_policy_config(
    self,
    *,
    Id: str,
) -> GetCachePolicyConfigResultTypeDef:  # (1)
    ...
  1. See GetCachePolicyConfigResultTypeDef
# get_cache_policy_config method usage example with argument unpacking

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

# get_cloud_front_origin_access_identity method definition

def get_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityResultTypeDef:  # (1)
    ...
  1. See GetCloudFrontOriginAccessIdentityResultTypeDef
# get_cloud_front_origin_access_identity method usage example with argument unpacking

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

# get_cloud_front_origin_access_identity_config method definition

def get_cloud_front_origin_access_identity_config(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityConfigResultTypeDef:  # (1)
    ...
  1. See GetCloudFrontOriginAccessIdentityConfigResultTypeDef
# 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)
  1. See GetCloudFrontOriginAccessIdentityConfigRequestRequestTypeDef

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)
    ...
  1. See GetContinuousDeploymentPolicyResultTypeDef
# get_continuous_deployment_policy method usage example with argument unpacking

kwargs: GetContinuousDeploymentPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_continuous_deployment_policy(**kwargs)
  1. See GetContinuousDeploymentPolicyRequestRequestTypeDef

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)
    ...
  1. See GetContinuousDeploymentPolicyConfigResultTypeDef
# get_continuous_deployment_policy_config method usage example with argument unpacking

kwargs: GetContinuousDeploymentPolicyConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_continuous_deployment_policy_config(**kwargs)
  1. See GetContinuousDeploymentPolicyConfigRequestRequestTypeDef

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)
    ...
  1. See GetDistributionResultTypeDef
# get_distribution method usage example with argument unpacking

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

# get_distribution_config method definition

def get_distribution_config(
    self,
    *,
    Id: str,
) -> GetDistributionConfigResultTypeDef:  # (1)
    ...
  1. See GetDistributionConfigResultTypeDef
# get_distribution_config method usage example with argument unpacking

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

# get_field_level_encryption method definition

def get_field_level_encryption(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionResultTypeDef
# get_field_level_encryption method usage example with argument unpacking

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

# get_field_level_encryption_config method definition

def get_field_level_encryption_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionConfigResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionConfigResultTypeDef
# get_field_level_encryption_config method usage example with argument unpacking

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

# get_field_level_encryption_profile method definition

def get_field_level_encryption_profile(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionProfileResultTypeDef
# get_field_level_encryption_profile method usage example with argument unpacking

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

# get_field_level_encryption_profile_config method definition

def get_field_level_encryption_profile_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileConfigResultTypeDef:  # (1)
    ...
  1. See GetFieldLevelEncryptionProfileConfigResultTypeDef
# get_field_level_encryption_profile_config method usage example with argument unpacking

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

# get_function method definition

def get_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> GetFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See GetFunctionResultTypeDef
# get_function method usage example with argument unpacking

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

# get_invalidation method definition

def get_invalidation(
    self,
    *,
    DistributionId: str,
    Id: str,
) -> GetInvalidationResultTypeDef:  # (1)
    ...
  1. See GetInvalidationResultTypeDef
# get_invalidation method usage example with argument unpacking

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

# get_key_group method definition

def get_key_group(
    self,
    *,
    Id: str,
) -> GetKeyGroupResultTypeDef:  # (1)
    ...
  1. See GetKeyGroupResultTypeDef
# get_key_group method usage example with argument unpacking

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

# get_key_group_config method definition

def get_key_group_config(
    self,
    *,
    Id: str,
) -> GetKeyGroupConfigResultTypeDef:  # (1)
    ...
  1. See GetKeyGroupConfigResultTypeDef
# get_key_group_config method usage example with argument unpacking

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

# get_monitoring_subscription method definition

def get_monitoring_subscription(
    self,
    *,
    DistributionId: str,
) -> GetMonitoringSubscriptionResultTypeDef:  # (1)
    ...
  1. See GetMonitoringSubscriptionResultTypeDef
# get_monitoring_subscription method usage example with argument unpacking

kwargs: GetMonitoringSubscriptionRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
}

parent.get_monitoring_subscription(**kwargs)
  1. See GetMonitoringSubscriptionRequestRequestTypeDef

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)
    ...
  1. See GetOriginAccessControlResultTypeDef
# get_origin_access_control method usage example with argument unpacking

kwargs: GetOriginAccessControlRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_origin_access_control(**kwargs)
  1. See GetOriginAccessControlRequestRequestTypeDef

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)
    ...
  1. See GetOriginAccessControlConfigResultTypeDef
# get_origin_access_control_config method usage example with argument unpacking

kwargs: GetOriginAccessControlConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_origin_access_control_config(**kwargs)
  1. See GetOriginAccessControlConfigRequestRequestTypeDef

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)
    ...
  1. See GetOriginRequestPolicyResultTypeDef
# get_origin_request_policy method usage example with argument unpacking

kwargs: GetOriginRequestPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_origin_request_policy(**kwargs)
  1. See GetOriginRequestPolicyRequestRequestTypeDef

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)
    ...
  1. See GetOriginRequestPolicyConfigResultTypeDef
# get_origin_request_policy_config method usage example with argument unpacking

kwargs: GetOriginRequestPolicyConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_origin_request_policy_config(**kwargs)
  1. See GetOriginRequestPolicyConfigRequestRequestTypeDef

get_public_key#

Gets a public key.

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

# get_public_key method definition

def get_public_key(
    self,
    *,
    Id: str,
) -> GetPublicKeyResultTypeDef:  # (1)
    ...
  1. See GetPublicKeyResultTypeDef
# get_public_key method usage example with argument unpacking

kwargs: GetPublicKeyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_public_key(**kwargs)
  1. See GetPublicKeyRequestRequestTypeDef

get_public_key_config#

Gets a public key configuration.

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

# get_public_key_config method definition

def get_public_key_config(
    self,
    *,
    Id: str,
) -> GetPublicKeyConfigResultTypeDef:  # (1)
    ...
  1. See GetPublicKeyConfigResultTypeDef
# get_public_key_config method usage example with argument unpacking

kwargs: GetPublicKeyConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_public_key_config(**kwargs)
  1. See GetPublicKeyConfigRequestRequestTypeDef

get_realtime_log_config#

Gets a real-time log configuration.

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

# get_realtime_log_config method definition

def get_realtime_log_config(
    self,
    *,
    Name: str = ...,
    ARN: str = ...,
) -> GetRealtimeLogConfigResultTypeDef:  # (1)
    ...
  1. See GetRealtimeLogConfigResultTypeDef
# get_realtime_log_config method usage example with argument unpacking

kwargs: GetRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_realtime_log_config(**kwargs)
  1. See GetRealtimeLogConfigRequestRequestTypeDef

get_response_headers_policy#

Gets a response headers 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_response_headers_policy method. boto3 documentation

# get_response_headers_policy method definition

def get_response_headers_policy(
    self,
    *,
    Id: str,
) -> GetResponseHeadersPolicyResultTypeDef:  # (1)
    ...
  1. See GetResponseHeadersPolicyResultTypeDef
# get_response_headers_policy method usage example with argument unpacking

kwargs: GetResponseHeadersPolicyRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_response_headers_policy(**kwargs)
  1. See GetResponseHeadersPolicyRequestRequestTypeDef

get_response_headers_policy_config#

Gets a response headers policy configuration.

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

# get_response_headers_policy_config method definition

def get_response_headers_policy_config(
    self,
    *,
    Id: str,
) -> GetResponseHeadersPolicyConfigResultTypeDef:  # (1)
    ...
  1. See GetResponseHeadersPolicyConfigResultTypeDef
# get_response_headers_policy_config method usage example with argument unpacking

kwargs: GetResponseHeadersPolicyConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_response_headers_policy_config(**kwargs)
  1. See GetResponseHeadersPolicyConfigRequestRequestTypeDef

get_streaming_distribution#

Gets information about a specified RTMP distribution, including the distribution configuration.

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

# get_streaming_distribution method definition

def get_streaming_distribution(
    self,
    *,
    Id: str,
) -> GetStreamingDistributionResultTypeDef:  # (1)
    ...
  1. See GetStreamingDistributionResultTypeDef
# get_streaming_distribution method usage example with argument unpacking

kwargs: GetStreamingDistributionRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_streaming_distribution(**kwargs)
  1. See GetStreamingDistributionRequestRequestTypeDef

get_streaming_distribution_config#

Get the configuration information about a streaming distribution.

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

# get_streaming_distribution_config method definition

def get_streaming_distribution_config(
    self,
    *,
    Id: str,
) -> GetStreamingDistributionConfigResultTypeDef:  # (1)
    ...
  1. See GetStreamingDistributionConfigResultTypeDef
# get_streaming_distribution_config method usage example with argument unpacking

kwargs: GetStreamingDistributionConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_streaming_distribution_config(**kwargs)
  1. See GetStreamingDistributionConfigRequestRequestTypeDef

list_cache_policies#

Gets a list of cache policies.

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

# list_cache_policies method definition

def list_cache_policies(
    self,
    *,
    Type: CachePolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListCachePoliciesResultTypeDef:  # (2)
    ...
  1. See CachePolicyTypeType
  2. See ListCachePoliciesResultTypeDef
# list_cache_policies method usage example with argument unpacking

kwargs: ListCachePoliciesRequestRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_cache_policies(**kwargs)
  1. See ListCachePoliciesRequestRequestTypeDef

list_cloud_front_origin_access_identities#

Lists origin access identities.

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

# list_cloud_front_origin_access_identities method definition

def list_cloud_front_origin_access_identities(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListCloudFrontOriginAccessIdentitiesResultTypeDef:  # (1)
    ...
  1. See ListCloudFrontOriginAccessIdentitiesResultTypeDef
# list_cloud_front_origin_access_identities method usage example with argument unpacking

kwargs: ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_cloud_front_origin_access_identities(**kwargs)
  1. See ListCloudFrontOriginAccessIdentitiesRequestRequestTypeDef

list_conflicting_aliases#

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.

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

# list_conflicting_aliases method definition

def list_conflicting_aliases(
    self,
    *,
    DistributionId: str,
    Alias: str,
    Marker: str = ...,
    MaxItems: int = ...,
) -> ListConflictingAliasesResultTypeDef:  # (1)
    ...
  1. See ListConflictingAliasesResultTypeDef
# list_conflicting_aliases method usage example with argument unpacking

kwargs: ListConflictingAliasesRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
    "Alias": ...,
}

parent.list_conflicting_aliases(**kwargs)
  1. See ListConflictingAliasesRequestRequestTypeDef

list_continuous_deployment_policies#

Gets a list of the continuous deployment policies in your Amazon Web Services account.

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

# list_continuous_deployment_policies method definition

def list_continuous_deployment_policies(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListContinuousDeploymentPoliciesResultTypeDef:  # (1)
    ...
  1. See ListContinuousDeploymentPoliciesResultTypeDef
# list_continuous_deployment_policies method usage example with argument unpacking

kwargs: ListContinuousDeploymentPoliciesRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_continuous_deployment_policies(**kwargs)
  1. See ListContinuousDeploymentPoliciesRequestRequestTypeDef

list_distributions#

List CloudFront distributions.

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

# list_distributions method definition

def list_distributions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsResultTypeDef:  # (1)
    ...
  1. See ListDistributionsResultTypeDef
# list_distributions method usage example with argument unpacking

kwargs: ListDistributionsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_distributions(**kwargs)
  1. See ListDistributionsRequestRequestTypeDef

list_distributions_by_cache_policy_id#

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.

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

# list_distributions_by_cache_policy_id method definition

def list_distributions_by_cache_policy_id(
    self,
    *,
    CachePolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByCachePolicyIdResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByCachePolicyIdResultTypeDef
# list_distributions_by_cache_policy_id method usage example with argument unpacking

kwargs: ListDistributionsByCachePolicyIdRequestRequestTypeDef = {  # (1)
    "CachePolicyId": ...,
}

parent.list_distributions_by_cache_policy_id(**kwargs)
  1. See ListDistributionsByCachePolicyIdRequestRequestTypeDef

list_distributions_by_key_group#

Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.

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

# list_distributions_by_key_group method definition

def list_distributions_by_key_group(
    self,
    *,
    KeyGroupId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByKeyGroupResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByKeyGroupResultTypeDef
# list_distributions_by_key_group method usage example with argument unpacking

kwargs: ListDistributionsByKeyGroupRequestRequestTypeDef = {  # (1)
    "KeyGroupId": ...,
}

parent.list_distributions_by_key_group(**kwargs)
  1. See ListDistributionsByKeyGroupRequestRequestTypeDef

list_distributions_by_origin_request_policy_id#

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.

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

# list_distributions_by_origin_request_policy_id method definition

def list_distributions_by_origin_request_policy_id(
    self,
    *,
    OriginRequestPolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByOriginRequestPolicyIdResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByOriginRequestPolicyIdResultTypeDef
# list_distributions_by_origin_request_policy_id method usage example with argument unpacking

kwargs: ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef = {  # (1)
    "OriginRequestPolicyId": ...,
}

parent.list_distributions_by_origin_request_policy_id(**kwargs)
  1. See ListDistributionsByOriginRequestPolicyIdRequestRequestTypeDef

list_distributions_by_realtime_log_config#

Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.

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

# list_distributions_by_realtime_log_config method definition

def list_distributions_by_realtime_log_config(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
    RealtimeLogConfigName: str = ...,
    RealtimeLogConfigArn: str = ...,
) -> ListDistributionsByRealtimeLogConfigResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByRealtimeLogConfigResultTypeDef
# list_distributions_by_realtime_log_config method usage example with argument unpacking

kwargs: ListDistributionsByRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_distributions_by_realtime_log_config(**kwargs)
  1. See ListDistributionsByRealtimeLogConfigRequestRequestTypeDef

list_distributions_by_response_headers_policy_id#

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.

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

# list_distributions_by_response_headers_policy_id method definition

def list_distributions_by_response_headers_policy_id(
    self,
    *,
    ResponseHeadersPolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByResponseHeadersPolicyIdResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByResponseHeadersPolicyIdResultTypeDef
# list_distributions_by_response_headers_policy_id method usage example with argument unpacking

kwargs: ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef = {  # (1)
    "ResponseHeadersPolicyId": ...,
}

parent.list_distributions_by_response_headers_policy_id(**kwargs)
  1. See ListDistributionsByResponseHeadersPolicyIdRequestRequestTypeDef

list_distributions_by_web_acl_id#

List the distributions that are associated with a specified WAF web ACL.

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

# list_distributions_by_web_acl_id method definition

def list_distributions_by_web_acl_id(
    self,
    *,
    WebACLId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByWebACLIdResultTypeDef:  # (1)
    ...
  1. See ListDistributionsByWebACLIdResultTypeDef
# list_distributions_by_web_acl_id method usage example with argument unpacking

kwargs: ListDistributionsByWebACLIdRequestRequestTypeDef = {  # (1)
    "WebACLId": ...,
}

parent.list_distributions_by_web_acl_id(**kwargs)
  1. See ListDistributionsByWebACLIdRequestRequestTypeDef

list_field_level_encryption_configs#

List all field-level encryption configurations that have been created in CloudFront for this account.

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

# list_field_level_encryption_configs method definition

def list_field_level_encryption_configs(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListFieldLevelEncryptionConfigsResultTypeDef:  # (1)
    ...
  1. See ListFieldLevelEncryptionConfigsResultTypeDef
# list_field_level_encryption_configs method usage example with argument unpacking

kwargs: ListFieldLevelEncryptionConfigsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_field_level_encryption_configs(**kwargs)
  1. See ListFieldLevelEncryptionConfigsRequestRequestTypeDef

list_field_level_encryption_profiles#

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

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

# list_field_level_encryption_profiles method definition

def list_field_level_encryption_profiles(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListFieldLevelEncryptionProfilesResultTypeDef:  # (1)
    ...
  1. See ListFieldLevelEncryptionProfilesResultTypeDef
# list_field_level_encryption_profiles method usage example with argument unpacking

kwargs: ListFieldLevelEncryptionProfilesRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_field_level_encryption_profiles(**kwargs)
  1. See ListFieldLevelEncryptionProfilesRequestRequestTypeDef

list_functions#

Gets a list of all CloudFront functions in your Amazon Web Services account.

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

# list_functions method definition

def list_functions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
    Stage: FunctionStageType = ...,  # (1)
) -> ListFunctionsResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See ListFunctionsResultTypeDef
# list_functions method usage example with argument unpacking

kwargs: ListFunctionsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_functions(**kwargs)
  1. See ListFunctionsRequestRequestTypeDef

list_invalidations#

Lists invalidation batches.

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

# list_invalidations method definition

def list_invalidations(
    self,
    *,
    DistributionId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListInvalidationsResultTypeDef:  # (1)
    ...
  1. See ListInvalidationsResultTypeDef
# list_invalidations method usage example with argument unpacking

kwargs: ListInvalidationsRequestRequestTypeDef = {  # (1)
    "DistributionId": ...,
}

parent.list_invalidations(**kwargs)
  1. See ListInvalidationsRequestRequestTypeDef

list_key_groups#

Gets a list of key groups.

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

# list_key_groups method definition

def list_key_groups(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListKeyGroupsResultTypeDef:  # (1)
    ...
  1. See ListKeyGroupsResultTypeDef
# list_key_groups method usage example with argument unpacking

kwargs: ListKeyGroupsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_key_groups(**kwargs)
  1. See ListKeyGroupsRequestRequestTypeDef

list_key_value_stores#

Specifies the Key Value Stores to list.

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

# list_key_value_stores method definition

def list_key_value_stores(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
    Status: str = ...,
) -> ListKeyValueStoresResultTypeDef:  # (1)
    ...
  1. See ListKeyValueStoresResultTypeDef
# list_key_value_stores method usage example with argument unpacking

kwargs: ListKeyValueStoresRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_key_value_stores(**kwargs)
  1. See ListKeyValueStoresRequestRequestTypeDef

list_origin_access_controls#

Gets the list of CloudFront origin access controls in this Amazon Web Services account.

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

# list_origin_access_controls method definition

def list_origin_access_controls(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListOriginAccessControlsResultTypeDef:  # (1)
    ...
  1. See ListOriginAccessControlsResultTypeDef
# list_origin_access_controls method usage example with argument unpacking

kwargs: ListOriginAccessControlsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_origin_access_controls(**kwargs)
  1. See ListOriginAccessControlsRequestRequestTypeDef

list_origin_request_policies#

Gets a list of origin request policies.

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

# list_origin_request_policies method definition

def list_origin_request_policies(
    self,
    *,
    Type: OriginRequestPolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListOriginRequestPoliciesResultTypeDef:  # (2)
    ...
  1. See OriginRequestPolicyTypeType
  2. See ListOriginRequestPoliciesResultTypeDef
# list_origin_request_policies method usage example with argument unpacking

kwargs: ListOriginRequestPoliciesRequestRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_origin_request_policies(**kwargs)
  1. See ListOriginRequestPoliciesRequestRequestTypeDef

list_public_keys#

List all public keys that have been added to CloudFront for this account.

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

# list_public_keys method definition

def list_public_keys(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListPublicKeysResultTypeDef:  # (1)
    ...
  1. See ListPublicKeysResultTypeDef
# list_public_keys method usage example with argument unpacking

kwargs: ListPublicKeysRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_public_keys(**kwargs)
  1. See ListPublicKeysRequestRequestTypeDef

list_realtime_log_configs#

Gets a list of real-time log configurations.

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

# list_realtime_log_configs method definition

def list_realtime_log_configs(
    self,
    *,
    MaxItems: str = ...,
    Marker: str = ...,
) -> ListRealtimeLogConfigsResultTypeDef:  # (1)
    ...
  1. See ListRealtimeLogConfigsResultTypeDef
# list_realtime_log_configs method usage example with argument unpacking

kwargs: ListRealtimeLogConfigsRequestRequestTypeDef = {  # (1)
    "MaxItems": ...,
}

parent.list_realtime_log_configs(**kwargs)
  1. See ListRealtimeLogConfigsRequestRequestTypeDef

list_response_headers_policies#

Gets a list of response headers policies.

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

# list_response_headers_policies method definition

def list_response_headers_policies(
    self,
    *,
    Type: ResponseHeadersPolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListResponseHeadersPoliciesResultTypeDef:  # (2)
    ...
  1. See ResponseHeadersPolicyTypeType
  2. See ListResponseHeadersPoliciesResultTypeDef
# list_response_headers_policies method usage example with argument unpacking

kwargs: ListResponseHeadersPoliciesRequestRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_response_headers_policies(**kwargs)
  1. See ListResponseHeadersPoliciesRequestRequestTypeDef

list_streaming_distributions#

List streaming distributions.

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

# list_streaming_distributions method definition

def list_streaming_distributions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListStreamingDistributionsResultTypeDef:  # (1)
    ...
  1. See ListStreamingDistributionsResultTypeDef
# list_streaming_distributions method usage example with argument unpacking

kwargs: ListStreamingDistributionsRequestRequestTypeDef = {  # (1)
    "Marker": ...,
}

parent.list_streaming_distributions(**kwargs)
  1. See ListStreamingDistributionsRequestRequestTypeDef

list_tags_for_resource#

List tags for a CloudFront resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    Resource: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResultTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

publish_function#

Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE.

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

# publish_function method definition

def publish_function(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> PublishFunctionResultTypeDef:  # (1)
    ...
  1. See PublishFunctionResultTypeDef
# publish_function method usage example with argument unpacking

kwargs: PublishFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IfMatch": ...,
}

parent.publish_function(**kwargs)
  1. See PublishFunctionRequestRequestTypeDef

tag_resource#

Add tags to a CloudFront resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    Resource: str,
    Tags: TagsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagsTypeDef
  2. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "Resource": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

test_function#

Tests a CloudFront function.

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

# test_function method definition

def test_function(
    self,
    *,
    Name: str,
    IfMatch: str,
    EventObject: Union[str, bytes, IO[Any], StreamingBody],
    Stage: FunctionStageType = ...,  # (1)
) -> TestFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionStageType
  2. See TestFunctionResultTypeDef
# test_function method usage example with argument unpacking

kwargs: TestFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IfMatch": ...,
    "EventObject": ...,
}

parent.test_function(**kwargs)
  1. See TestFunctionRequestRequestTypeDef

untag_resource#

Remove tags from a CloudFront resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    Resource: str,
    TagKeys: TagKeysTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagKeysTypeDef
  2. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "Resource": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_cache_policy#

Updates a cache policy configuration.

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

# update_cache_policy method definition

def update_cache_policy(
    self,
    *,
    CachePolicyConfig: CachePolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateCachePolicyResultTypeDef:  # (2)
    ...
  1. See CachePolicyConfigTypeDef
  2. See UpdateCachePolicyResultTypeDef
# update_cache_policy method usage example with argument unpacking

kwargs: UpdateCachePolicyRequestRequestTypeDef = {  # (1)
    "CachePolicyConfig": ...,
    "Id": ...,
}

parent.update_cache_policy(**kwargs)
  1. See UpdateCachePolicyRequestRequestTypeDef

update_cloud_front_origin_access_identity#

Update an origin access identity.

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

# update_cloud_front_origin_access_identity method definition

def update_cloud_front_origin_access_identity(
    self,
    *,
    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateCloudFrontOriginAccessIdentityResultTypeDef:  # (2)
    ...
  1. See CloudFrontOriginAccessIdentityConfigTypeDef
  2. See UpdateCloudFrontOriginAccessIdentityResultTypeDef
# update_cloud_front_origin_access_identity method usage example with argument unpacking

kwargs: UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef = {  # (1)
    "CloudFrontOriginAccessIdentityConfig": ...,
    "Id": ...,
}

parent.update_cloud_front_origin_access_identity(**kwargs)
  1. See UpdateCloudFrontOriginAccessIdentityRequestRequestTypeDef

update_continuous_deployment_policy#

Updates a continuous deployment policy.

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

# update_continuous_deployment_policy method definition

def update_continuous_deployment_policy(
    self,
    *,
    ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateContinuousDeploymentPolicyResultTypeDef:  # (2)
    ...
  1. See ContinuousDeploymentPolicyConfigTypeDef
  2. See UpdateContinuousDeploymentPolicyResultTypeDef
# update_continuous_deployment_policy method usage example with argument unpacking

kwargs: UpdateContinuousDeploymentPolicyRequestRequestTypeDef = {  # (1)
    "ContinuousDeploymentPolicyConfig": ...,
    "Id": ...,
}

parent.update_continuous_deployment_policy(**kwargs)
  1. See UpdateContinuousDeploymentPolicyRequestRequestTypeDef

update_distribution#

Updates the configuration for a CloudFront distribution.

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

# update_distribution method definition

def update_distribution(
    self,
    *,
    DistributionConfig: DistributionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateDistributionResultTypeDef:  # (2)
    ...
  1. See DistributionConfigTypeDef
  2. See UpdateDistributionResultTypeDef
# update_distribution method usage example with argument unpacking

kwargs: UpdateDistributionRequestRequestTypeDef = {  # (1)
    "DistributionConfig": ...,
    "Id": ...,
}

parent.update_distribution(**kwargs)
  1. See UpdateDistributionRequestRequestTypeDef

update_distribution_with_staging_config#

Copies the staging distribution's configuration to its corresponding primary distribution.

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

# update_distribution_with_staging_config method definition

def update_distribution_with_staging_config(
    self,
    *,
    Id: str,
    StagingDistributionId: str = ...,
    IfMatch: str = ...,
) -> UpdateDistributionWithStagingConfigResultTypeDef:  # (1)
    ...
  1. See UpdateDistributionWithStagingConfigResultTypeDef
# update_distribution_with_staging_config method usage example with argument unpacking

kwargs: UpdateDistributionWithStagingConfigRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_distribution_with_staging_config(**kwargs)
  1. See UpdateDistributionWithStagingConfigRequestRequestTypeDef

update_field_level_encryption_config#

Update a field-level encryption configuration.

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

# update_field_level_encryption_config method definition

def update_field_level_encryption_config(
    self,
    *,
    FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateFieldLevelEncryptionConfigResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionConfigTypeDef
  2. See UpdateFieldLevelEncryptionConfigResultTypeDef
# update_field_level_encryption_config method usage example with argument unpacking

kwargs: UpdateFieldLevelEncryptionConfigRequestRequestTypeDef = {  # (1)
    "FieldLevelEncryptionConfig": ...,
    "Id": ...,
}

parent.update_field_level_encryption_config(**kwargs)
  1. See UpdateFieldLevelEncryptionConfigRequestRequestTypeDef

update_field_level_encryption_profile#

Update a field-level encryption profile.

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

# update_field_level_encryption_profile method definition

def update_field_level_encryption_profile(
    self,
    *,
    FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateFieldLevelEncryptionProfileResultTypeDef:  # (2)
    ...
  1. See FieldLevelEncryptionProfileConfigTypeDef
  2. See UpdateFieldLevelEncryptionProfileResultTypeDef
# update_field_level_encryption_profile method usage example with argument unpacking

kwargs: UpdateFieldLevelEncryptionProfileRequestRequestTypeDef = {  # (1)
    "FieldLevelEncryptionProfileConfig": ...,
    "Id": ...,
}

parent.update_field_level_encryption_profile(**kwargs)
  1. See UpdateFieldLevelEncryptionProfileRequestRequestTypeDef

update_function#

Updates a CloudFront function.

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

# update_function method definition

def update_function(
    self,
    *,
    Name: str,
    IfMatch: str,
    FunctionConfig: FunctionConfigTypeDef,  # (1)
    FunctionCode: Union[str, bytes, IO[Any], StreamingBody],
) -> UpdateFunctionResultTypeDef:  # (2)
    ...
  1. See FunctionConfigTypeDef
  2. See UpdateFunctionResultTypeDef
# update_function method usage example with argument unpacking

kwargs: UpdateFunctionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IfMatch": ...,
    "FunctionConfig": ...,
    "FunctionCode": ...,
}

parent.update_function(**kwargs)
  1. See UpdateFunctionRequestRequestTypeDef

update_key_group#

Updates a key group.

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

# update_key_group method definition

def update_key_group(
    self,
    *,
    KeyGroupConfig: KeyGroupConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateKeyGroupResultTypeDef:  # (2)
    ...
  1. See KeyGroupConfigTypeDef
  2. See UpdateKeyGroupResultTypeDef
# update_key_group method usage example with argument unpacking

kwargs: UpdateKeyGroupRequestRequestTypeDef = {  # (1)
    "KeyGroupConfig": ...,
    "Id": ...,
}

parent.update_key_group(**kwargs)
  1. See UpdateKeyGroupRequestRequestTypeDef

update_key_value_store#

Specifies the Key Value Store to update.

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

# update_key_value_store method definition

def update_key_value_store(
    self,
    *,
    Name: str,
    Comment: str,
    IfMatch: str,
) -> UpdateKeyValueStoreResultTypeDef:  # (1)
    ...
  1. See UpdateKeyValueStoreResultTypeDef
# update_key_value_store method usage example with argument unpacking

kwargs: UpdateKeyValueStoreRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Comment": ...,
    "IfMatch": ...,
}

parent.update_key_value_store(**kwargs)
  1. See UpdateKeyValueStoreRequestRequestTypeDef

update_origin_access_control#

Updates a CloudFront origin access control.

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

# update_origin_access_control method definition

def update_origin_access_control(
    self,
    *,
    OriginAccessControlConfig: OriginAccessControlConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateOriginAccessControlResultTypeDef:  # (2)
    ...
  1. See OriginAccessControlConfigTypeDef
  2. See UpdateOriginAccessControlResultTypeDef
# update_origin_access_control method usage example with argument unpacking

kwargs: UpdateOriginAccessControlRequestRequestTypeDef = {  # (1)
    "OriginAccessControlConfig": ...,
    "Id": ...,
}

parent.update_origin_access_control(**kwargs)
  1. See UpdateOriginAccessControlRequestRequestTypeDef

update_origin_request_policy#

Updates an origin request policy configuration.

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

# update_origin_request_policy method definition

def update_origin_request_policy(
    self,
    *,
    OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateOriginRequestPolicyResultTypeDef:  # (2)
    ...
  1. See OriginRequestPolicyConfigTypeDef
  2. See UpdateOriginRequestPolicyResultTypeDef
# update_origin_request_policy method usage example with argument unpacking

kwargs: UpdateOriginRequestPolicyRequestRequestTypeDef = {  # (1)
    "OriginRequestPolicyConfig": ...,
    "Id": ...,
}

parent.update_origin_request_policy(**kwargs)
  1. See UpdateOriginRequestPolicyRequestRequestTypeDef

update_public_key#

Update public key information.

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

# update_public_key method definition

def update_public_key(
    self,
    *,
    PublicKeyConfig: PublicKeyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdatePublicKeyResultTypeDef:  # (2)
    ...
  1. See PublicKeyConfigTypeDef
  2. See UpdatePublicKeyResultTypeDef
# update_public_key method usage example with argument unpacking

kwargs: UpdatePublicKeyRequestRequestTypeDef = {  # (1)
    "PublicKeyConfig": ...,
    "Id": ...,
}

parent.update_public_key(**kwargs)
  1. See UpdatePublicKeyRequestRequestTypeDef

update_realtime_log_config#

Updates a real-time log configuration.

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

# update_realtime_log_config method definition

def update_realtime_log_config(
    self,
    *,
    EndPoints: Sequence[EndPointTypeDef] = ...,  # (1)
    Fields: Sequence[str] = ...,
    Name: str = ...,
    ARN: str = ...,
    SamplingRate: int = ...,
) -> UpdateRealtimeLogConfigResultTypeDef:  # (2)
    ...
  1. See EndPointTypeDef
  2. See UpdateRealtimeLogConfigResultTypeDef
# update_realtime_log_config method usage example with argument unpacking

kwargs: UpdateRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "EndPoints": ...,
}

parent.update_realtime_log_config(**kwargs)
  1. See UpdateRealtimeLogConfigRequestRequestTypeDef

update_response_headers_policy#

Updates a response headers policy.

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

# update_response_headers_policy method definition

def update_response_headers_policy(
    self,
    *,
    ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateResponseHeadersPolicyResultTypeDef:  # (2)
    ...
  1. See ResponseHeadersPolicyConfigTypeDef
  2. See UpdateResponseHeadersPolicyResultTypeDef
# update_response_headers_policy method usage example with argument unpacking

kwargs: UpdateResponseHeadersPolicyRequestRequestTypeDef = {  # (1)
    "ResponseHeadersPolicyConfig": ...,
    "Id": ...,
}

parent.update_response_headers_policy(**kwargs)
  1. See UpdateResponseHeadersPolicyRequestRequestTypeDef

update_streaming_distribution#

Update a streaming distribution.

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

# update_streaming_distribution method definition

def update_streaming_distribution(
    self,
    *,
    StreamingDistributionConfig: StreamingDistributionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateStreamingDistributionResultTypeDef:  # (2)
    ...
  1. See StreamingDistributionConfigTypeDef
  2. See UpdateStreamingDistributionResultTypeDef
# update_streaming_distribution method usage example with argument unpacking

kwargs: UpdateStreamingDistributionRequestRequestTypeDef = {  # (1)
    "StreamingDistributionConfig": ...,
    "Id": ...,
}

parent.update_streaming_distribution(**kwargs)
  1. See UpdateStreamingDistributionRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("cloudfront").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("cloudfront").get_waiter method with overloads.