aws_cloudfront
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.Summary
Functions
-
create_cache_policy(Client, Input)
Creates a cache policy.
- create_cache_policy(Client, Input0, Options0)
-
create_cloud_front_origin_access_identity(Client, Input)
Creates a new origin access identity.
- create_cloud_front_origin_access_identity(Client, Input0, Options0)
-
create_distribution(Client, Input)
Creates a new web distribution.
- create_distribution(Client, Input0, Options0)
-
create_distribution_with_tags(Client, Input)
Create a new distribution with tags.
- create_distribution_with_tags(Client, Input0, Options0)
-
create_field_level_encryption_config(Client, Input)
Create a new field-level encryption configuration.
- create_field_level_encryption_config(Client, Input0, Options0)
-
create_field_level_encryption_profile(Client, Input)
Create a field-level encryption profile.
- create_field_level_encryption_profile(Client, Input0, Options0)
-
create_invalidation(Client, DistributionId, Input)
Create a new invalidation.
- create_invalidation(Client, DistributionId, Input0, Options0)
-
create_key_group(Client, Input)
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
- create_key_group(Client, Input0, Options0)
-
create_monitoring_subscription(Client, DistributionId, Input)
Enables additional CloudWatch metrics for the specified CloudFront distribution.
- create_monitoring_subscription(Client, DistributionId, Input0, Options0)
-
create_origin_request_policy(Client, Input)
Creates an origin request policy.
- create_origin_request_policy(Client, Input0, Options0)
-
create_public_key(Client, Input)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
- create_public_key(Client, Input0, Options0)
-
create_realtime_log_config(Client, Input)
Creates a real-time log configuration.
- create_realtime_log_config(Client, Input0, Options0)
-
create_streaming_distribution(Client, Input)
This API is deprecated.
- create_streaming_distribution(Client, Input0, Options0)
-
create_streaming_distribution_with_tags(Client, Input)
This API is deprecated.
- create_streaming_distribution_with_tags(Client, Input0, Options0)
-
delete_cache_policy(Client, Id, Input)
Deletes a cache policy.
- delete_cache_policy(Client, Id, Input0, Options0)
-
delete_cloud_front_origin_access_identity(Client, Id, Input)
Delete an origin access identity.
- delete_cloud_front_origin_access_identity(Client, Id, Input0, Options0)
-
delete_distribution(Client, Id, Input)
Delete a distribution.
- delete_distribution(Client, Id, Input0, Options0)
-
delete_field_level_encryption_config(Client, Id, Input)
Remove a field-level encryption configuration.
- delete_field_level_encryption_config(Client, Id, Input0, Options0)
-
delete_field_level_encryption_profile(Client, Id, Input)
Remove a field-level encryption profile.
- delete_field_level_encryption_profile(Client, Id, Input0, Options0)
-
delete_key_group(Client, Id, Input)
Deletes a key group.
- delete_key_group(Client, Id, Input0, Options0)
-
delete_monitoring_subscription(Client, DistributionId, Input)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
- delete_monitoring_subscription(Client, DistributionId, Input0, Options0)
-
delete_origin_request_policy(Client, Id, Input)
Deletes an origin request policy.
- delete_origin_request_policy(Client, Id, Input0, Options0)
-
delete_public_key(Client, Id, Input)
Remove a public key you previously added to CloudFront.
- delete_public_key(Client, Id, Input0, Options0)
-
delete_realtime_log_config(Client, Input)
Deletes a real-time log configuration.
- delete_realtime_log_config(Client, Input0, Options0)
-
delete_streaming_distribution(Client, Id, Input)
Delete a streaming distribution.
- delete_streaming_distribution(Client, Id, Input0, Options0)
-
get_cache_policy(Client, Id)
Gets a cache policy, including the following metadata:.
- get_cache_policy(Client, Id, QueryMap, HeadersMap)
- get_cache_policy(Client, Id, QueryMap, HeadersMap, Options0)
-
get_cache_policy_config(Client, Id)
Gets a cache policy configuration.
- get_cache_policy_config(Client, Id, QueryMap, HeadersMap)
- get_cache_policy_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_cloud_front_origin_access_identity(Client, Id)
Get the information about an origin access identity.
- get_cloud_front_origin_access_identity(Client, Id, QueryMap, HeadersMap)
- get_cloud_front_origin_access_identity(Client, Id, QueryMap, HeadersMap, Options0)
-
get_cloud_front_origin_access_identity_config(Client, Id)
Get the configuration information about an origin access identity.
- get_cloud_front_origin_access_identity_config(Client, Id, QueryMap, HeadersMap)
- get_cloud_front_origin_access_identity_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_distribution(Client, Id)
Get the information about a distribution.
- get_distribution(Client, Id, QueryMap, HeadersMap)
- get_distribution(Client, Id, QueryMap, HeadersMap, Options0)
-
get_distribution_config(Client, Id)
Get the configuration information about a distribution.
- get_distribution_config(Client, Id, QueryMap, HeadersMap)
- get_distribution_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_field_level_encryption(Client, Id)
Get the field-level encryption configuration information.
- get_field_level_encryption(Client, Id, QueryMap, HeadersMap)
- get_field_level_encryption(Client, Id, QueryMap, HeadersMap, Options0)
-
get_field_level_encryption_config(Client, Id)
Get the field-level encryption configuration information.
- get_field_level_encryption_config(Client, Id, QueryMap, HeadersMap)
- get_field_level_encryption_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_field_level_encryption_profile(Client, Id)
Get the field-level encryption profile information.
- get_field_level_encryption_profile(Client, Id, QueryMap, HeadersMap)
- get_field_level_encryption_profile(Client, Id, QueryMap, HeadersMap, Options0)
-
get_field_level_encryption_profile_config(Client, Id)
Get the field-level encryption profile configuration information.
- get_field_level_encryption_profile_config(Client, Id, QueryMap, HeadersMap)
- get_field_level_encryption_profile_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_invalidation(Client, DistributionId, Id)
Get the information about an invalidation.
- get_invalidation(Client, DistributionId, Id, QueryMap, HeadersMap)
- get_invalidation(Client, DistributionId, Id, QueryMap, HeadersMap, Options0)
-
get_key_group(Client, Id)
Gets a key group, including the date and time when the key group was last modified.
- get_key_group(Client, Id, QueryMap, HeadersMap)
- get_key_group(Client, Id, QueryMap, HeadersMap, Options0)
-
get_key_group_config(Client, Id)
Gets a key group configuration.
- get_key_group_config(Client, Id, QueryMap, HeadersMap)
- get_key_group_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_monitoring_subscription(Client, DistributionId)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
- get_monitoring_subscription(Client, DistributionId, QueryMap, HeadersMap)
- get_monitoring_subscription(Client, DistributionId, QueryMap, HeadersMap, Options0)
-
get_origin_request_policy(Client, Id)
Gets an origin request policy, including the following metadata:.
- get_origin_request_policy(Client, Id, QueryMap, HeadersMap)
- get_origin_request_policy(Client, Id, QueryMap, HeadersMap, Options0)
-
get_origin_request_policy_config(Client, Id)
Gets an origin request policy configuration.
- get_origin_request_policy_config(Client, Id, QueryMap, HeadersMap)
- get_origin_request_policy_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_public_key(Client, Id)
Gets a public key.
- get_public_key(Client, Id, QueryMap, HeadersMap)
- get_public_key(Client, Id, QueryMap, HeadersMap, Options0)
-
get_public_key_config(Client, Id)
Gets a public key configuration.
- get_public_key_config(Client, Id, QueryMap, HeadersMap)
- get_public_key_config(Client, Id, QueryMap, HeadersMap, Options0)
-
get_realtime_log_config(Client, Input)
Gets a real-time log configuration.
- get_realtime_log_config(Client, Input0, Options0)
-
get_streaming_distribution(Client, Id)
Gets information about a specified RTMP distribution, including the distribution configuration.
- get_streaming_distribution(Client, Id, QueryMap, HeadersMap)
- get_streaming_distribution(Client, Id, QueryMap, HeadersMap, Options0)
-
get_streaming_distribution_config(Client, Id)
Get the configuration information about a streaming distribution.
- get_streaming_distribution_config(Client, Id, QueryMap, HeadersMap)
- get_streaming_distribution_config(Client, Id, QueryMap, HeadersMap, Options0)
-
list_cache_policies(Client)
Gets a list of cache policies.
- list_cache_policies(Client, QueryMap, HeadersMap)
- list_cache_policies(Client, QueryMap, HeadersMap, Options0)
-
list_cloud_front_origin_access_identities(Client)
Lists origin access identities.
- list_cloud_front_origin_access_identities(Client, QueryMap, HeadersMap)
- list_cloud_front_origin_access_identities(Client, QueryMap, HeadersMap, Options0)
-
list_distributions(Client)
List CloudFront distributions.
- list_distributions(Client, QueryMap, HeadersMap)
- list_distributions(Client, QueryMap, HeadersMap, Options0)
-
list_distributions_by_cache_policy_id(Client, CachePolicyId)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy.
- list_distributions_by_cache_policy_id(Client, CachePolicyId, QueryMap, HeadersMap)
- list_distributions_by_cache_policy_id(Client, CachePolicyId, QueryMap, HeadersMap, Options0)
-
list_distributions_by_key_group(Client, KeyGroupId)
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
- list_distributions_by_key_group(Client, KeyGroupId, QueryMap, HeadersMap)
- list_distributions_by_key_group(Client, KeyGroupId, QueryMap, HeadersMap, Options0)
-
list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId)
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy.
- list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId, QueryMap, HeadersMap)
- list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId, QueryMap, HeadersMap, Options0)
-
list_distributions_by_realtime_log_config(Client, Input)
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration.
- list_distributions_by_realtime_log_config(Client, Input0, Options0)
-
list_distributions_by_web_acl_id(Client, WebACLId)
List the distributions that are associated with a specified AWS WAF web ACL.
- list_distributions_by_web_acl_id(Client, WebACLId, QueryMap, HeadersMap)
- list_distributions_by_web_acl_id(Client, WebACLId, QueryMap, HeadersMap, Options0)
-
list_field_level_encryption_configs(Client)
List all field-level encryption configurations that have been created in CloudFront for this account.
- list_field_level_encryption_configs(Client, QueryMap, HeadersMap)
- list_field_level_encryption_configs(Client, QueryMap, HeadersMap, Options0)
-
list_field_level_encryption_profiles(Client)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
- list_field_level_encryption_profiles(Client, QueryMap, HeadersMap)
- list_field_level_encryption_profiles(Client, QueryMap, HeadersMap, Options0)
-
list_invalidations(Client, DistributionId)
Lists invalidation batches.
- list_invalidations(Client, DistributionId, QueryMap, HeadersMap)
- list_invalidations(Client, DistributionId, QueryMap, HeadersMap, Options0)
-
list_key_groups(Client)
Gets a list of key groups.
- list_key_groups(Client, QueryMap, HeadersMap)
- list_key_groups(Client, QueryMap, HeadersMap, Options0)
-
list_origin_request_policies(Client)
Gets a list of origin request policies.
- list_origin_request_policies(Client, QueryMap, HeadersMap)
- list_origin_request_policies(Client, QueryMap, HeadersMap, Options0)
-
list_public_keys(Client)
List all public keys that have been added to CloudFront for this account.
- list_public_keys(Client, QueryMap, HeadersMap)
- list_public_keys(Client, QueryMap, HeadersMap, Options0)
-
list_realtime_log_configs(Client)
Gets a list of real-time log configurations.
- list_realtime_log_configs(Client, QueryMap, HeadersMap)
- list_realtime_log_configs(Client, QueryMap, HeadersMap, Options0)
-
list_streaming_distributions(Client)
List streaming distributions.
- list_streaming_distributions(Client, QueryMap, HeadersMap)
- list_streaming_distributions(Client, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, Resource)
List tags for a CloudFront resource.
- list_tags_for_resource(Client, Resource, QueryMap, HeadersMap)
- list_tags_for_resource(Client, Resource, QueryMap, HeadersMap, Options0)
-
tag_resource(Client, Input)
Add tags to a CloudFront resource.
- tag_resource(Client, Input0, Options0)
-
untag_resource(Client, Input)
Remove tags from a CloudFront resource.
- untag_resource(Client, Input0, Options0)
-
update_cache_policy(Client, Id, Input)
Updates a cache policy configuration.
- update_cache_policy(Client, Id, Input0, Options0)
-
update_cloud_front_origin_access_identity(Client, Id, Input)
Update an origin access identity.
- update_cloud_front_origin_access_identity(Client, Id, Input0, Options0)
-
update_distribution(Client, Id, Input)
Updates the configuration for a web distribution.
- update_distribution(Client, Id, Input0, Options0)
-
update_field_level_encryption_config(Client, Id, Input)
Update a field-level encryption configuration.
- update_field_level_encryption_config(Client, Id, Input0, Options0)
-
update_field_level_encryption_profile(Client, Id, Input)
Update a field-level encryption profile.
- update_field_level_encryption_profile(Client, Id, Input0, Options0)
-
update_key_group(Client, Id, Input)
Updates a key group.
- update_key_group(Client, Id, Input0, Options0)
-
update_origin_request_policy(Client, Id, Input)
Updates an origin request policy configuration.
- update_origin_request_policy(Client, Id, Input0, Options0)
-
update_public_key(Client, Id, Input)
Update public key information.
- update_public_key(Client, Id, Input0, Options0)
-
update_realtime_log_config(Client, Input)
Updates a real-time log configuration.
- update_realtime_log_config(Client, Input0, Options0)
-
update_streaming_distribution(Client, Id, Input)
Update a streaming distribution.
- update_streaming_distribution(Client, Id, Input0, Options0)
Functions
create_cache_policy(Client, Input)
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
.
create_cache_policy(Client, Input0, Options0)
create_cloud_front_origin_access_identity(Client, Input)
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.create_cloud_front_origin_access_identity(Client, Input0, Options0)
create_distribution(Client, Input)
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.
create_distribution(Client, Input0, Options0)
create_distribution_with_tags(Client, Input)
Create a new distribution with tags.
create_distribution_with_tags(Client, Input0, Options0)
create_field_level_encryption_config(Client, Input)
Create a new field-level encryption configuration.
create_field_level_encryption_config(Client, Input0, Options0)
create_field_level_encryption_profile(Client, Input)
Create a field-level encryption profile.
create_field_level_encryption_profile(Client, Input0, Options0)
create_invalidation(Client, DistributionId, Input)
Create a new invalidation.
create_invalidation(Client, DistributionId, Input0, Options0)
create_key_group(Client, Input)
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.create_key_group(Client, Input0, Options0)
create_monitoring_subscription(Client, DistributionId, Input)
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.create_monitoring_subscription(Client, DistributionId, Input0, Options0)
create_origin_request_policy(Client, Input)
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
, andX-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
.
create_origin_request_policy(Client, Input0, Options0)
create_public_key(Client, Input)
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
create_public_key(Client, Input0, Options0)
create_realtime_log_config(Client, Input)
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.create_realtime_log_config(Client, Input0, Options0)
create_streaming_distribution(Client, Input)
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(Client, Input0, Options0)
create_streaming_distribution_with_tags(Client, Input)
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, Input0, Options0)
delete_cache_policy(Client, Id, Input)
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 useListCachePolicies
or
GetCachePolicy
.
delete_cache_policy(Client, Id, Input0, Options0)
delete_cloud_front_origin_access_identity(Client, Id, Input)
Delete an origin access identity.
delete_cloud_front_origin_access_identity(Client, Id, Input0, Options0)
delete_distribution(Client, Id, Input)
Delete a distribution.
delete_distribution(Client, Id, Input0, Options0)
delete_field_level_encryption_config(Client, Id, Input)
Remove a field-level encryption configuration.
delete_field_level_encryption_config(Client, Id, Input0, Options0)
delete_field_level_encryption_profile(Client, Id, Input)
Remove a field-level encryption profile.
delete_field_level_encryption_profile(Client, Id, Input0, Options0)
delete_key_group(Client, Id, Input)
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, useListKeyGroups
followed by
GetKeyGroup
or GetKeyGroupConfig
.
delete_key_group(Client, Id, Input0, Options0)
delete_monitoring_subscription(Client, DistributionId, Input)
Disables additional CloudWatch metrics for the specified CloudFront distribution.
delete_monitoring_subscription(Client, DistributionId, Input0, Options0)
delete_origin_request_policy(Client, Id, Input)
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 useListOriginRequestPolicies
or GetOriginRequestPolicy
.
delete_origin_request_policy(Client, Id, Input0, Options0)
delete_public_key(Client, Id, Input)
Remove a public key you previously added to CloudFront.
delete_public_key(Client, Id, Input0, Options0)
delete_realtime_log_config(Client, Input)
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.delete_realtime_log_config(Client, Input0, Options0)
delete_streaming_distribution(Client, Id, Input)
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:
Disable the RTMP distribution.
Submit a
GET Streaming Distribution Config
request to get the current configuration and theEtag
header for the distribution.Update the XML document that was returned in the response to your
GET Streaming Distribution Config
request to change the value ofEnabled
tofalse
.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 HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2.Review the response to the
PUT Streaming Distribution Config
request to confirm that the distribution was successfully disabled.Submit a
GET Streaming Distribution Config
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
.Submit a
DELETE Streaming Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2.Review the response to your
DELETE Streaming Distribution
request to confirm that the distribution was successfully deleted.
delete_streaming_distribution(Client, Id, Input0, Options0)
get_cache_policy(Client, Id)
Gets a cache policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache
behavior, you can get the identifier using ListCachePolicies
.
get_cache_policy(Client, Id, QueryMap, HeadersMap)
get_cache_policy(Client, Id, QueryMap, HeadersMap, Options0)
get_cache_policy_config(Client, Id)
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 usingListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache
behavior, you can get the identifier using ListCachePolicies
.
get_cache_policy_config(Client, Id, QueryMap, HeadersMap)
get_cache_policy_config(Client, Id, QueryMap, HeadersMap, Options0)
get_cloud_front_origin_access_identity(Client, Id)
Get the information about an origin access identity.
get_cloud_front_origin_access_identity(Client, Id, QueryMap, HeadersMap)
get_cloud_front_origin_access_identity(Client, Id, QueryMap, HeadersMap, Options0)
get_cloud_front_origin_access_identity_config(Client, Id)
Get the configuration information about an origin access identity.
get_cloud_front_origin_access_identity_config(Client, Id, QueryMap, HeadersMap)
get_cloud_front_origin_access_identity_config(Client, Id, QueryMap, HeadersMap, Options0)
get_distribution(Client, Id)
Get the information about a distribution.
get_distribution(Client, Id, QueryMap, HeadersMap)
get_distribution(Client, Id, QueryMap, HeadersMap, Options0)
get_distribution_config(Client, Id)
Get the configuration information about a distribution.
get_distribution_config(Client, Id, QueryMap, HeadersMap)
get_distribution_config(Client, Id, QueryMap, HeadersMap, Options0)
get_field_level_encryption(Client, Id)
Get the field-level encryption configuration information.
get_field_level_encryption(Client, Id, QueryMap, HeadersMap)
get_field_level_encryption(Client, Id, QueryMap, HeadersMap, Options0)
get_field_level_encryption_config(Client, Id)
Get the field-level encryption configuration information.
get_field_level_encryption_config(Client, Id, QueryMap, HeadersMap)
get_field_level_encryption_config(Client, Id, QueryMap, HeadersMap, Options0)
get_field_level_encryption_profile(Client, Id)
Get the field-level encryption profile information.
get_field_level_encryption_profile(Client, Id, QueryMap, HeadersMap)
get_field_level_encryption_profile(Client, Id, QueryMap, HeadersMap, Options0)
get_field_level_encryption_profile_config(Client, Id)
Get the field-level encryption profile configuration information.
get_field_level_encryption_profile_config(Client, Id, QueryMap, HeadersMap)
get_field_level_encryption_profile_config(Client, Id, QueryMap, HeadersMap, Options0)
get_invalidation(Client, DistributionId, Id)
Get the information about an invalidation.
get_invalidation(Client, DistributionId, Id, QueryMap, HeadersMap)
get_invalidation(Client, DistributionId, Id, QueryMap, HeadersMap, Options0)
get_key_group(Client, Id)
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 usingListDistributions
or GetDistribution
.
If the key group is not referenced in a cache behavior, you can get the
identifier using ListKeyGroups
.
get_key_group(Client, Id, QueryMap, HeadersMap)
get_key_group(Client, Id, QueryMap, HeadersMap, Options0)
get_key_group_config(Client, Id)
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 usingListDistributions
or GetDistribution
. If the key group is not referenced in a cache
behavior, you can get the identifier using ListKeyGroups
.
get_key_group_config(Client, Id, QueryMap, HeadersMap)
get_key_group_config(Client, Id, QueryMap, HeadersMap, Options0)
get_monitoring_subscription(Client, DistributionId)
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
get_monitoring_subscription(Client, DistributionId, QueryMap, HeadersMap)
get_monitoring_subscription(Client, DistributionId, QueryMap, HeadersMap, Options0)
get_origin_request_policy(Client, Id)
Gets an origin request policy, including the following metadata:
The policy’s identifier.
The date and time when the policy was last modified.
ListDistributions
or GetDistribution
. If the origin request policy is
not attached to a cache behavior, you can get the identifier using
ListOriginRequestPolicies
.
get_origin_request_policy(Client, Id, QueryMap, HeadersMap)
get_origin_request_policy(Client, Id, QueryMap, HeadersMap, Options0)
get_origin_request_policy_config(Client, Id)
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 usingListDistributions
or GetDistribution
. If the origin request policy is
not attached to a cache behavior, you can get the identifier using
ListOriginRequestPolicies
.
get_origin_request_policy_config(Client, Id, QueryMap, HeadersMap)
get_origin_request_policy_config(Client, Id, QueryMap, HeadersMap, Options0)
get_public_key(Client, Id)
Gets a public key.
get_public_key(Client, Id, QueryMap, HeadersMap)
get_public_key(Client, Id, QueryMap, HeadersMap, Options0)
get_public_key_config(Client, Id)
Gets a public key configuration.
get_public_key_config(Client, Id, QueryMap, HeadersMap)
get_public_key_config(Client, Id, QueryMap, HeadersMap, Options0)
get_realtime_log_config(Client, Input)
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.get_realtime_log_config(Client, Input0, Options0)
get_streaming_distribution(Client, Id)
Gets information about a specified RTMP distribution, including the distribution configuration.
get_streaming_distribution(Client, Id, QueryMap, HeadersMap)
get_streaming_distribution(Client, Id, QueryMap, HeadersMap, Options0)
get_streaming_distribution_config(Client, Id)
Get the configuration information about a streaming distribution.
get_streaming_distribution_config(Client, Id, QueryMap, HeadersMap)
get_streaming_distribution_config(Client, Id, QueryMap, HeadersMap, Options0)
list_cache_policies(Client)
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS 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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_cache_policies(Client, QueryMap, HeadersMap)
list_cache_policies(Client, QueryMap, HeadersMap, Options0)
list_cloud_front_origin_access_identities(Client)
Lists origin access identities.
list_cloud_front_origin_access_identities(Client, QueryMap, HeadersMap)
list_cloud_front_origin_access_identities(Client, QueryMap, HeadersMap, Options0)
list_distributions(Client)
List CloudFront distributions.
list_distributions(Client, QueryMap, HeadersMap)
list_distributions(Client, QueryMap, HeadersMap, Options0)
list_distributions_by_cache_policy_id(Client, CachePolicyId)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_distributions_by_cache_policy_id(Client, CachePolicyId, QueryMap, HeadersMap)
list_distributions_by_cache_policy_id(Client, CachePolicyId, QueryMap, HeadersMap, Options0)
list_distributions_by_key_group(Client, KeyGroupId)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_distributions_by_key_group(Client, KeyGroupId, QueryMap, HeadersMap)
list_distributions_by_key_group(Client, KeyGroupId, QueryMap, HeadersMap, Options0)
list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId, QueryMap, HeadersMap)
list_distributions_by_origin_request_policy_id(Client, OriginRequestPolicyId, QueryMap, HeadersMap, Options0)
list_distributions_by_realtime_log_config(Client, Input)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_distributions_by_realtime_log_config(Client, Input0, Options0)
list_distributions_by_web_acl_id(Client, WebACLId)
List the distributions that are associated with a specified AWS WAF web ACL.
list_distributions_by_web_acl_id(Client, WebACLId, QueryMap, HeadersMap)
list_distributions_by_web_acl_id(Client, WebACLId, QueryMap, HeadersMap, Options0)
list_field_level_encryption_configs(Client)
List all field-level encryption configurations that have been created in CloudFront for this account.
list_field_level_encryption_configs(Client, QueryMap, HeadersMap)
list_field_level_encryption_configs(Client, QueryMap, HeadersMap, Options0)
list_field_level_encryption_profiles(Client)
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
list_field_level_encryption_profiles(Client, QueryMap, HeadersMap)
list_field_level_encryption_profiles(Client, QueryMap, HeadersMap, Options0)
list_invalidations(Client, DistributionId)
Lists invalidation batches.
list_invalidations(Client, DistributionId, QueryMap, HeadersMap)
list_invalidations(Client, DistributionId, QueryMap, HeadersMap, Options0)
list_key_groups(Client)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_key_groups(Client, QueryMap, HeadersMap)
list_key_groups(Client, QueryMap, HeadersMap, Options0)
list_origin_request_policies(Client)
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by AWS, or only the custom policies created in your AWS 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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_origin_request_policies(Client, QueryMap, HeadersMap)
list_origin_request_policies(Client, QueryMap, HeadersMap, Options0)
list_public_keys(Client)
List all public keys that have been added to CloudFront for this account.
list_public_keys(Client, QueryMap, HeadersMap)
list_public_keys(Client, QueryMap, HeadersMap, Options0)
list_realtime_log_configs(Client)
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 theNextMarker
value from the current response as the Marker
value in the
subsequent request.
list_realtime_log_configs(Client, QueryMap, HeadersMap)
list_realtime_log_configs(Client, QueryMap, HeadersMap, Options0)
list_streaming_distributions(Client)
List streaming distributions.
list_streaming_distributions(Client, QueryMap, HeadersMap)
list_streaming_distributions(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, Resource)
List tags for a CloudFront resource.
list_tags_for_resource(Client, Resource, QueryMap, HeadersMap)
list_tags_for_resource(Client, Resource, QueryMap, HeadersMap, Options0)
tag_resource(Client, Input)
Add tags to a CloudFront resource.
tag_resource(Client, Input0, Options0)
untag_resource(Client, Input)
Remove tags from a CloudFront resource.
untag_resource(Client, Input0, Options0)
update_cache_policy(Client, Id, Input)
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:
Use
GetCachePolicyConfig
to get the current configuration.Locally modify the fields in the cache policy configuration that you want to update.
Call
UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that you modified and those that you didn’t.
update_cache_policy(Client, Id, Input0, Options0)
update_cloud_front_origin_access_identity(Client, Id, Input)
Update an origin access identity.
update_cloud_front_origin_access_identity(Client, Id, Input0, Options0)
update_distribution(Client, Id, Input)
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
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.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 anIllegalUpdate
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 correspondingQuantity
element.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 theETag
header that CloudFront returned when you submitted theGetDistributionConfig
request in Step 1.
Review the response to the
UpdateDistribution
request to confirm that the configuration was successfully updated.Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of
Status
isDeployed
.
update_distribution(Client, Id, Input0, Options0)
update_field_level_encryption_config(Client, Id, Input)
Update a field-level encryption configuration.
update_field_level_encryption_config(Client, Id, Input0, Options0)
update_field_level_encryption_profile(Client, Id, Input)
Update a field-level encryption profile.
update_field_level_encryption_profile(Client, Id, Input0, Options0)
update_key_group(Client, Id, Input)
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:
Get the current key group with
GetKeyGroup
orGetKeyGroupConfig
.Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call
UpdateKeyGroup
with the entire key group object, including the fields that you modified and those that you didn’t.
update_key_group(Client, Id, Input0, Options0)
update_origin_request_policy(Client, Id, Input)
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:
Use
GetOriginRequestPolicyConfig
to get the current configuration.Locally modify the fields in the origin request policy configuration that you want to update.
Call
UpdateOriginRequestPolicy
by providing the entire origin request policy configuration, including the fields that you modified and those that you didn’t.
update_origin_request_policy(Client, Id, Input0, Options0)
update_public_key(Client, Id, Input)
Update public key information.
Note that the only value you can change is the comment.update_public_key(Client, Id, Input0, Options0)
update_realtime_log_config(Client, Input)
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:
Call
GetRealtimeLogConfig
to get the current real-time log configuration.Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (
UpdateRealtimeLogConfig
) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.
Name
or
ARN
.
update_realtime_log_config(Client, Input0, Options0)
update_streaming_distribution(Client, Id, Input)
Update a streaming distribution.