AWS.CloudFront (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

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

Creates a new web distribution.

Create a new field-level encryption configuration.

Creates a CloudFront function.

Enables additional CloudWatch metrics for the specified CloudFront distribution.

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.

Remove a field-level encryption configuration.

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Remove a public key you previously added to CloudFront.

Deletes a real-time log configuration.

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

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.

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.

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 an origin request policy, including the following metadata

Gets an origin request policy configuration.

Gets a public key configuration.

Gets a real-time log configuration.

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

Get the configuration information about a streaming distribution.

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.

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.

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 account.

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

List tags for a CloudFront resource.

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

Add tags to a CloudFront resource.

Remove tags from a CloudFront resource.

Updates a cache policy configuration.

Updates the configuration for a web distribution.

Update a field-level encryption configuration.

Updates an origin request policy configuration.

Updates a real-time log configuration.

Link to this section Functions

Link to this function

associate_alias(client, target_distribution_id, input, options \\ [])

View Source

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

With this operation you can move an alias that’s already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.

To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

Link to this function

create_cache_policy(client, input, options \\ [])

View Source

Creates a cache policy.

After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following:

  • The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.

  • The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy.

For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.

Link to this function

create_cloud_front_origin_access_identity(client, input, options \\ [])

View Source

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 to this function

create_distribution(client, input, options \\ [])

View Source

Creates a new web distribution.

You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /*CloudFront API version*/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

Link to this function

create_distribution_with_tags(client, input, options \\ [])

View Source

Create a new distribution with tags.

Link to this function

create_field_level_encryption_config(client, input, options \\ [])

View Source

Create a new field-level encryption configuration.

Link to this function

create_field_level_encryption_profile(client, input, options \\ [])

View Source

Create a field-level encryption profile.

Link to this function

create_function(client, input, options \\ [])

View Source

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.

When you create a function, it’s in the DEVELOPMENT stage. In this stage, you can test the function with TestFunction, and update it with UpdateFunction.

When you’re ready to use your function with a CloudFront distribution, use PublishFunction to copy the function from the DEVELOPMENT stage to LIVE. When it’s live, you can attach the function to a distribution’s cache behavior, using the function’s ARN.

Link to this function

create_invalidation(client, distribution_id, input, options \\ [])

View Source

Create a new invalidation.

Link to this function

create_key_group(client, input, options \\ [])

View Source

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

To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.

Link to this function

create_monitoring_subscription(client, distribution_id, input, options \\ [])

View Source

Enables additional CloudWatch metrics for the specified CloudFront distribution.

The additional metrics incur an additional cost.

For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.

Link to this function

create_origin_request_policy(client, input, options \\ [])

View Source

Creates an origin request policy.

After you create an origin request policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:

  • The request body and the URL path (without the domain name) from the viewer request.

  • The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.

  • All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.

CloudFront sends a request when it can’t find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.

For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.

Link to this function

create_public_key(client, input, options \\ [])

View Source

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

Link to this function

create_realtime_log_config(client, input, options \\ [])

View Source

Creates a real-time log configuration.

After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.

For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.

Link to this function

create_streaming_distribution(client, input, options \\ [])

View Source

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 to this function

create_streaming_distribution_with_tags(client, input, options \\ [])

View Source

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 to this function

delete_cache_policy(client, id, input, options \\ [])

View Source

Deletes a cache policy.

You cannot delete a cache policy if it’s attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.

To delete a cache policy, you must provide the policy’s identifier and version. To get these values, you can use ListCachePolicies or GetCachePolicy.

Link to this function

delete_cloud_front_origin_access_identity(client, id, input, options \\ [])

View Source

Delete an origin access identity.

Link to this function

delete_distribution(client, id, input, options \\ [])

View Source

Delete a distribution.

Link to this function

delete_field_level_encryption_config(client, id, input, options \\ [])

View Source

Remove a field-level encryption configuration.

Link to this function

delete_field_level_encryption_profile(client, id, input, options \\ [])

View Source

Remove a field-level encryption profile.

Link to this function

delete_function(client, name, input, options \\ [])

View Source

Deletes a CloudFront function.

You cannot delete a function if it’s associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.

To delete a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction.

Link to this function

delete_key_group(client, id, input, options \\ [])

View Source

Deletes a key group.

You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.

To delete a key group, you must provide the key group’s identifier and version. To get these values, use ListKeyGroups followed by GetKeyGroup or GetKeyGroupConfig.

Link to this function

delete_monitoring_subscription(client, distribution_id, input, options \\ [])

View Source

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Link to this function

delete_origin_request_policy(client, id, input, options \\ [])

View Source

Deletes an origin request policy.

You cannot delete an origin request policy if it’s attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.

To delete an origin request policy, you must provide the policy’s identifier and version. To get the identifier, you can use ListOriginRequestPolicies or GetOriginRequestPolicy.

Link to this function

delete_public_key(client, id, input, options \\ [])

View Source

Remove a public key you previously added to CloudFront.

Link to this function

delete_realtime_log_config(client, input, options \\ [])

View Source

Deletes a real-time log configuration.

You cannot delete a real-time log configuration if it’s attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.

To delete a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.

Link to this function

delete_streaming_distribution(client, id, input, options \\ [])

View Source

Delete a streaming distribution.

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

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

Link to this function

describe_function(client, name, stage \\ nil, options \\ [])

View Source

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

To get a function’s code, use GetFunction.

To get configuration information and metadata about a function, you must provide the function’s name and stage. To get these values, you can use ListFunctions.

Link to this function

get_cache_policy(client, id, options \\ [])

View Source

Gets a cache policy, including the following metadata:

  • The policy’s identifier.

  • The date and time when the policy was last modified.

To get a cache policy, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

Link to this function

get_cache_policy_config(client, id, options \\ [])

View Source

Gets a cache policy configuration.

To get a cache policy configuration, you must provide the policy’s identifier. If the cache policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the cache policy is not attached to a cache behavior, you can get the identifier using ListCachePolicies.

Link to this function

get_cloud_front_origin_access_identity(client, id, options \\ [])

View Source

Get the information about an origin access identity.

Link to this function

get_cloud_front_origin_access_identity_config(client, id, options \\ [])

View Source

Get the configuration information about an origin access identity.

Link to this function

get_distribution(client, id, options \\ [])

View Source

Get the information about a distribution.

Link to this function

get_distribution_config(client, id, options \\ [])

View Source

Get the configuration information about a distribution.

Link to this function

get_field_level_encryption(client, id, options \\ [])

View Source

Get the field-level encryption configuration information.

Link to this function

get_field_level_encryption_config(client, id, options \\ [])

View Source

Get the field-level encryption configuration information.

Link to this function

get_field_level_encryption_profile(client, id, options \\ [])

View Source

Get the field-level encryption profile information.

Link to this function

get_field_level_encryption_profile_config(client, id, options \\ [])

View Source

Get the field-level encryption profile configuration information.

Link to this function

get_function(client, name, stage \\ nil, options \\ [])

View Source

Gets the code of a CloudFront function.

To get configuration information and metadata about a function, use DescribeFunction.

To get a function’s code, you must provide the function’s name and stage. To get these values, you can use ListFunctions.

Link to this function

get_invalidation(client, distribution_id, id, options \\ [])

View Source

Get the information about an invalidation.

Link to this function

get_key_group(client, id, options \\ [])

View Source

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

To get a key group, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.

Link to this function

get_key_group_config(client, id, options \\ [])

View Source

Gets a key group configuration.

To get a key group configuration, you must provide the key group’s identifier. If the key group is referenced in a distribution’s cache behavior, you can get the key group’s identifier using ListDistributions or GetDistribution. If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups.

Link to this function

get_monitoring_subscription(client, distribution_id, options \\ [])

View Source

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

Link to this function

get_origin_request_policy(client, id, options \\ [])

View Source

Gets an origin request policy, including the following metadata:

  • The policy’s identifier.

  • The date and time when the policy was last modified.

To get an origin request policy, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.

Link to this function

get_origin_request_policy_config(client, id, options \\ [])

View Source

Gets an origin request policy configuration.

To get an origin request policy configuration, you must provide the policy’s identifier. If the origin request policy is attached to a distribution’s cache behavior, you can get the policy’s identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.

Link to this function

get_public_key(client, id, options \\ [])

View Source

Gets a public key.

Link to this function

get_public_key_config(client, id, options \\ [])

View Source

Gets a public key configuration.

Link to this function

get_realtime_log_config(client, input, options \\ [])

View Source

Gets a real-time log configuration.

To get a real-time log configuration, you can provide the configuration’s name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.

Link to this function

get_streaming_distribution(client, id, options \\ [])

View Source

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

Link to this function

get_streaming_distribution_config(client, id, options \\ [])

View Source

Get the configuration information about a streaming distribution.

Link to this function

list_cache_policies(client, marker \\ nil, max_items \\ nil, type \\ nil, options \\ [])

View Source

Gets a list of cache policies.

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_cloud_front_origin_access_identities(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

Lists origin access identities.

Link to this function

list_conflicting_aliases(client, alias, distribution_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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.

Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name (*.example.com), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com, test.example.com, dev.example.com, and so on), if they exist.

To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_distributions(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

List CloudFront distributions.

Link to this function

list_distributions_by_cache_policy_id(client, cache_policy_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_distributions_by_key_group(client, key_group_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_distributions_by_origin_request_policy_id(client, origin_request_policy_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_distributions_by_realtime_log_config(client, input, options \\ [])

View Source

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

You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_distributions_by_web_acl_id(client, web_acl_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

Link to this function

list_field_level_encryption_configs(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

Link to this function

list_field_level_encryption_profiles(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

Link to this function

list_functions(client, marker \\ nil, max_items \\ nil, stage \\ nil, options \\ [])

View Source

Gets a list of all CloudFront functions in your account.

You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_invalidations(client, distribution_id, marker \\ nil, max_items \\ nil, options \\ [])

View Source

Lists invalidation batches.

Link to this function

list_key_groups(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

Gets a list of key groups.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_origin_request_policies(client, marker \\ nil, max_items \\ nil, type \\ nil, options \\ [])

View Source

Gets a list of origin request policies.

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your account.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_public_keys(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

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

Link to this function

list_realtime_log_configs(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

Gets a list of real-time log configurations.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Link to this function

list_streaming_distributions(client, marker \\ nil, max_items \\ nil, options \\ [])

View Source

List streaming distributions.

Link to this function

list_tags_for_resource(client, resource, options \\ [])

View Source

List tags for a CloudFront resource.

Link to this function

publish_function(client, name, input, options \\ [])

View Source

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.

When a function is published to the LIVE stage, you can attach the function to a distribution’s cache behavior, using the function’s Amazon Resource Name (ARN).

To publish a function, you must provide the function’s name and version (ETag value). To get these values, you can use ListFunctions and DescribeFunction.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Add tags to a CloudFront resource.

Link to this function

test_function(client, name, input, options \\ [])

View Source

Tests a CloudFront function.

To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function’s result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.

To test a function, you provide the function’s name and version (ETag value) along with the event object. To get the function’s name and version, you can use ListFunctions and DescribeFunction.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Remove tags from a CloudFront resource.

Link to this function

update_cache_policy(client, id, input, options \\ [])

View Source

Updates a cache policy configuration.

When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:

  1. Use GetCachePolicyConfig to get the current configuration.

  2. Locally modify the fields in the cache policy configuration that you want to update.

  3. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.

Link to this function

update_cloud_front_origin_access_identity(client, id, input, options \\ [])

View Source

Update an origin access identity.

Link to this function

update_distribution(client, id, input, options \\ [])

View Source

Updates the configuration for a web distribution.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

If you update the distribution again, you must get a new Etag header.

  1. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

When you edit the XML file, be aware of the following:

You must strip out the ETag parameter that is returned.

Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  1. Submit an UpdateDistribution request to update the configuration for your distribution:
* In the request body, include the XML document that you

updated in Step 2. The request body must include an XML document with a DistributionConfig element.

* Set the value of the HTTP `If-Match` header to the

value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  1. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  2. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

Link to this function

update_field_level_encryption_config(client, id, input, options \\ [])

View Source

Update a field-level encryption configuration.

Link to this function

update_field_level_encryption_profile(client, id, input, options \\ [])

View Source

Update a field-level encryption profile.

Link to this function

update_function(client, name, input, options \\ [])

View Source

Updates a CloudFront function.

You can update a function’s code or the comment that describes the function. You cannot update a function’s name.

To update a function, you provide the function’s name and version (ETag value) along with the updated function code. To get the name and version, you can use ListFunctions and DescribeFunction.

Link to this function

update_key_group(client, id, input, options \\ [])

View Source

Updates a key group.

When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:

  1. Get the current key group with GetKeyGroup or GetKeyGroupConfig.

  2. Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.

  3. Call UpdateKeyGroup with the entire key group object, including the fields that you modified and those that you didn’t.

Link to this function

update_origin_request_policy(client, id, input, options \\ [])

View Source

Updates an origin request policy configuration.

When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:

  1. Use GetOriginRequestPolicyConfig to get the current configuration.

  2. Locally modify the fields in the origin request policy configuration that you want to update.

  3. Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.

Link to this function

update_public_key(client, id, input, options \\ [])

View Source

Update public key information.

Note that the only value you can change is the comment.

Link to this function

update_realtime_log_config(client, input, options \\ [])

View Source

Updates a real-time log configuration.

When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:

  1. Call GetRealtimeLogConfig to get the current real-time log configuration.

  2. Locally modify the parameters in the real-time log configuration that you want to update.

  3. Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.

You cannot update a real-time log configuration’s Name or ARN.

Link to this function

update_streaming_distribution(client, id, input, options \\ [])

View Source

Update a streaming distribution.