Cloudfront
This page documents function available when using the Cloudfront
module, created with @service Cloudfront
.
Index
Main.Cloudfront.create_cache_policy2020_05_31
Main.Cloudfront.create_cloud_front_origin_access_identity2020_05_31
Main.Cloudfront.create_distribution2020_05_31
Main.Cloudfront.create_distribution_with_tags2020_05_31
Main.Cloudfront.create_field_level_encryption_config2020_05_31
Main.Cloudfront.create_field_level_encryption_profile2020_05_31
Main.Cloudfront.create_function2020_05_31
Main.Cloudfront.create_invalidation2020_05_31
Main.Cloudfront.create_key_group2020_05_31
Main.Cloudfront.create_monitoring_subscription2020_05_31
Main.Cloudfront.create_origin_request_policy2020_05_31
Main.Cloudfront.create_public_key2020_05_31
Main.Cloudfront.create_realtime_log_config2020_05_31
Main.Cloudfront.create_streaming_distribution2020_05_31
Main.Cloudfront.create_streaming_distribution_with_tags2020_05_31
Main.Cloudfront.delete_cache_policy2020_05_31
Main.Cloudfront.delete_cloud_front_origin_access_identity2020_05_31
Main.Cloudfront.delete_distribution2020_05_31
Main.Cloudfront.delete_field_level_encryption_config2020_05_31
Main.Cloudfront.delete_field_level_encryption_profile2020_05_31
Main.Cloudfront.delete_function2020_05_31
Main.Cloudfront.delete_key_group2020_05_31
Main.Cloudfront.delete_monitoring_subscription2020_05_31
Main.Cloudfront.delete_origin_request_policy2020_05_31
Main.Cloudfront.delete_public_key2020_05_31
Main.Cloudfront.delete_realtime_log_config2020_05_31
Main.Cloudfront.delete_streaming_distribution2020_05_31
Main.Cloudfront.describe_function2020_05_31
Main.Cloudfront.get_cache_policy2020_05_31
Main.Cloudfront.get_cache_policy_config2020_05_31
Main.Cloudfront.get_cloud_front_origin_access_identity2020_05_31
Main.Cloudfront.get_cloud_front_origin_access_identity_config2020_05_31
Main.Cloudfront.get_distribution2020_05_31
Main.Cloudfront.get_distribution_config2020_05_31
Main.Cloudfront.get_field_level_encryption2020_05_31
Main.Cloudfront.get_field_level_encryption_config2020_05_31
Main.Cloudfront.get_field_level_encryption_profile2020_05_31
Main.Cloudfront.get_field_level_encryption_profile_config2020_05_31
Main.Cloudfront.get_function2020_05_31
Main.Cloudfront.get_invalidation2020_05_31
Main.Cloudfront.get_key_group2020_05_31
Main.Cloudfront.get_key_group_config2020_05_31
Main.Cloudfront.get_monitoring_subscription2020_05_31
Main.Cloudfront.get_origin_request_policy2020_05_31
Main.Cloudfront.get_origin_request_policy_config2020_05_31
Main.Cloudfront.get_public_key2020_05_31
Main.Cloudfront.get_public_key_config2020_05_31
Main.Cloudfront.get_realtime_log_config2020_05_31
Main.Cloudfront.get_streaming_distribution2020_05_31
Main.Cloudfront.get_streaming_distribution_config2020_05_31
Main.Cloudfront.list_cache_policies2020_05_31
Main.Cloudfront.list_cloud_front_origin_access_identities2020_05_31
Main.Cloudfront.list_distributions2020_05_31
Main.Cloudfront.list_distributions_by_cache_policy_id2020_05_31
Main.Cloudfront.list_distributions_by_key_group2020_05_31
Main.Cloudfront.list_distributions_by_origin_request_policy_id2020_05_31
Main.Cloudfront.list_distributions_by_realtime_log_config2020_05_31
Main.Cloudfront.list_distributions_by_web_aclid2020_05_31
Main.Cloudfront.list_field_level_encryption_configs2020_05_31
Main.Cloudfront.list_field_level_encryption_profiles2020_05_31
Main.Cloudfront.list_functions2020_05_31
Main.Cloudfront.list_invalidations2020_05_31
Main.Cloudfront.list_key_groups2020_05_31
Main.Cloudfront.list_origin_request_policies2020_05_31
Main.Cloudfront.list_public_keys2020_05_31
Main.Cloudfront.list_realtime_log_configs2020_05_31
Main.Cloudfront.list_streaming_distributions2020_05_31
Main.Cloudfront.list_tags_for_resource2020_05_31
Main.Cloudfront.publish_function2020_05_31
Main.Cloudfront.tag_resource2020_05_31
Main.Cloudfront.test_function2020_05_31
Main.Cloudfront.untag_resource2020_05_31
Main.Cloudfront.update_cache_policy2020_05_31
Main.Cloudfront.update_cloud_front_origin_access_identity2020_05_31
Main.Cloudfront.update_distribution2020_05_31
Main.Cloudfront.update_field_level_encryption_config2020_05_31
Main.Cloudfront.update_field_level_encryption_profile2020_05_31
Main.Cloudfront.update_function2020_05_31
Main.Cloudfront.update_key_group2020_05_31
Main.Cloudfront.update_origin_request_policy2020_05_31
Main.Cloudfront.update_public_key2020_05_31
Main.Cloudfront.update_realtime_log_config2020_05_31
Main.Cloudfront.update_streaming_distribution2020_05_31
Documentation
Main.Cloudfront.create_cache_policy2020_05_31
— Methodcreate_cache_policy2020_05_31(cache_policy_config)
create_cache_policy2020_05_31(cache_policy_config, params::Dict{String,<:Any})
Creates a cache policy. After you create a cache policy, you can attach it to one or more cache behaviors. When it’s attached to a cache behavior, the cache policy determines the following: The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. The headers, cookies, and query strings that are included in the cache key are automatically included in requests that CloudFront sends to the origin. CloudFront sends a request when it can’t find an object in its cache that matches the request’s cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy. For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
Arguments
cache_policy_config
: A cache policy configuration.
Main.Cloudfront.create_cloud_front_origin_access_identity2020_05_31
— Methodcreate_cloud_front_origin_access_identity2020_05_31(cloud_front_origin_access_identity_config)
create_cloud_front_origin_access_identity2020_05_31(cloud_front_origin_access_identity_config, params::Dict{String,<:Any})
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.
Arguments
cloud_front_origin_access_identity_config
: The current configuration information for the identity.
Main.Cloudfront.create_distribution2020_05_31
— Methodcreate_distribution2020_05_31(distribution_config)
create_distribution2020_05_31(distribution_config, params::Dict{String,<:Any})
Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource. When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.
Arguments
distribution_config
: The distribution's configuration information.
Main.Cloudfront.create_distribution_with_tags2020_05_31
— Methodcreate_distribution_with_tags2020_05_31(distribution_config_with_tags)
create_distribution_with_tags2020_05_31(distribution_config_with_tags, params::Dict{String,<:Any})
Create a new distribution with tags.
Arguments
distribution_config_with_tags
: The distribution's configuration information.
Main.Cloudfront.create_field_level_encryption_config2020_05_31
— Methodcreate_field_level_encryption_config2020_05_31(field_level_encryption_config)
create_field_level_encryption_config2020_05_31(field_level_encryption_config, params::Dict{String,<:Any})
Create a new field-level encryption configuration.
Arguments
field_level_encryption_config
: The request to create a new field-level encryption configuration.
Main.Cloudfront.create_field_level_encryption_profile2020_05_31
— Methodcreate_field_level_encryption_profile2020_05_31(field_level_encryption_profile_config)
create_field_level_encryption_profile2020_05_31(field_level_encryption_profile_config, params::Dict{String,<:Any})
Create a field-level encryption profile.
Arguments
field_level_encryption_profile_config
: The request to create a field-level encryption profile.
Main.Cloudfront.create_function2020_05_31
— Methodcreate_function2020_05_31(function_code, function_config, name)
create_function2020_05_31(function_code, function_config, name, params::Dict{String,<:Any})
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.
Arguments
function_code
: The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.function_config
: Configuration information about the function, including an optional comment and the function’s runtime.name
: A name to identify the function.
Main.Cloudfront.create_invalidation2020_05_31
— Methodcreate_invalidation2020_05_31(distribution_id, invalidation_batch)
create_invalidation2020_05_31(distribution_id, invalidation_batch, params::Dict{String,<:Any})
Create a new invalidation.
Arguments
distribution_id
: The distribution's id.invalidation_batch
: The batch information for the invalidation.
Main.Cloudfront.create_key_group2020_05_31
— Methodcreate_key_group2020_05_31(key_group_config)
create_key_group2020_05_31(key_group_config, params::Dict{String,<:Any})
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.
Arguments
key_group_config
: A key group configuration.
Main.Cloudfront.create_monitoring_subscription2020_05_31
— Methodcreate_monitoring_subscription2020_05_31(distribution_id, monitoring_subscription)
create_monitoring_subscription2020_05_31(distribution_id, monitoring_subscription, params::Dict{String,<:Any})
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.
Arguments
distribution_id
: The ID of the distribution that you are enabling metrics for.monitoring_subscription
: A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.
Main.Cloudfront.create_origin_request_policy2020_05_31
— Methodcreate_origin_request_policy2020_05_31(origin_request_policy_config)
create_origin_request_policy2020_05_31(origin_request_policy_config, params::Dict{String,<:Any})
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.
Arguments
origin_request_policy_config
: An origin request policy configuration.
Main.Cloudfront.create_public_key2020_05_31
— Methodcreate_public_key2020_05_31(public_key_config)
create_public_key2020_05_31(public_key_config, params::Dict{String,<:Any})
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
Arguments
public_key_config
: A CloudFront public key configuration.
Main.Cloudfront.create_realtime_log_config2020_05_31
— Methodcreate_realtime_log_config2020_05_31(end_points, field, name, sampling_rate)
create_realtime_log_config2020_05_31(end_points, field, name, sampling_rate, params::Dict{String,<:Any})
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.
Arguments
end_points
: Contains information about the Amazon Kinesis data stream where you are sending real-time log data.field
: A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.name
: A unique name to identify this real-time log configuration.sampling_rate
: The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Fields"
: A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
Main.Cloudfront.create_streaming_distribution2020_05_31
— Methodcreate_streaming_distribution2020_05_31(streaming_distribution_config)
create_streaming_distribution2020_05_31(streaming_distribution_config, params::Dict{String,<:Any})
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.
Arguments
streaming_distribution_config
: The streaming distribution's configuration information.
Main.Cloudfront.create_streaming_distribution_with_tags2020_05_31
— Methodcreate_streaming_distribution_with_tags2020_05_31(streaming_distribution_config_with_tags)
create_streaming_distribution_with_tags2020_05_31(streaming_distribution_config_with_tags, params::Dict{String,<:Any})
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.
Arguments
streaming_distribution_config_with_tags
: The streaming distribution's configuration information.
Main.Cloudfront.delete_cache_policy2020_05_31
— Methoddelete_cache_policy2020_05_31(id)
delete_cache_policy2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the cache policy that you are deleting. The version is the cache policy’s ETag value, which you can get using ListCachePolicies, GetCachePolicy, or GetCachePolicyConfig.
Main.Cloudfront.delete_cloud_front_origin_access_identity2020_05_31
— Methoddelete_cloud_front_origin_access_identity2020_05_31(id)
delete_cloud_front_origin_access_identity2020_05_31(id, params::Dict{String,<:Any})
Delete an origin access identity.
Arguments
id
: The origin access identity's ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.delete_distribution2020_05_31
— Methoddelete_distribution2020_05_31(id)
delete_distribution2020_05_31(id, params::Dict{String,<:Any})
Delete a distribution.
Arguments
id
: The distribution ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.delete_field_level_encryption_config2020_05_31
— Methoddelete_field_level_encryption_config2020_05_31(id)
delete_field_level_encryption_config2020_05_31(id, params::Dict{String,<:Any})
Remove a field-level encryption configuration.
Arguments
id
: The ID of the configuration you want to delete from CloudFront.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.delete_field_level_encryption_profile2020_05_31
— Methoddelete_field_level_encryption_profile2020_05_31(id)
delete_field_level_encryption_profile2020_05_31(id, params::Dict{String,<:Any})
Remove a field-level encryption profile.
Arguments
id
: Request the ID of the profile you want to delete from CloudFront.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.delete_function2020_05_31
— Methoddelete_function2020_05_31(if-_match, name)
delete_function2020_05_31(if-_match, name, params::Dict{String,<:Any})
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.
Arguments
if-_match
: The current version (ETag value) of the function that you are deleting, which you can get using DescribeFunction.name
: The name of the function that you are deleting.
Main.Cloudfront.delete_key_group2020_05_31
— Methoddelete_key_group2020_05_31(id)
delete_key_group2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the key group that you are deleting. The version is the key group’s ETag value. To get the ETag, use GetKeyGroup or GetKeyGroupConfig.
Main.Cloudfront.delete_monitoring_subscription2020_05_31
— Methoddelete_monitoring_subscription2020_05_31(distribution_id)
delete_monitoring_subscription2020_05_31(distribution_id, params::Dict{String,<:Any})
Disables additional CloudWatch metrics for the specified CloudFront distribution.
Arguments
distribution_id
: The ID of the distribution that you are disabling metrics for.
Main.Cloudfront.delete_origin_request_policy2020_05_31
— Methoddelete_origin_request_policy2020_05_31(id)
delete_origin_request_policy2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the origin request policy that you are deleting. The version is the origin request policy’s ETag value, which you can get using ListOriginRequestPolicies, GetOriginRequestPolicy, or GetOriginRequestPolicyConfig.
Main.Cloudfront.delete_public_key2020_05_31
— Methoddelete_public_key2020_05_31(id)
delete_public_key2020_05_31(id, params::Dict{String,<:Any})
Remove a public key you previously added to CloudFront.
Arguments
id
: The ID of the public key you want to remove from CloudFront.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.delete_realtime_log_config2020_05_31
— Methoddelete_realtime_log_config2020_05_31()
delete_realtime_log_config2020_05_31(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ARN"
: The Amazon Resource Name (ARN) of the real-time log configuration to delete."Name"
: The name of the real-time log configuration to delete.
Main.Cloudfront.delete_streaming_distribution2020_05_31
— Methoddelete_streaming_distribution2020_05_31(id)
delete_streaming_distribution2020_05_31(id, params::Dict{String,<:Any})
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 the Etag 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 of Enabled to false. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. 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 of Status is Deployed. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2. 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.
Arguments
id
: The distribution ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.describe_function2020_05_31
— Methoddescribe_function2020_05_31(name)
describe_function2020_05_31(name, params::Dict{String,<:Any})
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.
Arguments
name
: The name of the function that you are getting information about.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Stage"
: The function’s stage, either DEVELOPMENT or LIVE.
Main.Cloudfront.get_cache_policy2020_05_31
— Methodget_cache_policy2020_05_31(id)
get_cache_policy2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the cache policy. 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.
Main.Cloudfront.get_cache_policy_config2020_05_31
— Methodget_cache_policy_config2020_05_31(id)
get_cache_policy_config2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the cache policy. 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.
Main.Cloudfront.get_cloud_front_origin_access_identity2020_05_31
— Methodget_cloud_front_origin_access_identity2020_05_31(id)
get_cloud_front_origin_access_identity2020_05_31(id, params::Dict{String,<:Any})
Get the information about an origin access identity.
Arguments
id
: The identity's ID.
Main.Cloudfront.get_cloud_front_origin_access_identity_config2020_05_31
— Methodget_cloud_front_origin_access_identity_config2020_05_31(id)
get_cloud_front_origin_access_identity_config2020_05_31(id, params::Dict{String,<:Any})
Get the configuration information about an origin access identity.
Arguments
id
: The identity's ID.
Main.Cloudfront.get_distribution2020_05_31
— Methodget_distribution2020_05_31(id)
get_distribution2020_05_31(id, params::Dict{String,<:Any})
Get the information about a distribution.
Arguments
id
: The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
Main.Cloudfront.get_distribution_config2020_05_31
— Methodget_distribution_config2020_05_31(id)
get_distribution_config2020_05_31(id, params::Dict{String,<:Any})
Get the configuration information about a distribution.
Arguments
id
: The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
Main.Cloudfront.get_field_level_encryption2020_05_31
— Methodget_field_level_encryption2020_05_31(id)
get_field_level_encryption2020_05_31(id, params::Dict{String,<:Any})
Get the field-level encryption configuration information.
Arguments
id
: Request the ID for the field-level encryption configuration information.
Main.Cloudfront.get_field_level_encryption_config2020_05_31
— Methodget_field_level_encryption_config2020_05_31(id)
get_field_level_encryption_config2020_05_31(id, params::Dict{String,<:Any})
Get the field-level encryption configuration information.
Arguments
id
: Request the ID for the field-level encryption configuration information.
Main.Cloudfront.get_field_level_encryption_profile2020_05_31
— Methodget_field_level_encryption_profile2020_05_31(id)
get_field_level_encryption_profile2020_05_31(id, params::Dict{String,<:Any})
Get the field-level encryption profile information.
Arguments
id
: Get the ID for the field-level encryption profile information.
Main.Cloudfront.get_field_level_encryption_profile_config2020_05_31
— Methodget_field_level_encryption_profile_config2020_05_31(id)
get_field_level_encryption_profile_config2020_05_31(id, params::Dict{String,<:Any})
Get the field-level encryption profile configuration information.
Arguments
id
: Get the ID for the field-level encryption profile configuration information.
Main.Cloudfront.get_function2020_05_31
— Methodget_function2020_05_31(name)
get_function2020_05_31(name, params::Dict{String,<:Any})
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.
Arguments
name
: The name of the function whose code you are getting.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Stage"
: The function’s stage, either DEVELOPMENT or LIVE.
Main.Cloudfront.get_invalidation2020_05_31
— Methodget_invalidation2020_05_31(distribution_id, id)
get_invalidation2020_05_31(distribution_id, id, params::Dict{String,<:Any})
Get the information about an invalidation.
Arguments
distribution_id
: The distribution's ID.id
: The identifier for the invalidation request, for example, IDFDVBD632BHDS5.
Main.Cloudfront.get_key_group2020_05_31
— Methodget_key_group2020_05_31(id)
get_key_group2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups.
Main.Cloudfront.get_key_group_config2020_05_31
— Methodget_key_group_config2020_05_31(id)
get_key_group_config2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups.
Main.Cloudfront.get_monitoring_subscription2020_05_31
— Methodget_monitoring_subscription2020_05_31(distribution_id)
get_monitoring_subscription2020_05_31(distribution_id, params::Dict{String,<:Any})
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
Arguments
distribution_id
: The ID of the distribution that you are getting metrics information for.
Main.Cloudfront.get_origin_request_policy2020_05_31
— Methodget_origin_request_policy2020_05_31(id)
get_origin_request_policy2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the origin request policy. 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.
Main.Cloudfront.get_origin_request_policy_config2020_05_31
— Methodget_origin_request_policy_config2020_05_31(id)
get_origin_request_policy_config2020_05_31(id, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the origin request policy. 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.
Main.Cloudfront.get_public_key2020_05_31
— Methodget_public_key2020_05_31(id)
get_public_key2020_05_31(id, params::Dict{String,<:Any})
Gets a public key.
Arguments
id
: The identifier of the public key you are getting.
Main.Cloudfront.get_public_key_config2020_05_31
— Methodget_public_key_config2020_05_31(id)
get_public_key_config2020_05_31(id, params::Dict{String,<:Any})
Gets a public key configuration.
Arguments
id
: The identifier of the public key whose configuration you are getting.
Main.Cloudfront.get_realtime_log_config2020_05_31
— Methodget_realtime_log_config2020_05_31()
get_realtime_log_config2020_05_31(params::Dict{String,<:Any})
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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ARN"
: The Amazon Resource Name (ARN) of the real-time log configuration to get."Name"
: The name of the real-time log configuration to get.
Main.Cloudfront.get_streaming_distribution2020_05_31
— Methodget_streaming_distribution2020_05_31(id)
get_streaming_distribution2020_05_31(id, params::Dict{String,<:Any})
Gets information about a specified RTMP distribution, including the distribution configuration.
Arguments
id
: The streaming distribution's ID.
Main.Cloudfront.get_streaming_distribution_config2020_05_31
— Methodget_streaming_distribution_config2020_05_31(id)
get_streaming_distribution_config2020_05_31(id, params::Dict{String,<:Any})
Get the configuration information about a streaming distribution.
Arguments
id
: The streaming distribution's ID.
Main.Cloudfront.list_cache_policies2020_05_31
— Methodlist_cache_policies2020_05_31()
list_cache_policies2020_05_31(params::Dict{String,<:Any})
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 the NextMarker value from the current response as the Marker value in the subsequent request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of cache policies that you want in the response."Type"
: A filter to return only the specified kinds of cache policies. Valid values are: managed – Returns only the managed policies created by AWS. custom – Returns only the custom policies created in your AWS account.
Main.Cloudfront.list_cloud_front_origin_access_identities2020_05_31
— Methodlist_cloud_front_origin_access_identities2020_05_31()
list_cloud_front_origin_access_identities2020_05_31(params::Dict{String,<:Any})
Lists origin access identities.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)."MaxItems"
: The maximum number of origin access identities you want in the response body.
Main.Cloudfront.list_distributions2020_05_31
— Methodlist_distributions2020_05_31()
list_distributions2020_05_31(params::Dict{String,<:Any})
List CloudFront distributions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)."MaxItems"
: The maximum number of distributions you want in the response body.
Main.Cloudfront.list_distributions_by_cache_policy_id2020_05_31
— Methodlist_distributions_by_cache_policy_id2020_05_31(cache_policy_id)
list_distributions_by_cache_policy_id2020_05_31(cache_policy_id, params::Dict{String,<:Any})
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified cache policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Arguments
cache_policy_id
: The ID of the cache policy whose associated distribution IDs you want to list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of distribution IDs that you want in the response.
Main.Cloudfront.list_distributions_by_key_group2020_05_31
— Methodlist_distributions_by_key_group2020_05_31(key_group_id)
list_distributions_by_key_group2020_05_31(key_group_id, params::Dict{String,<:Any})
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Arguments
key_group_id
: The ID of the key group whose associated distribution IDs you are listing.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of distribution IDs that you want in the response.
Main.Cloudfront.list_distributions_by_origin_request_policy_id2020_05_31
— Methodlist_distributions_by_origin_request_policy_id2020_05_31(origin_request_policy_id)
list_distributions_by_origin_request_policy_id2020_05_31(origin_request_policy_id, params::Dict{String,<:Any})
Gets a list of distribution IDs for distributions that have a cache behavior that’s associated with the specified origin request policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Arguments
origin_request_policy_id
: The ID of the origin request policy whose associated distribution IDs you want to list.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of distribution IDs that you want in the response.
Main.Cloudfront.list_distributions_by_realtime_log_config2020_05_31
— Methodlist_distributions_by_realtime_log_config2020_05_31()
list_distributions_by_realtime_log_config2020_05_31(params::Dict{String,<:Any})
Gets a list of distributions that have a cache behavior that’s associated with the specified real-time log configuration. You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of distributions that you want in the response."RealtimeLogConfigArn"
: The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list."RealtimeLogConfigName"
: The name of the real-time log configuration whose associated distributions you want to list.
Main.Cloudfront.list_distributions_by_web_aclid2020_05_31
— Methodlist_distributions_by_web_aclid2020_05_31(web_aclid)
list_distributions_by_web_aclid2020_05_31(web_aclid, params::Dict{String,<:Any})
List the distributions that are associated with a specified AWS WAF web ACL.
Arguments
web_aclid
: The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)"MaxItems"
: The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
Main.Cloudfront.list_field_level_encryption_configs2020_05_31
— Methodlist_field_level_encryption_configs2020_05_31()
list_field_level_encryption_configs2020_05_31(params::Dict{String,<:Any})
List all field-level encryption configurations that have been created in CloudFront for this account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page)."MaxItems"
: The maximum number of field-level encryption configurations you want in the response body.
Main.Cloudfront.list_field_level_encryption_profiles2020_05_31
— Methodlist_field_level_encryption_profiles2020_05_31()
list_field_level_encryption_profiles2020_05_31(params::Dict{String,<:Any})
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page)."MaxItems"
: The maximum number of field-level encryption profiles you want in the response body.
Main.Cloudfront.list_functions2020_05_31
— Methodlist_functions2020_05_31()
list_functions2020_05_31(params::Dict{String,<:Any})
Gets a list of all CloudFront functions in your AWS 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of functions that you want in the response."Stage"
: An optional filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE.
Main.Cloudfront.list_invalidations2020_05_31
— Methodlist_invalidations2020_05_31(distribution_id)
list_invalidations2020_05_31(distribution_id, params::Dict{String,<:Any})
Lists invalidation batches.
Arguments
distribution_id
: The distribution's ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page."MaxItems"
: The maximum number of invalidation batches that you want in the response body.
Main.Cloudfront.list_key_groups2020_05_31
— Methodlist_key_groups2020_05_31()
list_key_groups2020_05_31(params::Dict{String,<:Any})
Gets a list of key groups. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of key groups that you want in the response.
Main.Cloudfront.list_origin_request_policies2020_05_31
— Methodlist_origin_request_policies2020_05_31()
list_origin_request_policies2020_05_31(params::Dict{String,<:Any})
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 the NextMarker value from the current response as the Marker value in the subsequent request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of origin request policies that you want in the response."Type"
: A filter to return only the specified kinds of origin request policies. Valid values are: managed – Returns only the managed policies created by AWS. custom – Returns only the custom policies created in your AWS account.
Main.Cloudfront.list_public_keys2020_05_31
— Methodlist_public_keys2020_05_31()
list_public_keys2020_05_31(params::Dict{String,<:Any})
List all public keys that have been added to CloudFront for this account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page)."MaxItems"
: The maximum number of public keys you want in the response body.
Main.Cloudfront.list_realtime_log_configs2020_05_31
— Methodlist_realtime_log_configs2020_05_31()
list_realtime_log_configs2020_05_31(params::Dict{String,<:Any})
Gets a list of real-time log configurations. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response."MaxItems"
: The maximum number of real-time log configurations that you want in the response.
Main.Cloudfront.list_streaming_distributions2020_05_31
— Methodlist_streaming_distributions2020_05_31()
list_streaming_distributions2020_05_31(params::Dict{String,<:Any})
List streaming distributions.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Marker"
: The value that you provided for the Marker request parameter."MaxItems"
: The value that you provided for the MaxItems request parameter.
Main.Cloudfront.list_tags_for_resource2020_05_31
— Methodlist_tags_for_resource2020_05_31(resource)
list_tags_for_resource2020_05_31(resource, params::Dict{String,<:Any})
List tags for a CloudFront resource.
Arguments
resource
: An ARN of a CloudFront resource.
Main.Cloudfront.publish_function2020_05_31
— Methodpublish_function2020_05_31(if-_match, name)
publish_function2020_05_31(if-_match, name, params::Dict{String,<:Any})
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.
Arguments
if-_match
: The current version (ETag value) of the function that you are publishing, which you can get using DescribeFunction.name
: The name of the function that you are publishing.
Main.Cloudfront.tag_resource2020_05_31
— Methodtag_resource2020_05_31(resource, tags)
tag_resource2020_05_31(resource, tags, params::Dict{String,<:Any})
Add tags to a CloudFront resource.
Arguments
resource
: An ARN of a CloudFront resource.tags
: A complex type that contains zero or more Tag elements.
Main.Cloudfront.test_function2020_05_31
— Methodtest_function2020_05_31(event_object, if-_match, name)
test_function2020_05_31(event_object, if-_match, name, params::Dict{String,<:Any})
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.
Arguments
event_object
: The event object to test the function with. For more information about the structure of the event object, see Testing functions in the Amazon CloudFront Developer Guide.if-_match
: The current version (ETag value) of the function that you are testing, which you can get using DescribeFunction.name
: The name of the function that you are testing.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Stage"
: The stage of the function that you are testing, either DEVELOPMENT or LIVE.
Main.Cloudfront.untag_resource2020_05_31
— Methoduntag_resource2020_05_31(resource, tag_keys)
untag_resource2020_05_31(resource, tag_keys, params::Dict{String,<:Any})
Remove tags from a CloudFront resource.
Arguments
resource
: An ARN of a CloudFront resource.tag_keys
: A complex type that contains zero or more Tag key elements.
Main.Cloudfront.update_cache_policy2020_05_31
— Methodupdate_cache_policy2020_05_31(cache_policy_config, id)
update_cache_policy2020_05_31(cache_policy_config, id, params::Dict{String,<:Any})
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.
Arguments
cache_policy_config
: A cache policy configuration.id
: The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s CachePolicyId field in the response to GetDistributionConfig.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the cache policy that you are updating. The version is returned in the cache policy’s ETag field in the response to GetCachePolicyConfig.
Main.Cloudfront.update_cloud_front_origin_access_identity2020_05_31
— Methodupdate_cloud_front_origin_access_identity2020_05_31(cloud_front_origin_access_identity_config, id)
update_cloud_front_origin_access_identity2020_05_31(cloud_front_origin_access_identity_config, id, params::Dict{String,<:Any})
Update an origin access identity.
Arguments
cloud_front_origin_access_identity_config
: The identity's configuration information.id
: The identity's id.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.update_distribution2020_05_31
— Methodupdate_distribution2020_05_31(distribution_config, id)
update_distribution2020_05_31(distribution_config, id, params::Dict{String,<:Any})
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 an IllegalUpdate error. The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element. Submit an UpdateDistribution request to update the configuration for your distribution: In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1. 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 is Deployed.
Arguments
distribution_config
: The distribution's configuration information.id
: The distribution's id.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.update_field_level_encryption_config2020_05_31
— Methodupdate_field_level_encryption_config2020_05_31(field_level_encryption_config, id)
update_field_level_encryption_config2020_05_31(field_level_encryption_config, id, params::Dict{String,<:Any})
Update a field-level encryption configuration.
Arguments
field_level_encryption_config
: Request to update a field-level encryption configuration.id
: The ID of the configuration you want to update.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.update_field_level_encryption_profile2020_05_31
— Methodupdate_field_level_encryption_profile2020_05_31(field_level_encryption_profile_config, id)
update_field_level_encryption_profile2020_05_31(field_level_encryption_profile_config, id, params::Dict{String,<:Any})
Update a field-level encryption profile.
Arguments
field_level_encryption_profile_config
: Request to update a field-level encryption profile.id
: The ID of the field-level encryption profile request.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.update_function2020_05_31
— Methodupdate_function2020_05_31(function_code, function_config, if-_match, name)
update_function2020_05_31(function_code, function_config, if-_match, name, params::Dict{String,<:Any})
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.
Arguments
function_code
: The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide.function_config
: Configuration information about the function.if-_match
: The current version (ETag value) of the function that you are updating, which you can get using DescribeFunction.name
: The name of the function that you are updating.
Main.Cloudfront.update_key_group2020_05_31
— Methodupdate_key_group2020_05_31(id, key_group_config)
update_key_group2020_05_31(id, key_group_config, params::Dict{String,<:Any})
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 or GetKeyGroupConfig. 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.
Arguments
id
: The identifier of the key group that you are updating.key_group_config
: The key group configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the key group that you are updating. The version is the key group’s ETag value.
Main.Cloudfront.update_origin_request_policy2020_05_31
— Methodupdate_origin_request_policy2020_05_31(id, origin_request_policy_config)
update_origin_request_policy2020_05_31(id, origin_request_policy_config, params::Dict{String,<:Any})
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.
Arguments
id
: The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s OriginRequestPolicyId field in the response to GetDistributionConfig.origin_request_policy_config
: An origin request policy configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The version of the origin request policy that you are updating. The version is returned in the origin request policy’s ETag field in the response to GetOriginRequestPolicyConfig.
Main.Cloudfront.update_public_key2020_05_31
— Methodupdate_public_key2020_05_31(id, public_key_config)
update_public_key2020_05_31(id, public_key_config, params::Dict{String,<:Any})
Update public key information. Note that the only value you can change is the comment.
Arguments
id
: The identifier of the public key that you are updating.public_key_config
: A public key configuration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.
Main.Cloudfront.update_realtime_log_config2020_05_31
— Methodupdate_realtime_log_config2020_05_31()
update_realtime_log_config2020_05_31(params::Dict{String,<:Any})
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. You cannot update a real-time log configuration’s Name or ARN.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ARN"
: The Amazon Resource Name (ARN) for this real-time log configuration."EndPoints"
: Contains information about the Amazon Kinesis data stream where you are sending real-time log data."Fields"
: A list of fields to include in each real-time log record. For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide."Name"
: The name for this real-time log configuration."SamplingRate"
: The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
Main.Cloudfront.update_streaming_distribution2020_05_31
— Methodupdate_streaming_distribution2020_05_31(id, streaming_distribution_config)
update_streaming_distribution2020_05_31(id, streaming_distribution_config, params::Dict{String,<:Any})
Update a streaming distribution.
Arguments
id
: The streaming distribution's id.streaming_distribution_config
: The streaming distribution's configuration information.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"If-Match"
: The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.