CloudFrontClient
Amazon CloudFront
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.
Functions
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront 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 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 continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
Creates a CloudFront distribution.
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.
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 additional 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.
Deletes a cache policy.
Delete an origin access identity.
Deletes a continuous deployment policy.
Delete a distribution.
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.
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.
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 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.
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 a key group, including the date and time when the key group was last modified.
Gets a key group configuration.
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.
Gets a list of cache policies.
Lists origin access identities.
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. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Gets a list of the continuous deployment policies in your Amazon Web Services account.
List CloudFront distributions.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
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 the distributions that are associated with a specified WAF web ACL.
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.
Gets a list of key groups.
Specifies the Key Value Stores to list.
Gets the list of CloudFront origin access controls 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.
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.
Tests a CloudFront function.
Remove tags from a CloudFront resource.
Updates a cache policy configuration.
Update an origin access identity.
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.
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.
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.
Inherited functions
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront 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 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 continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
Creates a CloudFront distribution.
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.
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 additional 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.
Deletes a cache policy.
Delete an origin access identity.
Deletes a continuous deployment policy.
Delete a distribution.
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.
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.
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 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.
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 a key group, including the date and time when the key group was last modified.
Gets a key group configuration.
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.
Gets a list of cache policies.
Lists origin access identities.
Paginate over ListCloudFrontOriginAccessIdentitiesResponse results.
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. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Gets a list of the continuous deployment policies in your Amazon Web Services account.
List CloudFront distributions.
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
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 the distributions that are associated with a specified WAF web ACL.
Paginate over ListDistributionsResponse results.
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.
Paginate over ListInvalidationsResponse results.
Gets a list of key groups.
Specifies the Key Value Stores to list.
Paginate over ListKeyValueStoresResponse results.
Gets the list of CloudFront origin access controls 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.
Paginate over ListStreamingDistributionsResponse results.
List tags for a CloudFront resource.
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.
Tests a CloudFront function.
Remove tags from a CloudFront resource.
Updates a cache policy configuration.
Update an origin access identity.
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.
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.
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.
Wait until a distribution is deployed.
Wait until an invalidation has completed.
Wait until a streaming distribution is deployed.
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.