View Source AWS.CloudFront (aws-elixir v1.0.4)
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 staging distribution using the configuration of the provided primary distribution.
Creates an Anycast static IP list.
Creates a cache policy.
Creates a new origin access identity.
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.
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.
Enables additional CloudWatch metrics for the specified CloudFront distribution.
Creates a new origin access control in CloudFront.
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.
This API is deprecated.
Create an Amazon CloudFront VPC origin.
Deletes an Anycast static IP list.
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.
Delete an Amazon CloudFront VPC origin.
Gets configuration information and metadata about a CloudFront function, but not the function's code.
Specifies the key value store and its configuration.
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 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.
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.
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.
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 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.
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.
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 (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.
List the CloudFront VPC origins in your account.
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT stage to LIVE.
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.
Updates the configuration for a CloudFront distribution.
Copies the staging distribution's configuration to its corresponding primary 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.
Updates a real-time log configuration.
Updates a response headers policy.
Update a streaming distribution.
Update an Amazon CloudFront VPC origin in your account.
Link to this section Functions
associate_alias(client, target_distribution_id, input, options \\ [])
View SourceAssociates 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.
copy_distribution(client, primary_distribution_id, input, options \\ [])
View SourceCreates 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.
After you create a staging distribution, you can use UpdateDistribution
to modify the staging distribution's configuration. Then you can use
CreateContinuousDeploymentPolicy to incrementally move traffic to the
staging distribution.
This API operation requires the following IAM permissions:
*
*
*
Creates an Anycast static IP list.
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
also 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.
create_cloud_front_origin_access_identity(client, input, options \\ [])
View SourceCreates 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.
To use a continuous deployment policy, first use CopyDistribution to
create a staging distribution, then use UpdateDistribution to modify the
staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
Creates a CloudFront distribution.
Create a new distribution with tags.
This API operation requires the following IAM permissions:
*
*
create_field_level_encryption_config(client, input, options \\ [])
View SourceCreate a new field-level encryption configuration.
create_field_level_encryption_profile(client, input, options \\ [])
View SourceCreate a field-level encryption profile.
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.
create_invalidation(client, distribution_id, input, options \\ [])
View SourceCreate a new invalidation.
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.
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.
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.
create_monitoring_subscription(client, distribution_id, input, options \\ [])
View SourceEnables 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.
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.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
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.
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.
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.
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
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_streaming_distribution_with_tags(client, input, options \\ [])
View SourceThis 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.
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.
delete_cloud_front_origin_access_identity(client, id, input, options \\ [])
View SourceDelete an origin access identity.
delete_continuous_deployment_policy(client, id, input, options \\ [])
View SourceDeletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
Delete a distribution.
delete_field_level_encryption_config(client, id, input, options \\ [])
View SourceRemove a field-level encryption configuration.
delete_field_level_encryption_profile(client, id, input, options \\ [])
View SourceRemove a field-level encryption profile.
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.
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.
Specifies the key value store to delete.
delete_monitoring_subscription(client, distribution_id, input, options \\ [])
View SourceDisables additional CloudWatch metrics for the specified CloudFront distribution.
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
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.
Remove a public key you previously added to CloudFront.
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.
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's identifier
and
version. To get these values, you can use ListResponseHeadersPolicies or
GetResponseHeadersPolicy.
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 Configrequest 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
Configrequest 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 Configrequest 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.
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.
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.
Specifies the key value store and its configuration.
Gets an Anycast static IP list.
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.
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.
Get the information about an origin access identity.
get_cloud_front_origin_access_identity_config(client, id, options \\ [])
View SourceGet 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).
get_continuous_deployment_policy_config(client, id, options \\ [])
View SourceGets 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_field_level_encryption_profile_config(client, id, options \\ [])
View SourceGet 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.
To get a function's code, you must provide the function's name and stage. To get
these
values, you can use ListFunctions.
Get the information about an invalidation.
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.
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.
get_monitoring_subscription(client, distribution_id, options \\ [])
View SourceGets 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:
* 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.
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.
Gets a public key.
Gets a public key configuration.
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.
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's identifier. If
the
response headers policy is attached to a distribution's cache behavior, you can
get the
policy's identifier using ListDistributions or
GetDistribution. If the response headers policy is not attached to a cache
behavior, you can get the identifier using
ListResponseHeadersPolicies.
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the policy's
identifier. If the response headers policy is attached to a distribution's cache
behavior, you can get the policy's identifier using ListDistributions or
GetDistribution. If the response headers policy is not attached to a
cache behavior, you can get the identifier using
ListResponseHeadersPolicies.
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.
list_anycast_ip_lists(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceLists your Anycast static IP lists.
list_cache_policies(client, marker \\ nil, max_items \\ nil, type \\ nil, options \\ [])
View SourceGets 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 Amazon Web Services 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.
list_cloud_front_origin_access_identities(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceLists origin access identities.
list_conflicting_aliases(client, alias, distribution_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_continuous_deployment_policies(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets a list of the continuous deployment policies in your Amazon Web Services 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.
list_distributions(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList CloudFront distributions.
list_distributions_by_anycast_ip_list_id(client, anycast_ip_list_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceLists the distributions in your account that are associated with the specified
AnycastIpListId.
list_distributions_by_cache_policy_id(client, cache_policy_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_distributions_by_key_group(client, key_group_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_distributions_by_origin_request_policy_id(client, origin_request_policy_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_distributions_by_realtime_log_config(client, input, options \\ [])
View SourceGets 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.
list_distributions_by_response_headers_policy_id(client, response_headers_policy_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers 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.
list_distributions_by_vpc_origin_id(client, vpc_origin_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList CloudFront distributions by their VPC origin ID.
list_distributions_by_web_acl_id(client, web_acl_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList the distributions that are associated with a specified WAF web ACL.
list_field_level_encryption_configs(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList all field-level encryption configurations that have been created in CloudFront for this account.
list_field_level_encryption_profiles(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceRequest a list of field-level encryption profiles that have been created in CloudFront for this account.
list_functions(client, marker \\ nil, max_items \\ nil, stage \\ nil, options \\ [])
View SourceGets a list of all CloudFront functions in your Amazon Web Services 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.
list_invalidations(client, distribution_id, marker \\ nil, max_items \\ nil, options \\ [])
View SourceLists invalidation batches.
list_key_groups(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_key_value_stores(client, marker \\ nil, max_items \\ nil, status \\ nil, options \\ [])
View SourceSpecifies the key value stores to list.
list_origin_access_controls(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets the list of CloudFront origin access controls (OACs) in this Amazon Web Services 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
another
request that specifies the NextMarker value from the current response as
the Marker value in the next request.
If you're not using origin access controls for your Amazon Web Services account,
the
ListOriginAccessControls operation doesn't return the
Items element in the response.
list_origin_request_policies(client, marker \\ nil, max_items \\ nil, type \\ nil, options \\ [])
View SourceGets 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 Amazon Web Services 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.
list_public_keys(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList all public keys that have been added to CloudFront for this account.
list_realtime_log_configs(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceGets 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.
list_response_headers_policies(client, marker \\ nil, max_items \\ nil, type \\ nil, options \\ [])
View SourceGets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services 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.
list_streaming_distributions(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList streaming distributions.
List tags for a CloudFront resource.
For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
list_vpc_origins(client, marker \\ nil, max_items \\ nil, options \\ [])
View SourceList 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.
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.
Add tags to a CloudFront resource.
For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
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.
Remove tags from a CloudFront resource.
For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
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.
update_cloud_front_origin_access_identity(client, id, input, options \\ [])
View SourceUpdate an origin access identity.
update_continuous_deployment_policy(client, id, input, options \\ [])
View SourceUpdates 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.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
1.
Use GetContinuousDeploymentPolicyConfig to get the current
configuration.
2. Locally modify the fields in the continuous deployment policy configuration that you want to update.
3.
Use UpdateContinuousDeploymentPolicy, providing the entire
continuous deployment policy configuration, including the fields that you
modified and those that you didn't.
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution configuration,
updating
it to make your changes, and then submitting an UpdateDistribution request
to make the updates.
to-update-a-web-distribution-using-the-cloudfront
To update a web distribution using the CloudFront
API
1.
Use GetDistributionConfig to get the current configuration,
including the version identifier (ETag).
2. Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
*You must copy the ETag field value from the response. (You'll use it for the
IfMatch parameter in your request.) Then, remove the ETag
field from the distribution configuration.
*You can't change the value of CallerReference.
3.
Submit an UpdateDistribution request, providing the updated distribution
configuration. The new configuration replaces the existing configuration. The
values that you specify in an UpdateDistribution request are not
merged into your existing configuration. Make sure to include all fields: the
ones that you modified and also the ones that you didn't.
update_distribution_with_staging_config(client, id, input, options \\ [])
View SourceCopies 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.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
*
*
update_field_level_encryption_config(client, id, input, options \\ [])
View SourceUpdate a field-level encryption configuration.
update_field_level_encryption_profile(client, id, input, options \\ [])
View SourceUpdate a field-level encryption profile.
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.
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.
Specifies the key value store to update.
Updates a CloudFront origin access control.
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.
Update public key information.
Note that the only value you can change is the comment.
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.
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
1.
Use GetResponseHeadersPolicyConfig to get the current policy's
configuration.
2. Modify the fields in the response headers policy configuration that you want to update.
3.
Call UpdateResponseHeadersPolicy, providing the entire response
headers policy configuration, including the fields that you modified and those
that you didn't.
Update a streaming distribution.
Update an Amazon CloudFront VPC origin in your account.