Package-level declarations

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

The AssociateAlias API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead.

Associates the WAF web ACL with a distribution tenant.

Associates the WAF web ACL with a distribution.

Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.

Creates an Anycast static IP list.

Creates a cache policy.

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

Creates a connection group.

Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.

Creates a CloudFront distribution.

Creates a distribution tenant.

Create a new distribution with tags. This API operation requires the following IAM permissions:

Create a new field-level encryption configuration.

Create a field-level encryption profile.

Creates a CloudFront function.

Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.

Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.

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

Specifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.

Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.

Creates an origin request policy.

Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.

Creates a real-time log configuration.

Creates a response headers policy.

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.

Create an Amazon CloudFront VPC origin.

Deletes an Anycast static IP list.

Deletes a cache policy.

Delete an origin access identity.

Deletes a connection group.

Deletes a continuous deployment policy.

Delete a distribution.

Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.

Remove a field-level encryption configuration.

Remove a field-level encryption profile.

Deletes a CloudFront function.

Deletes a key group.

Specifies the key value store to delete.

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Deletes a CloudFront origin access control.

Deletes an origin request policy.

Remove a public key you previously added to CloudFront.

Deletes a real-time log configuration.

Deletes a response headers policy.

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

Delete an Amazon CloudFront VPC origin.

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

Specifies the key value store and its configuration.

Disassociates a distribution tenant from the WAF web ACL.

Disassociates a distribution from the WAF web ACL.

Gets an Anycast static IP list.

Gets a cache policy, including the following metadata:

Gets a cache policy configuration.

Get the information about an origin access identity.

Get the configuration information about an origin access identity.

Gets information about a connection group.

Gets information about a connection group by using the endpoint that you specify.

Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).

Gets configuration information about a continuous deployment policy.

Get the information about a distribution.

Get the configuration information about a distribution.

Gets information about a distribution tenant.

Gets information about a distribution tenant by the associated domain.

Get the field-level encryption configuration information.

Get the field-level encryption configuration information.

Get the field-level encryption profile information.

Get the field-level encryption profile configuration information.

Gets the code of a CloudFront function. To get configuration information and metadata about a function, use DescribeFunction.

Get the information about an invalidation.

Gets information about a specific invalidation for a distribution tenant.

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

Gets a key group configuration.

Gets details about the CloudFront managed ACM certificate.

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

Gets a CloudFront origin access control, including its unique identifier.

Gets a CloudFront origin access control configuration.

Gets an origin request policy, including the following metadata:

Gets an origin request policy configuration.

Gets a public key.

Gets a public key configuration.

Gets a real-time log configuration.

Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).

Gets a response headers policy configuration.

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

Get the configuration information about a streaming distribution.

Get the details of an Amazon CloudFront VPC origin.

Lists your Anycast static IP lists.

Gets a list of cache policies.

Lists origin access identities.

The ListConflictingAliases API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead.

Lists the connection groups in your Amazon Web Services account.

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

List CloudFront distributions.

Lists the distributions in your account that are associated with the specified AnycastIpListId.

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

Lists the distributions by the connection mode that you specify.

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

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

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

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

List CloudFront distributions by their VPC origin ID.

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

Lists the distribution tenants in your Amazon Web Services account.

Lists distribution tenants by the customization that you specify.

We recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions.

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

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

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

Lists invalidation batches.

Lists the invalidations for a distribution tenant.

Gets a list of key groups.

Specifies the key value stores to list.

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

Gets a list of origin request policies.

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

Gets a list of real-time log configurations.

Gets a list of response headers policies.

List streaming distributions.

List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.

List the CloudFront VPC origins in your account.

Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE. This automatically updates all cache behaviors that are using this function to use the newly published copy in the LIVE stage.

Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.

Tests a CloudFront function.

Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.

Updates a cache policy configuration.

Update an origin access identity.

Updates a connection group.

Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.

Updates the configuration for a CloudFront distribution.

Updates a distribution tenant.

Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases (also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution.

We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions.

Update a field-level encryption configuration.

Update a field-level encryption profile.

Updates a CloudFront function.

Updates a key group.

Specifies the key value store to update.

Updates a CloudFront origin access control.

Updates an origin request policy configuration.

Update public key information. Note that the only value you can change is the comment.

Updates a real-time log configuration.

Updates a response headers policy.

Update a streaming distribution.

Update an Amazon CloudFront VPC origin in your account.

Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.