CloudFrontClient

Index > CloudFront > CloudFrontClient

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

CloudFrontClient

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

Usage example

from boto3.session import Session
from mypy_boto3_cloudfront.client import CloudFrontClient

def get_cloudfront_client() -> CloudFrontClient:
    return Session().client("cloudfront")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudfront").exceptions structure.

Usage example

client = boto3.client("cloudfront")

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

Type checking example

from mypy_boto3_cloudfront.client import Exceptions

def handle_error(exc: Exceptions.AccessDenied) -> None:
    ...

Methods

associate_alias

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.

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

Method definition

def associate_alias(
    self,
    *,
    TargetDistributionId: str,
    Alias: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: AssociateAliasRequestRequestTypeDef = {  # (1)
    "TargetDistributionId": ...,
    "Alias": ...,
}

parent.associate_alias(**kwargs)

See AssociateAliasRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

Method definition

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

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

Method definition

def copy_distribution(
    self,
    *,
    PrimaryDistributionId: str,
    CallerReference: str,
    Staging: bool = ...,
    IfMatch: str = ...,
) -> CopyDistributionResultTypeDef:  # (1)
    ...

See CopyDistributionResultTypeDef

Usage example with kwargs

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

parent.copy_distribution(**kwargs)

See CopyDistributionRequestRequestTypeDef

create_cache_policy

Creates a cache policy.

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

Method definition

def create_cache_policy(
    self,
    *,
    CachePolicyConfig: CachePolicyConfigTypeDef,  # (1)
) -> CreateCachePolicyResultTypeDef:  # (2)
    ...

See CachePolicyConfigTypeDef
See CreateCachePolicyResultTypeDef

Usage example with kwargs

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

parent.create_cache_policy(**kwargs)

See CreateCachePolicyRequestRequestTypeDef

create_cloud_front_origin_access_identity

Creates a new origin access identity.

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

Method definition

def create_cloud_front_origin_access_identity(
    self,
    *,
    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef,  # (1)
) -> CreateCloudFrontOriginAccessIdentityResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_cloud_front_origin_access_identity(**kwargs)

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

Method definition

def create_continuous_deployment_policy(
    self,
    *,
    ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfigTypeDef,  # (1)
) -> CreateContinuousDeploymentPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_continuous_deployment_policy(**kwargs)

See CreateContinuousDeploymentPolicyRequestRequestTypeDef

create_distribution

Creates a CloudFront distribution.

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

Method definition

def create_distribution(
    self,
    *,
    DistributionConfig: DistributionConfigTypeDef,  # (1)
) -> CreateDistributionResultTypeDef:  # (2)
    ...

See DistributionConfigTypeDef
See CreateDistributionResultTypeDef

Usage example with kwargs

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

parent.create_distribution(**kwargs)

See CreateDistributionRequestRequestTypeDef

create_distribution_with_tags

Create a new distribution with tags.

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

Method definition

def create_distribution_with_tags(
    self,
    *,
    DistributionConfigWithTags: DistributionConfigWithTagsTypeDef,  # (1)
) -> CreateDistributionWithTagsResultTypeDef:  # (2)
    ...

Usage example with kwargs

kwargs: CreateDistributionWithTagsRequestRequestTypeDef = {  # (1)
    "DistributionConfigWithTags": ...,
}

parent.create_distribution_with_tags(**kwargs)

See CreateDistributionWithTagsRequestRequestTypeDef

create_field_level_encryption_config

Create a new field-level encryption configuration.

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

Method definition

def create_field_level_encryption_config(
    self,
    *,
    FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionConfigResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_field_level_encryption_config(**kwargs)

See CreateFieldLevelEncryptionConfigRequestRequestTypeDef

create_field_level_encryption_profile

Create a field-level encryption profile.

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

Method definition

def create_field_level_encryption_profile(
    self,
    *,
    FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef,  # (1)
) -> CreateFieldLevelEncryptionProfileResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_field_level_encryption_profile(**kwargs)

See CreateFieldLevelEncryptionProfileRequestRequestTypeDef

create_function

Creates a CloudFront function.

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

Method definition

def create_function(
    self,
    *,
    Name: str,
    FunctionConfig: FunctionConfigTypeDef,  # (1)
    FunctionCode: Union[str, bytes, IO[Any], StreamingBody],
) -> CreateFunctionResultTypeDef:  # (2)
    ...

See FunctionConfigTypeDef
See CreateFunctionResultTypeDef

Usage example with kwargs

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

parent.create_function(**kwargs)

See CreateFunctionRequestRequestTypeDef

create_invalidation

Create a new invalidation.

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

Method definition

def create_invalidation(
    self,
    *,
    DistributionId: str,
    InvalidationBatch: InvalidationBatchTypeDef,  # (1)
) -> CreateInvalidationResultTypeDef:  # (2)
    ...

See InvalidationBatchTypeDef
See CreateInvalidationResultTypeDef

Usage example with kwargs

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

parent.create_invalidation(**kwargs)

See CreateInvalidationRequestRequestTypeDef

create_key_group

Creates a key group that you can use with CloudFront signed URLs and signed cookies_.

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

Method definition

def create_key_group(
    self,
    *,
    KeyGroupConfig: KeyGroupConfigTypeDef,  # (1)
) -> CreateKeyGroupResultTypeDef:  # (2)
    ...

See KeyGroupConfigTypeDef
See CreateKeyGroupResultTypeDef

Usage example with kwargs

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

parent.create_key_group(**kwargs)

See CreateKeyGroupRequestRequestTypeDef

create_monitoring_subscription

Enables additional CloudWatch metrics for the specified CloudFront distribution.

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

Method definition

def create_monitoring_subscription(
    self,
    *,
    DistributionId: str,
    MonitoringSubscription: MonitoringSubscriptionTypeDef,  # (1)
) -> CreateMonitoringSubscriptionResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_monitoring_subscription(**kwargs)

See CreateMonitoringSubscriptionRequestRequestTypeDef

create_origin_access_control

Creates a new origin access control in CloudFront.

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

Method definition

def create_origin_access_control(
    self,
    *,
    OriginAccessControlConfig: OriginAccessControlConfigTypeDef,  # (1)
) -> CreateOriginAccessControlResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_origin_access_control(**kwargs)

See CreateOriginAccessControlRequestRequestTypeDef

create_origin_request_policy

Creates an origin request policy.

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

Method definition

def create_origin_request_policy(
    self,
    *,
    OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef,  # (1)
) -> CreateOriginRequestPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_origin_request_policy(**kwargs)

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

Method definition

def create_public_key(
    self,
    *,
    PublicKeyConfig: PublicKeyConfigTypeDef,  # (1)
) -> CreatePublicKeyResultTypeDef:  # (2)
    ...

See PublicKeyConfigTypeDef
See CreatePublicKeyResultTypeDef

Usage example with kwargs

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

parent.create_public_key(**kwargs)

See CreatePublicKeyRequestRequestTypeDef

create_realtime_log_config

Creates a real-time log configuration.

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

Method definition

def create_realtime_log_config(
    self,
    *,
    EndPoints: Sequence[EndPointTypeDef],  # (1)
    Fields: Sequence[str],
    Name: str,
    SamplingRate: int,
) -> CreateRealtimeLogConfigResultTypeDef:  # (2)
    ...

See EndPointTypeDef
See CreateRealtimeLogConfigResultTypeDef

Usage example with kwargs

kwargs: CreateRealtimeLogConfigRequestRequestTypeDef = {  # (1)
    "EndPoints": ...,
    "Fields": ...,
    "Name": ...,
    "SamplingRate": ...,
}

parent.create_realtime_log_config(**kwargs)

See CreateRealtimeLogConfigRequestRequestTypeDef

create_response_headers_policy

Creates a response headers policy.

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

Method definition

def create_response_headers_policy(
    self,
    *,
    ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef,  # (1)
) -> CreateResponseHeadersPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_response_headers_policy(**kwargs)

See CreateResponseHeadersPolicyRequestRequestTypeDef

create_streaming_distribution

This API is deprecated.

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

Method definition

def create_streaming_distribution(
    self,
    *,
    StreamingDistributionConfig: StreamingDistributionConfigTypeDef,  # (1)
) -> CreateStreamingDistributionResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.create_streaming_distribution(**kwargs)

See CreateStreamingDistributionRequestRequestTypeDef

create_streaming_distribution_with_tags

This API is deprecated.

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

Method definition

def create_streaming_distribution_with_tags(
    self,
    *,
    StreamingDistributionConfigWithTags: StreamingDistributionConfigWithTagsTypeDef,  # (1)
) -> CreateStreamingDistributionWithTagsResultTypeDef:  # (2)
    ...

Usage example with kwargs

kwargs: CreateStreamingDistributionWithTagsRequestRequestTypeDef = {  # (1)
    "StreamingDistributionConfigWithTags": ...,
}

parent.create_streaming_distribution_with_tags(**kwargs)

See CreateStreamingDistributionWithTagsRequestRequestTypeDef

delete_cache_policy

Deletes a cache policy.

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

Method definition

def delete_cache_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_cache_policy(**kwargs)

See DeleteCachePolicyRequestRequestTypeDef

delete_cloud_front_origin_access_identity

Delete an origin access identity.

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

Method definition

def delete_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_cloud_front_origin_access_identity(**kwargs)

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

Method definition

def delete_continuous_deployment_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_continuous_deployment_policy(**kwargs)

See DeleteContinuousDeploymentPolicyRequestRequestTypeDef

delete_distribution

Delete a distribution.

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

Method definition

def delete_distribution(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_distribution(**kwargs)

See DeleteDistributionRequestRequestTypeDef

delete_field_level_encryption_config

Remove a field-level encryption configuration.

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

Method definition

def delete_field_level_encryption_config(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_field_level_encryption_config(**kwargs)

See DeleteFieldLevelEncryptionConfigRequestRequestTypeDef

delete_field_level_encryption_profile

Remove a field-level encryption profile.

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

Method definition

def delete_field_level_encryption_profile(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_field_level_encryption_profile(**kwargs)

See DeleteFieldLevelEncryptionProfileRequestRequestTypeDef

delete_function

Deletes a CloudFront function.

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

Method definition

def delete_function(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_function(**kwargs)

See DeleteFunctionRequestRequestTypeDef

delete_key_group

Deletes a key group.

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

Method definition

def delete_key_group(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_key_group(**kwargs)

See DeleteKeyGroupRequestRequestTypeDef

delete_monitoring_subscription

Disables additional CloudWatch metrics for the specified CloudFront distribution.

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

Method definition

def delete_monitoring_subscription(
    self,
    *,
    DistributionId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_monitoring_subscription(**kwargs)

See DeleteMonitoringSubscriptionRequestRequestTypeDef

delete_origin_access_control

Deletes a CloudFront origin access control.

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

Method definition

def delete_origin_access_control(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_origin_access_control(**kwargs)

See DeleteOriginAccessControlRequestRequestTypeDef

delete_origin_request_policy

Deletes an origin request policy.

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

Method definition

def delete_origin_request_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_origin_request_policy(**kwargs)

See DeleteOriginRequestPolicyRequestRequestTypeDef

delete_public_key

Remove a public key you previously added to CloudFront.

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

Method definition

def delete_public_key(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_public_key(**kwargs)

See DeletePublicKeyRequestRequestTypeDef

delete_realtime_log_config

Deletes a real-time log configuration.

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

Method definition

def delete_realtime_log_config(
    self,
    *,
    Name: str = ...,
    ARN: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_realtime_log_config(**kwargs)

See DeleteRealtimeLogConfigRequestRequestTypeDef

delete_response_headers_policy

Deletes a response headers policy.

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

Method definition

def delete_response_headers_policy(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_response_headers_policy(**kwargs)

See DeleteResponseHeadersPolicyRequestRequestTypeDef

delete_streaming_distribution

Delete a streaming distribution.

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

Method definition

def delete_streaming_distribution(
    self,
    *,
    Id: str,
    IfMatch: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_streaming_distribution(**kwargs)

See DeleteStreamingDistributionRequestRequestTypeDef

describe_function

Gets configuration information and metadata about a CloudFront function, but not the function's code.

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

Method definition

def describe_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> DescribeFunctionResultTypeDef:  # (2)
    ...

See FunctionStageType
See DescribeFunctionResultTypeDef

Usage example with kwargs

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

parent.describe_function(**kwargs)

See DescribeFunctionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_cache_policy

Gets a cache policy, including the following metadata * The policy's identifier.

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

Method definition

def get_cache_policy(
    self,
    *,
    Id: str,
) -> GetCachePolicyResultTypeDef:  # (1)
    ...

See GetCachePolicyResultTypeDef

Usage example with kwargs

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

parent.get_cache_policy(**kwargs)

See GetCachePolicyRequestRequestTypeDef

get_cache_policy_config

Gets a cache policy configuration.

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

Method definition

def get_cache_policy_config(
    self,
    *,
    Id: str,
) -> GetCachePolicyConfigResultTypeDef:  # (1)
    ...

See GetCachePolicyConfigResultTypeDef

Usage example with kwargs

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

parent.get_cache_policy_config(**kwargs)

See GetCachePolicyConfigRequestRequestTypeDef

get_cloud_front_origin_access_identity

Get the information about an origin access identity.

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

Method definition

def get_cloud_front_origin_access_identity(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityResultTypeDef:  # (1)
    ...

See GetCloudFrontOriginAccessIdentityResultTypeDef

Usage example with kwargs

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

parent.get_cloud_front_origin_access_identity(**kwargs)

See GetCloudFrontOriginAccessIdentityRequestRequestTypeDef

get_cloud_front_origin_access_identity_config

Get the configuration information about an origin access identity.

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

Method definition

def get_cloud_front_origin_access_identity_config(
    self,
    *,
    Id: str,
) -> GetCloudFrontOriginAccessIdentityConfigResultTypeDef:  # (1)
    ...

See GetCloudFrontOriginAccessIdentityConfigResultTypeDef

Usage example with kwargs

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

parent.get_cloud_front_origin_access_identity_config(**kwargs)

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

Method definition

def get_continuous_deployment_policy(
    self,
    *,
    Id: str,
) -> GetContinuousDeploymentPolicyResultTypeDef:  # (1)
    ...

See GetContinuousDeploymentPolicyResultTypeDef

Usage example with kwargs

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

parent.get_continuous_deployment_policy(**kwargs)

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

Method definition

def get_continuous_deployment_policy_config(
    self,
    *,
    Id: str,
) -> GetContinuousDeploymentPolicyConfigResultTypeDef:  # (1)
    ...

See GetContinuousDeploymentPolicyConfigResultTypeDef

Usage example with kwargs

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

parent.get_continuous_deployment_policy_config(**kwargs)

See GetContinuousDeploymentPolicyConfigRequestRequestTypeDef

get_distribution

Get the information about a distribution.

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

Method definition

def get_distribution(
    self,
    *,
    Id: str,
) -> GetDistributionResultTypeDef:  # (1)
    ...

See GetDistributionResultTypeDef

Usage example with kwargs

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

parent.get_distribution(**kwargs)

See GetDistributionRequestRequestTypeDef

get_distribution_config

Get the configuration information about a distribution.

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

Method definition

def get_distribution_config(
    self,
    *,
    Id: str,
) -> GetDistributionConfigResultTypeDef:  # (1)
    ...

See GetDistributionConfigResultTypeDef

Usage example with kwargs

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

parent.get_distribution_config(**kwargs)

See GetDistributionConfigRequestRequestTypeDef

get_field_level_encryption

Get the field-level encryption configuration information.

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

Method definition

def get_field_level_encryption(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionResultTypeDef:  # (1)
    ...

See GetFieldLevelEncryptionResultTypeDef

Usage example with kwargs

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

parent.get_field_level_encryption(**kwargs)

See GetFieldLevelEncryptionRequestRequestTypeDef

get_field_level_encryption_config

Get the field-level encryption configuration information.

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

Method definition

def get_field_level_encryption_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionConfigResultTypeDef:  # (1)
    ...

See GetFieldLevelEncryptionConfigResultTypeDef

Usage example with kwargs

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

parent.get_field_level_encryption_config(**kwargs)

See GetFieldLevelEncryptionConfigRequestRequestTypeDef

get_field_level_encryption_profile

Get the field-level encryption profile information.

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

Method definition

def get_field_level_encryption_profile(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileResultTypeDef:  # (1)
    ...

See GetFieldLevelEncryptionProfileResultTypeDef

Usage example with kwargs

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

parent.get_field_level_encryption_profile(**kwargs)

See GetFieldLevelEncryptionProfileRequestRequestTypeDef

get_field_level_encryption_profile_config

Get the field-level encryption profile configuration information.

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

Method definition

def get_field_level_encryption_profile_config(
    self,
    *,
    Id: str,
) -> GetFieldLevelEncryptionProfileConfigResultTypeDef:  # (1)
    ...

See GetFieldLevelEncryptionProfileConfigResultTypeDef

Usage example with kwargs

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

parent.get_field_level_encryption_profile_config(**kwargs)

See GetFieldLevelEncryptionProfileConfigRequestRequestTypeDef

get_function

Gets the code of a CloudFront function.

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

Method definition

def get_function(
    self,
    *,
    Name: str,
    Stage: FunctionStageType = ...,  # (1)
) -> GetFunctionResultTypeDef:  # (2)
    ...

See FunctionStageType
See GetFunctionResultTypeDef

Usage example with kwargs

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

parent.get_function(**kwargs)

See GetFunctionRequestRequestTypeDef

get_invalidation

Get the information about an invalidation.

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

Method definition

def get_invalidation(
    self,
    *,
    DistributionId: str,
    Id: str,
) -> GetInvalidationResultTypeDef:  # (1)
    ...

See GetInvalidationResultTypeDef

Usage example with kwargs

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

parent.get_invalidation(**kwargs)

See GetInvalidationRequestRequestTypeDef

get_key_group

Gets a key group, including the date and time when the key group was last modified.

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

Method definition

def get_key_group(
    self,
    *,
    Id: str,
) -> GetKeyGroupResultTypeDef:  # (1)
    ...

See GetKeyGroupResultTypeDef

Usage example with kwargs

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

parent.get_key_group(**kwargs)

See GetKeyGroupRequestRequestTypeDef

get_key_group_config

Gets a key group configuration.

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

Method definition

def get_key_group_config(
    self,
    *,
    Id: str,
) -> GetKeyGroupConfigResultTypeDef:  # (1)
    ...

See GetKeyGroupConfigResultTypeDef

Usage example with kwargs

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

parent.get_key_group_config(**kwargs)

See GetKeyGroupConfigRequestRequestTypeDef

get_monitoring_subscription

Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.

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

Method definition

def get_monitoring_subscription(
    self,
    *,
    DistributionId: str,
) -> GetMonitoringSubscriptionResultTypeDef:  # (1)
    ...

See GetMonitoringSubscriptionResultTypeDef

Usage example with kwargs

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

parent.get_monitoring_subscription(**kwargs)

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

Method definition

def get_origin_access_control(
    self,
    *,
    Id: str,
) -> GetOriginAccessControlResultTypeDef:  # (1)
    ...

See GetOriginAccessControlResultTypeDef

Usage example with kwargs

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

parent.get_origin_access_control(**kwargs)

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

Method definition

def get_origin_access_control_config(
    self,
    *,
    Id: str,
) -> GetOriginAccessControlConfigResultTypeDef:  # (1)
    ...

See GetOriginAccessControlConfigResultTypeDef

Usage example with kwargs

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

parent.get_origin_access_control_config(**kwargs)

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

Method definition

def get_origin_request_policy(
    self,
    *,
    Id: str,
) -> GetOriginRequestPolicyResultTypeDef:  # (1)
    ...

See GetOriginRequestPolicyResultTypeDef

Usage example with kwargs

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

parent.get_origin_request_policy(**kwargs)

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

Method definition

def get_origin_request_policy_config(
    self,
    *,
    Id: str,
) -> GetOriginRequestPolicyConfigResultTypeDef:  # (1)
    ...

See GetOriginRequestPolicyConfigResultTypeDef

Usage example with kwargs

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

parent.get_origin_request_policy_config(**kwargs)

See GetOriginRequestPolicyConfigRequestRequestTypeDef

get_public_key

Gets a public key.

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

Method definition

def get_public_key(
    self,
    *,
    Id: str,
) -> GetPublicKeyResultTypeDef:  # (1)
    ...

See GetPublicKeyResultTypeDef

Usage example with kwargs

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

parent.get_public_key(**kwargs)

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

Method definition

def get_public_key_config(
    self,
    *,
    Id: str,
) -> GetPublicKeyConfigResultTypeDef:  # (1)
    ...

See GetPublicKeyConfigResultTypeDef

Usage example with kwargs

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

parent.get_public_key_config(**kwargs)

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

Method definition

def get_realtime_log_config(
    self,
    *,
    Name: str = ...,
    ARN: str = ...,
) -> GetRealtimeLogConfigResultTypeDef:  # (1)
    ...

See GetRealtimeLogConfigResultTypeDef

Usage example with kwargs

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

parent.get_realtime_log_config(**kwargs)

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

Method definition

def get_response_headers_policy(
    self,
    *,
    Id: str,
) -> GetResponseHeadersPolicyResultTypeDef:  # (1)
    ...

See GetResponseHeadersPolicyResultTypeDef

Usage example with kwargs

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

parent.get_response_headers_policy(**kwargs)

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

Method definition

def get_response_headers_policy_config(
    self,
    *,
    Id: str,
) -> GetResponseHeadersPolicyConfigResultTypeDef:  # (1)
    ...

See GetResponseHeadersPolicyConfigResultTypeDef

Usage example with kwargs

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

parent.get_response_headers_policy_config(**kwargs)

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

Method definition

def get_streaming_distribution(
    self,
    *,
    Id: str,
) -> GetStreamingDistributionResultTypeDef:  # (1)
    ...

See GetStreamingDistributionResultTypeDef

Usage example with kwargs

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

parent.get_streaming_distribution(**kwargs)

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

Method definition

def get_streaming_distribution_config(
    self,
    *,
    Id: str,
) -> GetStreamingDistributionConfigResultTypeDef:  # (1)
    ...

See GetStreamingDistributionConfigResultTypeDef

Usage example with kwargs

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

parent.get_streaming_distribution_config(**kwargs)

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

Method definition

def list_cache_policies(
    self,
    *,
    Type: CachePolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListCachePoliciesResultTypeDef:  # (2)
    ...

See CachePolicyTypeType
See ListCachePoliciesResultTypeDef

Usage example with kwargs

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

parent.list_cache_policies(**kwargs)

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

Method definition

def list_cloud_front_origin_access_identities(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListCloudFrontOriginAccessIdentitiesResultTypeDef:  # (1)
    ...

See ListCloudFrontOriginAccessIdentitiesResultTypeDef

Usage example with kwargs

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

parent.list_cloud_front_origin_access_identities(**kwargs)

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

Method definition

def list_conflicting_aliases(
    self,
    *,
    DistributionId: str,
    Alias: str,
    Marker: str = ...,
    MaxItems: int = ...,
) -> ListConflictingAliasesResultTypeDef:  # (1)
    ...

See ListConflictingAliasesResultTypeDef

Usage example with kwargs

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

parent.list_conflicting_aliases(**kwargs)

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

Method definition

def list_continuous_deployment_policies(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListContinuousDeploymentPoliciesResultTypeDef:  # (1)
    ...

See ListContinuousDeploymentPoliciesResultTypeDef

Usage example with kwargs

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

parent.list_continuous_deployment_policies(**kwargs)

See ListContinuousDeploymentPoliciesRequestRequestTypeDef

list_distributions

List CloudFront distributions.

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

Method definition

def list_distributions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsResultTypeDef:  # (1)
    ...

See ListDistributionsResultTypeDef

Usage example with kwargs

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

parent.list_distributions(**kwargs)

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

Method definition

def list_distributions_by_cache_policy_id(
    self,
    *,
    CachePolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByCachePolicyIdResultTypeDef:  # (1)
    ...

See ListDistributionsByCachePolicyIdResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_cache_policy_id(**kwargs)

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

Method definition

def list_distributions_by_key_group(
    self,
    *,
    KeyGroupId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByKeyGroupResultTypeDef:  # (1)
    ...

See ListDistributionsByKeyGroupResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_key_group(**kwargs)

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

Method definition

def list_distributions_by_origin_request_policy_id(
    self,
    *,
    OriginRequestPolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByOriginRequestPolicyIdResultTypeDef:  # (1)
    ...

See ListDistributionsByOriginRequestPolicyIdResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_origin_request_policy_id(**kwargs)

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

Method definition

def list_distributions_by_realtime_log_config(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
    RealtimeLogConfigName: str = ...,
    RealtimeLogConfigArn: str = ...,
) -> ListDistributionsByRealtimeLogConfigResultTypeDef:  # (1)
    ...

See ListDistributionsByRealtimeLogConfigResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_realtime_log_config(**kwargs)

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

Method definition

def list_distributions_by_response_headers_policy_id(
    self,
    *,
    ResponseHeadersPolicyId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByResponseHeadersPolicyIdResultTypeDef:  # (1)
    ...

See ListDistributionsByResponseHeadersPolicyIdResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_response_headers_policy_id(**kwargs)

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

Method definition

def list_distributions_by_web_acl_id(
    self,
    *,
    WebACLId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListDistributionsByWebACLIdResultTypeDef:  # (1)
    ...

See ListDistributionsByWebACLIdResultTypeDef

Usage example with kwargs

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

parent.list_distributions_by_web_acl_id(**kwargs)

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

Method definition

def list_field_level_encryption_configs(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListFieldLevelEncryptionConfigsResultTypeDef:  # (1)
    ...

See ListFieldLevelEncryptionConfigsResultTypeDef

Usage example with kwargs

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

parent.list_field_level_encryption_configs(**kwargs)

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

Method definition

def list_field_level_encryption_profiles(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListFieldLevelEncryptionProfilesResultTypeDef:  # (1)
    ...

See ListFieldLevelEncryptionProfilesResultTypeDef

Usage example with kwargs

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

parent.list_field_level_encryption_profiles(**kwargs)

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

Method definition

def list_functions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
    Stage: FunctionStageType = ...,  # (1)
) -> ListFunctionsResultTypeDef:  # (2)
    ...

See FunctionStageType
See ListFunctionsResultTypeDef

Usage example with kwargs

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

parent.list_functions(**kwargs)

See ListFunctionsRequestRequestTypeDef

list_invalidations

Lists invalidation batches.

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

Method definition

def list_invalidations(
    self,
    *,
    DistributionId: str,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListInvalidationsResultTypeDef:  # (1)
    ...

See ListInvalidationsResultTypeDef

Usage example with kwargs

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

parent.list_invalidations(**kwargs)

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

Method definition

def list_key_groups(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListKeyGroupsResultTypeDef:  # (1)
    ...

See ListKeyGroupsResultTypeDef

Usage example with kwargs

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

parent.list_key_groups(**kwargs)

See ListKeyGroupsRequestRequestTypeDef

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

Method definition

def list_origin_access_controls(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListOriginAccessControlsResultTypeDef:  # (1)
    ...

See ListOriginAccessControlsResultTypeDef

Usage example with kwargs

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

parent.list_origin_access_controls(**kwargs)

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

Method definition

def list_origin_request_policies(
    self,
    *,
    Type: OriginRequestPolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListOriginRequestPoliciesResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.list_origin_request_policies(**kwargs)

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

Method definition

def list_public_keys(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListPublicKeysResultTypeDef:  # (1)
    ...

See ListPublicKeysResultTypeDef

Usage example with kwargs

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

parent.list_public_keys(**kwargs)

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

Method definition

def list_realtime_log_configs(
    self,
    *,
    MaxItems: str = ...,
    Marker: str = ...,
) -> ListRealtimeLogConfigsResultTypeDef:  # (1)
    ...

See ListRealtimeLogConfigsResultTypeDef

Usage example with kwargs

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

parent.list_realtime_log_configs(**kwargs)

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

Method definition

def list_response_headers_policies(
    self,
    *,
    Type: ResponseHeadersPolicyTypeType = ...,  # (1)
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListResponseHeadersPoliciesResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.list_response_headers_policies(**kwargs)

See ListResponseHeadersPoliciesRequestRequestTypeDef

list_streaming_distributions

List streaming distributions.

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

Method definition

def list_streaming_distributions(
    self,
    *,
    Marker: str = ...,
    MaxItems: str = ...,
) -> ListStreamingDistributionsResultTypeDef:  # (1)
    ...

See ListStreamingDistributionsResultTypeDef

Usage example with kwargs

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

parent.list_streaming_distributions(**kwargs)

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

Method definition

def list_tags_for_resource(
    self,
    *,
    Resource: str,
) -> ListTagsForResourceResultTypeDef:  # (1)
    ...

See ListTagsForResourceResultTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

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

Method definition

def publish_function(
    self,
    *,
    Name: str,
    IfMatch: str,
) -> PublishFunctionResultTypeDef:  # (1)
    ...

See PublishFunctionResultTypeDef

Usage example with kwargs

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

parent.publish_function(**kwargs)

See PublishFunctionRequestRequestTypeDef

tag_resource

Add tags to a CloudFront resource.

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

Method definition

def tag_resource(
    self,
    *,
    Resource: str,
    Tags: TagsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

See TagsTypeDef
See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.tag_resource(**kwargs)

See TagResourceRequestRequestTypeDef

test_function

Tests a CloudFront function.

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

Method definition

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

See FunctionStageType
See TestFunctionResultTypeDef

Usage example with kwargs

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

parent.test_function(**kwargs)

See TestFunctionRequestRequestTypeDef

untag_resource

Remove tags from a CloudFront resource.

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

Method definition

def untag_resource(
    self,
    *,
    Resource: str,
    TagKeys: TagKeysTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

See TagKeysTypeDef
See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.untag_resource(**kwargs)

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

Method definition

def update_cache_policy(
    self,
    *,
    CachePolicyConfig: CachePolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateCachePolicyResultTypeDef:  # (2)
    ...

See CachePolicyConfigTypeDef
See UpdateCachePolicyResultTypeDef

Usage example with kwargs

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

parent.update_cache_policy(**kwargs)

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

Method definition

def update_cloud_front_origin_access_identity(
    self,
    *,
    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateCloudFrontOriginAccessIdentityResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_cloud_front_origin_access_identity(**kwargs)

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

Method definition

def update_continuous_deployment_policy(
    self,
    *,
    ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateContinuousDeploymentPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_continuous_deployment_policy(**kwargs)

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

Method definition

def update_distribution(
    self,
    *,
    DistributionConfig: DistributionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateDistributionResultTypeDef:  # (2)
    ...

See DistributionConfigTypeDef
See UpdateDistributionResultTypeDef

Usage example with kwargs

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

parent.update_distribution(**kwargs)

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

Method definition

def update_distribution_with_staging_config(
    self,
    *,
    Id: str,
    StagingDistributionId: str = ...,
    IfMatch: str = ...,
) -> UpdateDistributionWithStagingConfigResultTypeDef:  # (1)
    ...

See UpdateDistributionWithStagingConfigResultTypeDef

Usage example with kwargs

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

parent.update_distribution_with_staging_config(**kwargs)

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

Method definition

def update_field_level_encryption_config(
    self,
    *,
    FieldLevelEncryptionConfig: FieldLevelEncryptionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateFieldLevelEncryptionConfigResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_field_level_encryption_config(**kwargs)

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

Method definition

def update_field_level_encryption_profile(
    self,
    *,
    FieldLevelEncryptionProfileConfig: FieldLevelEncryptionProfileConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateFieldLevelEncryptionProfileResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_field_level_encryption_profile(**kwargs)

See UpdateFieldLevelEncryptionProfileRequestRequestTypeDef

update_function

Updates a CloudFront function.

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

Method definition

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

See FunctionConfigTypeDef
See UpdateFunctionResultTypeDef

Usage example with kwargs

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

parent.update_function(**kwargs)

See UpdateFunctionRequestRequestTypeDef

update_key_group

Updates a key group.

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

Method definition

def update_key_group(
    self,
    *,
    KeyGroupConfig: KeyGroupConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateKeyGroupResultTypeDef:  # (2)
    ...

See KeyGroupConfigTypeDef
See UpdateKeyGroupResultTypeDef

Usage example with kwargs

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

parent.update_key_group(**kwargs)

See UpdateKeyGroupRequestRequestTypeDef

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

Method definition

def update_origin_access_control(
    self,
    *,
    OriginAccessControlConfig: OriginAccessControlConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateOriginAccessControlResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_origin_access_control(**kwargs)

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

Method definition

def update_origin_request_policy(
    self,
    *,
    OriginRequestPolicyConfig: OriginRequestPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateOriginRequestPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_origin_request_policy(**kwargs)

See UpdateOriginRequestPolicyRequestRequestTypeDef

update_public_key

Update public key information.

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

Method definition

def update_public_key(
    self,
    *,
    PublicKeyConfig: PublicKeyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdatePublicKeyResultTypeDef:  # (2)
    ...

See PublicKeyConfigTypeDef
See UpdatePublicKeyResultTypeDef

Usage example with kwargs

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

parent.update_public_key(**kwargs)

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

Method definition

def update_realtime_log_config(
    self,
    *,
    EndPoints: Sequence[EndPointTypeDef] = ...,  # (1)
    Fields: Sequence[str] = ...,
    Name: str = ...,
    ARN: str = ...,
    SamplingRate: int = ...,
) -> UpdateRealtimeLogConfigResultTypeDef:  # (2)
    ...

See EndPointTypeDef
See UpdateRealtimeLogConfigResultTypeDef

Usage example with kwargs

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

parent.update_realtime_log_config(**kwargs)

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

Method definition

def update_response_headers_policy(
    self,
    *,
    ResponseHeadersPolicyConfig: ResponseHeadersPolicyConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateResponseHeadersPolicyResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_response_headers_policy(**kwargs)

See UpdateResponseHeadersPolicyRequestRequestTypeDef

update_streaming_distribution

Update a streaming distribution.

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

Method definition

def update_streaming_distribution(
    self,
    *,
    StreamingDistributionConfig: StreamingDistributionConfigTypeDef,  # (1)
    Id: str,
    IfMatch: str = ...,
) -> UpdateStreamingDistributionResultTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.update_streaming_distribution(**kwargs)

See UpdateStreamingDistributionRequestRequestTypeDef

get_paginator

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

client.get_paginator("list_cloud_front_origin_access_identities") -> ListCloudFrontOriginAccessIdentitiesPaginator
client.get_paginator("list_distributions") -> ListDistributionsPaginator
client.get_paginator("list_invalidations") -> ListInvalidationsPaginator
client.get_paginator("list_streaming_distributions") -> ListStreamingDistributionsPaginator

get_waiter

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

client.get_waiter("distribution_deployed") -> DistributionDeployedWaiter
client.get_waiter("invalidation_completed") -> InvalidationCompletedWaiter
client.get_waiter("streaming_distribution_deployed") -> StreamingDistributionDeployedWaiter