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.

Properties

Link copied to clipboard
abstract override val config: CloudFrontClient.Config

CloudFrontClient's configuration

Functions

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates a cache policy.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a CloudFront distribution.

Link copied to clipboard

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

Link copied to clipboard

Create a new field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Creates a CloudFront function.

Link copied to clipboard

Create a new invalidation.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates an origin request policy.

Link copied to clipboard

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

Link copied to clipboard

Creates a real-time log configuration.

Link copied to clipboard

Creates a response headers policy.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a cache policy.

Link copied to clipboard
Link copied to clipboard

Delete a distribution.

Link copied to clipboard

Remove a field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Deletes a CloudFront function.

Link copied to clipboard

Deletes a key group.

Link copied to clipboard

Specifies the Key Value Store to delete.

Link copied to clipboard

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Link copied to clipboard

Deletes a CloudFront origin access control.

Link copied to clipboard

Deletes an origin request policy.

Link copied to clipboard

Remove a public key you previously added to CloudFront.

Link copied to clipboard
abstract suspend fun deleteRealtimeLogConfig(input: DeleteRealtimeLogConfigRequest = DeleteRealtimeLogConfigRequest { }): DeleteRealtimeLogConfigResponse

Deletes a real-time log configuration.

Link copied to clipboard

Deletes a response headers policy.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the Key Value Store and its configuration.

Link copied to clipboard

Gets a cache policy, including the following metadata:

Link copied to clipboard

Gets a cache policy configuration.

Link copied to clipboard

Get the information about an origin access identity.

Link copied to clipboard

Get the configuration information about an origin access identity.

Link copied to clipboard

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

Link copied to clipboard

Gets configuration information about a continuous deployment policy.

Link copied to clipboard

Get the information about a distribution.

Link copied to clipboard

Get the configuration information about a distribution.

Link copied to clipboard

Get the field-level encryption configuration information.

Link copied to clipboard

Get the field-level encryption configuration information.

Link copied to clipboard

Get the field-level encryption profile information.

Link copied to clipboard

Get the field-level encryption profile configuration information.

Link copied to clipboard
abstract suspend fun getFunction(input: GetFunctionRequest): GetFunctionResponse

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

Link copied to clipboard

Get the information about an invalidation.

Link copied to clipboard
abstract suspend fun getKeyGroup(input: GetKeyGroupRequest): GetKeyGroupResponse

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

Link copied to clipboard

Gets a key group configuration.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets a CloudFront origin access control configuration.

Link copied to clipboard

Gets an origin request policy, including the following metadata:

Link copied to clipboard

Gets an origin request policy configuration.

Link copied to clipboard

Gets a public key.

Link copied to clipboard

Gets a public key configuration.

Link copied to clipboard
abstract suspend fun getRealtimeLogConfig(input: GetRealtimeLogConfigRequest = GetRealtimeLogConfigRequest { }): GetRealtimeLogConfigResponse

Gets a real-time log configuration.

Link copied to clipboard

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

Link copied to clipboard

Gets a response headers policy configuration.

Link copied to clipboard

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

Link copied to clipboard

Get the configuration information about a streaming distribution.

Link copied to clipboard
abstract suspend fun listCachePolicies(input: ListCachePoliciesRequest = ListCachePoliciesRequest { }): ListCachePoliciesResponse

Gets a list of cache policies.

Link copied to clipboard
abstract suspend fun listCloudFrontOriginAccessIdentities(input: ListCloudFrontOriginAccessIdentitiesRequest = ListCloudFrontOriginAccessIdentitiesRequest { }): ListCloudFrontOriginAccessIdentitiesResponse

Lists origin access identities.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun listContinuousDeploymentPolicies(input: ListContinuousDeploymentPoliciesRequest = ListContinuousDeploymentPoliciesRequest { }): ListContinuousDeploymentPoliciesResponse

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

Link copied to clipboard
abstract suspend fun listDistributions(input: ListDistributionsRequest = ListDistributionsRequest { }): ListDistributionsResponse

List CloudFront distributions.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listDistributionsByRealtimeLogConfig(input: ListDistributionsByRealtimeLogConfigRequest = ListDistributionsByRealtimeLogConfigRequest { }): ListDistributionsByRealtimeLogConfigResponse

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listFieldLevelEncryptionConfigs(input: ListFieldLevelEncryptionConfigsRequest = ListFieldLevelEncryptionConfigsRequest { }): ListFieldLevelEncryptionConfigsResponse

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

Link copied to clipboard
abstract suspend fun listFieldLevelEncryptionProfiles(input: ListFieldLevelEncryptionProfilesRequest = ListFieldLevelEncryptionProfilesRequest { }): ListFieldLevelEncryptionProfilesResponse

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

Link copied to clipboard
abstract suspend fun listFunctions(input: ListFunctionsRequest = ListFunctionsRequest { }): ListFunctionsResponse

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

Link copied to clipboard

Lists invalidation batches.

Link copied to clipboard
abstract suspend fun listKeyGroups(input: ListKeyGroupsRequest = ListKeyGroupsRequest { }): ListKeyGroupsResponse

Gets a list of key groups.

Link copied to clipboard
abstract suspend fun listKeyValueStores(input: ListKeyValueStoresRequest = ListKeyValueStoresRequest { }): ListKeyValueStoresResponse

Specifies the Key Value Stores to list.

Link copied to clipboard
abstract suspend fun listOriginAccessControls(input: ListOriginAccessControlsRequest = ListOriginAccessControlsRequest { }): ListOriginAccessControlsResponse

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

Link copied to clipboard
abstract suspend fun listOriginRequestPolicies(input: ListOriginRequestPoliciesRequest = ListOriginRequestPoliciesRequest { }): ListOriginRequestPoliciesResponse

Gets a list of origin request policies.

Link copied to clipboard
abstract suspend fun listPublicKeys(input: ListPublicKeysRequest = ListPublicKeysRequest { }): ListPublicKeysResponse

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

Link copied to clipboard
abstract suspend fun listRealtimeLogConfigs(input: ListRealtimeLogConfigsRequest = ListRealtimeLogConfigsRequest { }): ListRealtimeLogConfigsResponse

Gets a list of real-time log configurations.

Link copied to clipboard
abstract suspend fun listResponseHeadersPolicies(input: ListResponseHeadersPoliciesRequest = ListResponseHeadersPoliciesRequest { }): ListResponseHeadersPoliciesResponse

Gets a list of response headers policies.

Link copied to clipboard
abstract suspend fun listStreamingDistributions(input: ListStreamingDistributionsRequest = ListStreamingDistributionsRequest { }): ListStreamingDistributionsResponse

List streaming distributions.

Link copied to clipboard

List tags for a CloudFront resource.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add tags to a CloudFront resource.

Link copied to clipboard

Tests a CloudFront function.

Link copied to clipboard

Remove tags from a CloudFront resource.

Link copied to clipboard

Updates a cache policy configuration.

Link copied to clipboard

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.

Link copied to clipboard

Updates the configuration for a CloudFront distribution.

Link copied to clipboard

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.

Link copied to clipboard

Update a field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Updates a CloudFront function.

Link copied to clipboard

Updates a key group.

Link copied to clipboard

Specifies the Key Value Store to update.

Link copied to clipboard

Updates a CloudFront origin access control.

Link copied to clipboard

Updates an origin request policy configuration.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun updateRealtimeLogConfig(input: UpdateRealtimeLogConfigRequest = UpdateRealtimeLogConfigRequest { }): UpdateRealtimeLogConfigResponse

Updates a real-time log configuration.

Link copied to clipboard

Updates a response headers policy.

Link copied to clipboard

Update a streaming distribution.

Inherited functions

Link copied to clipboard

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

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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.

Link copied to clipboard

Creates a cache policy.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a CloudFront distribution.

Link copied to clipboard

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

Link copied to clipboard

Create a new field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Creates a CloudFront function.

Link copied to clipboard

Create a new invalidation.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates an origin request policy.

Link copied to clipboard

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

Link copied to clipboard

Creates a real-time log configuration.

Link copied to clipboard

Creates a response headers policy.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a cache policy.

Link copied to clipboard
Link copied to clipboard

Delete a distribution.

Link copied to clipboard

Remove a field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Deletes a CloudFront function.

Link copied to clipboard

Deletes a key group.

Link copied to clipboard

Specifies the Key Value Store to delete.

Link copied to clipboard

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Link copied to clipboard

Deletes a CloudFront origin access control.

Link copied to clipboard

Deletes an origin request policy.

Link copied to clipboard

Remove a public key you previously added to CloudFront.

Link copied to clipboard

Deletes a real-time log configuration.

Link copied to clipboard

Deletes a response headers policy.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the Key Value Store and its configuration.

Link copied to clipboard

Gets a cache policy, including the following metadata:

Link copied to clipboard

Gets a cache policy configuration.

Link copied to clipboard

Get the information about an origin access identity.

Link copied to clipboard

Get the configuration information about an origin access identity.

Link copied to clipboard

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

Link copied to clipboard

Gets configuration information about a continuous deployment policy.

Link copied to clipboard

Get the information about a distribution.

Link copied to clipboard

Get the configuration information about a distribution.

Link copied to clipboard

Get the field-level encryption configuration information.

Link copied to clipboard

Get the field-level encryption configuration information.

Link copied to clipboard

Get the field-level encryption profile information.

Link copied to clipboard

Get the field-level encryption profile configuration information.

Link copied to clipboard

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

Link copied to clipboard

Get the information about an invalidation.

Link copied to clipboard

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

Link copied to clipboard

Gets a key group configuration.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets a CloudFront origin access control configuration.

Link copied to clipboard

Gets an origin request policy, including the following metadata:

Link copied to clipboard

Gets an origin request policy configuration.

Link copied to clipboard

Gets a public key.

Link copied to clipboard

Gets a public key configuration.

Link copied to clipboard

Gets a real-time log configuration.

Link copied to clipboard

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

Link copied to clipboard

Gets a response headers policy configuration.

Link copied to clipboard

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

Link copied to clipboard

Get the configuration information about a streaming distribution.

Link copied to clipboard

Gets a list of cache policies.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

List CloudFront distributions.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists invalidation batches.

Link copied to clipboard

Gets a list of key groups.

Link copied to clipboard

Specifies the Key Value Stores to list.

Link copied to clipboard

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

Link copied to clipboard

Gets a list of origin request policies.

Link copied to clipboard

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

Link copied to clipboard

Gets a list of real-time log configurations.

Link copied to clipboard

Gets a list of response headers policies.

Link copied to clipboard
Link copied to clipboard

List tags for a CloudFront resource.

Link copied to clipboard

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.

Link copied to clipboard

Add tags to a CloudFront resource.

Link copied to clipboard

Tests a CloudFront function.

Link copied to clipboard

Remove tags from a CloudFront resource.

Link copied to clipboard

Updates a cache policy configuration.

Link copied to clipboard

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.

Link copied to clipboard

Updates the configuration for a CloudFront distribution.

Link copied to clipboard

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.

Link copied to clipboard

Update a field-level encryption configuration.

Link copied to clipboard
Link copied to clipboard

Updates a CloudFront function.

Link copied to clipboard

Updates a key group.

Link copied to clipboard

Specifies the Key Value Store to update.

Link copied to clipboard

Updates a CloudFront origin access control.

Link copied to clipboard

Updates an origin request policy configuration.

Link copied to clipboard

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

Link copied to clipboard

Updates a real-time log configuration.

Link copied to clipboard

Updates a response headers policy.

Link copied to clipboard
Link copied to clipboard

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.