/2020-05-31/streaming-distribution/{Id}/config

Update a streaming distribution.

• Id (path, required) — The streaming distribution's id.
• If-Match (header) — The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL .

/2020-05-31/origin-access-identity/cloudfront

Lists origin access identities.

• Marker (query) — 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 (query) — The maximum number of origin access identities you want in the response body.

/2020-05-31/origin-access-control/{Id}

Deletes a CloudFront origin access control. You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.

• Id (path, required) — The unique identifier of the origin access control that you are deleting.
• If-Match (header) — The current version ( ETag value) of the origin access control that you are deleting.

/2020-05-31/origin-access-control/{Id}

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

• Id (path, required) — The unique identifier of the origin access control.

/2020-05-31/public-key/{Id}/config

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

• Id (path, required) — The identifier of the public key that you are updating.
• If-Match (header) — The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL .

/2020-05-31/continuous-deployment-policy

Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions. To use a continuous deployment policy, first use CopyDistribution to create a staging distribution, then use UpdateDistribution to modify the staging distribution's configuration. After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.

/2020-05-31/continuous-deployment-policy/{Id}

Deletes a continuous deployment policy. You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.

• Id (path, required) — The identifier of the continuous deployment policy that you are deleting.
• If-Match (header) — The current version ( ETag value) of the continuous deployment policy that you are deleting.

/2020-05-31/distribution/{TargetDistributionId}/associate-alias#Alias

Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution. With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution. To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide .

• TargetDistributionId (path, required) — The ID of the distribution that you're associating the alias with.
• Alias (query, required) — The alias (also known as a CNAME) to add to the target distribution.

/2020-05-31/distribution/{PrimaryDistributionId}/copy

Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow. After you create a staging distribution, you can use UpdateDistribution to modify the staging distribution's configuration. Then you can use CreateContinuousDeploymentPolicy to incrementally move traffic to the staging distribution.

• PrimaryDistributionId (path, required) — The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use ListDistributions .
• Staging (header) — The type of distribution that your primary distribution will be copied to. The only valid value is True , indicating that you are copying to a staging distribution.
• If-Match (header) — The version identifier of the primary distribution whose configuration you are copying. This is the ETag value returned in the response to GetDistribution and GetDistributionConfig .

/2020-05-31/cache-policy

Creates a cache policy. After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following: The values that CloudFront includes in the cache key . These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer. The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache. The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy . For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide .

/2020-05-31/cache-policy

Gets a list of cache policies. You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• Type (query) — A filter to return only the specified kinds of cache policies. Valid values are: managed – Returns only the managed policies created by Amazon Web Services. custom – Returns only the custom policies created in your Amazon Web Services account.
• Marker (query) — 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 (query) — The maximum number of cache policies that you want in the response.

/2020-05-31/origin-access-identity/cloudfront

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 .

/2020-05-31/continuous-deployment-policy

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

• Marker (query) — Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes 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 (query) — The maximum number of continuous deployment policies that you want returned in the response.

/2020-05-31/distribution

Creates a CloudFront distribution.

/2020-05-31/distribution

List CloudFront distributions.

• Marker (query) — 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 (query) — The maximum number of distributions you want in the response body.

/2020-05-31/distribution#WithTags

Create a new distribution with tags.

• WithTags (query, required)

/2020-05-31/field-level-encryption

Create a new field-level encryption configuration.

/2020-05-31/field-level-encryption

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

• Marker (query) — 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 (query) — The maximum number of field-level encryption configurations you want in the response body.

/2020-05-31/field-level-encryption-profile

Create a field-level encryption profile.

/2020-05-31/field-level-encryption-profile

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

• Marker (query) — 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 (query) — The maximum number of field-level encryption profiles you want in the response body.

/2020-05-31/function

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.

/2020-05-31/function

Gets a list of all CloudFront functions in your Amazon Web Services account. You can optionally apply a filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE . You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• Marker (query) — 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 (query) — The maximum number of functions that you want in the response.
• Stage (query) — An optional filter to return only the functions that are in the specified stage, either DEVELOPMENT or LIVE .

/2020-05-31/distribution/{DistributionId}/invalidation

Create a new invalidation.

• DistributionId (path, required) — The distribution's id.

/2020-05-31/continuous-deployment-policy/{Id}

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

• Id (path, required) — The identifier of the continuous deployment policy that you are getting.

/2020-05-31/distribution/{DistributionId}/invalidation

Lists invalidation batches.

• DistributionId (path, required) — The distribution's ID.
• Marker (query) — 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 (query) — The maximum number of invalidation batches that you want in the response body.

/2020-05-31/key-group

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 .

/2020-05-31/key-group

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.

• Marker (query) — 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 (query) — The maximum number of key groups that you want in the response.

/2020-05-31/distributions/{DistributionId}/monitoring-subscription/

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 .

• DistributionId (path, required) — The ID of the distribution that you are enabling metrics for.

/2020-05-31/distributions/{DistributionId}/monitoring-subscription/

Disables additional CloudWatch metrics for the specified CloudFront distribution.

• DistributionId (path, required) — The ID of the distribution that you are disabling metrics for.

/2020-05-31/distributions/{DistributionId}/monitoring-subscription/

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

• DistributionId (path, required) — The ID of the distribution that you are getting metrics information for.

/2020-05-31/origin-access-control

Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin. This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide .

/2020-05-31/origin-access-control

Gets the list of CloudFront origin access controls in this Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send another request that specifies the NextMarker value from the current response as the Marker value in the next request.

• Marker (query) — Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items 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 (query) — The maximum number of origin access controls that you want in the response.

/2020-05-31/key-group/{Id}

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.

• Id (path, required) — The identifier of the key group that you are updating.
• If-Match (header) — The version of the key group that you are updating. The version is the key group's ETag value.

/2020-05-31/origin-request-policy

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 .

/2020-05-31/origin-request-policy

Gets a list of origin request policies. You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• Type (query) — A filter to return only the specified kinds of origin request policies. Valid values are: managed – Returns only the managed policies created by Amazon Web Services. custom – Returns only the custom policies created in your Amazon Web Services account.
• Marker (query) — 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 (query) — The maximum number of origin request policies that you want in the response.

/2020-05-31/public-key

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

/2020-05-31/public-key

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

• Marker (query) — 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 (query) — The maximum number of public keys you want in the response body.

/2020-05-31/realtime-log-config

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 .

/2020-05-31/realtime-log-config

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.

• MaxItems (query) — The maximum number of real-time log configurations that you want in the response.
• Marker (query) — 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.

/2020-05-31/response-headers-policy

Creates a response headers policy. A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers. After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy. For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide .

/2020-05-31/get-realtime-log-config/

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.

/2020-05-31/response-headers-policy

Gets a list of response headers policies. You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• Type (query) — A filter to get only the specified kind of response headers policies. Valid values are: managed – Gets only the managed policies created by Amazon Web Services. custom – Gets only the custom policies created in your Amazon Web Services account.
• Marker (query) — Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers 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 (query) — The maximum number of response headers policies that you want to get in the response.

/2020-05-31/streaming-distribution

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.

/2020-05-31/streaming-distribution

List streaming distributions.

• Marker (query) — The value that you provided for the Marker request parameter.
• MaxItems (query) — The value that you provided for the MaxItems request parameter.

/2020-05-31/streaming-distribution#WithTags

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.

• WithTags (query, required)

/2020-05-31/cache-policy/{Id}

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 .

• Id (path, required) — The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ListCachePolicies .
• If-Match (header) — 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 .

/2020-05-31/cache-policy/{Id}

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 .

• Id (path, required) — 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 .

/2020-05-31/cache-policy/{Id}

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.

• Id (path, required) — 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 .
• If-Match (header) — 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 .

/2020-05-31/origin-access-identity/cloudfront/{Id}

Delete an origin access identity.

• Id (path, required) — The origin access identity's ID.
• If-Match (header) — The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL .

/2020-05-31/origin-access-identity/cloudfront/{Id}

Get the information about an origin access identity.

• Id (path, required) — The identity's ID.

/2020-05-31/continuous-deployment-policy/{Id}

Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to. When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration: Use GetContinuousDeploymentPolicyConfig to get the current configuration. Locally modify the fields in the continuous deployment policy configuration that you want to update. Use UpdateContinuousDeploymentPolicy , providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.

• Id (path, required) — The identifier of the continuous deployment policy that you are updating.
• If-Match (header) — The current version ( ETag value) of the continuous deployment policy that you are updating.

/2020-05-31/distribution/{Id}

Delete a distribution.

• Id (path, required) — The distribution ID.
• If-Match (header) — The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL .

/2020-05-31/distribution/{Id}

Get the information about a distribution.

• Id (path, required) — The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

/2020-05-31/field-level-encryption/{Id}

Remove a field-level encryption configuration.

• Id (path, required) — The ID of the configuration you want to delete from CloudFront.
• If-Match (header) — The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL .

/2020-05-31/field-level-encryption/{Id}

Get the field-level encryption configuration information.

• Id (path, required) — Request the ID for the field-level encryption configuration information.

/2020-05-31/field-level-encryption-profile/{Id}

Remove a field-level encryption profile.

• Id (path, required) — Request the ID of the profile you want to delete from CloudFront.
• If-Match (header) — The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL .

/2020-05-31/field-level-encryption-profile/{Id}

Get the field-level encryption profile information.

• Id (path, required) — Get the ID for the field-level encryption profile information.

/2020-05-31/function/{Name}#If-Match

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 .

• Name (path, required) — The name of the function that you are deleting.
• If-Match (header, required) — The current version ( ETag value) of the function that you are deleting, which you can get using DescribeFunction .

/2020-05-31/function/{Name}#If-Match

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 .

• Name (path, required) — The name of the function that you are updating.
• If-Match (header, required) — The current version ( ETag value) of the function that you are updating, which you can get using DescribeFunction .

/2020-05-31/key-group/{Id}

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 .

• Id (path, required) — The identifier of the key group that you are deleting. To get the identifier, use ListKeyGroups .
• If-Match (header) — 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 .

/2020-05-31/key-group/{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 using ListDistributions or GetDistribution . If the key group is not referenced in a cache behavior, you can get the identifier using ListKeyGroups .

• Id (path, required) — The identifier of the key group that you are getting. To get the identifier, use ListKeyGroups .

/2020-05-31/origin-request-policy/{Id}

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 .

• Id (path, required) — The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ListOriginRequestPolicies .
• If-Match (header) — 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 .

/2020-05-31/origin-request-policy/{Id}

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 .

• Id (path, required) — 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 .

/2020-05-31/origin-request-policy/{Id}

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.

• Id (path, required) — 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 .
• If-Match (header) — 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 .

/2020-05-31/public-key/{Id}

Remove a public key you previously added to CloudFront.

• Id (path, required) — The ID of the public key you want to remove from CloudFront.
• If-Match (header) — The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL .

/2020-05-31/public-key/{Id}

Gets a public key.

• Id (path, required) — The identifier of the public key you are getting.

/2020-05-31/delete-realtime-log-config/

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.

/2020-05-31/response-headers-policy/{Id}

Deletes a response headers policy. You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy. To delete a response headers policy, you must provide the policy's identifier and version. To get these values, you can use ListResponseHeadersPolicies or GetResponseHeadersPolicy .

• Id (path, required) — The identifier for the response headers policy that you are deleting. To get the identifier, you can use ListResponseHeadersPolicies .
• If-Match (header) — The version of the response headers policy that you are deleting. The version is the response headers policy's ETag value, which you can get using ListResponseHeadersPolicies , GetResponseHeadersPolicy , or GetResponseHeadersPolicyConfig .

/2020-05-31/response-headers-policy/{Id}

Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified). To get a response headers policy, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .

• Id (path, required) — The identifier for the response headers policy. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .

/2020-05-31/response-headers-policy/{Id}

Updates a response headers policy. When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration: Use GetResponseHeadersPolicyConfig to get the current policy's configuration. Modify the fields in the response headers policy configuration that you want to update. Call UpdateResponseHeadersPolicy , providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.

• Id (path, required) — The identifier for the response headers policy that you are updating.
• If-Match (header) — The version of the response headers policy that you are updating. The version is returned in the cache policy's ETag field in the response to GetResponseHeadersPolicyConfig .

/2020-05-31/streaming-distribution/{Id}

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 .

• Id (path, required) — The distribution ID.
• If-Match (header) — The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL .

/2020-05-31/streaming-distribution/{Id}

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

• Id (path, required) — The streaming distribution's ID.

/2020-05-31/function/{Name}/describe

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 .

• Name (path, required) — The name of the function that you are getting information about.
• Stage (query) — The function's stage, either DEVELOPMENT or LIVE .

/2020-05-31/cache-policy/{Id}/config

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 .

• Id (path, required) — 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 .

/2020-05-31/origin-access-identity/cloudfront/{Id}/config

Get the configuration information about an origin access identity.

• Id (path, required) — The identity's ID.

/2020-05-31/origin-access-identity/cloudfront/{Id}/config

Update an origin access identity.

• Id (path, required) — The identity's id.
• If-Match (header) — The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL .

/2020-05-31/continuous-deployment-policy/{Id}/config

Gets configuration information about a continuous deployment policy.

• Id (path, required) — The identifier of the continuous deployment policy whose configuration you are getting.

/2020-05-31/distribution/{Id}/config

Get the configuration information about a distribution.

• Id (path, required) — The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

/2020-05-31/response-headers-policy/{Id}/config

Gets a response headers policy configuration. To get a response headers policy configuration, you must provide the policy's identifier. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .

• Id (path, required) — The identifier for the response headers policy. If the response headers policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution . If the response headers policy is not attached to a cache behavior, you can get the identifier using ListResponseHeadersPolicies .

/2020-05-31/streaming-distribution/{Id}/config

Get the configuration information about a streaming distribution.

• Id (path, required) — The streaming distribution's ID.

/2020-05-31/distribution/{Id}/config

Updates the configuration for a CloudFront distribution. The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates. To update a web distribution using the CloudFront API Use GetDistributionConfig to get the current configuration, including the version identifier ( ETag ). Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions: You must rename the ETag field to IfMatch , leaving the value unchanged. (Set the value of IfMatch to the value of ETag , then remove the ETag field.) You can't change the value of CallerReference . Submit an UpdateDistribution request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an UpdateDistribution request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.

• Id (path, required) — The distribution's id.
• If-Match (header) — The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL .

/2020-05-31/field-level-encryption/{Id}/config

Get the field-level encryption configuration information.

• Id (path, required) — Request the ID for the field-level encryption configuration information.

/2020-05-31/field-level-encryption/{Id}/config

Update a field-level encryption configuration.

• Id (path, required) — The ID of the configuration you want to update.
• If-Match (header) — The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL .

/2020-05-31/field-level-encryption-profile/{Id}/config

Get the field-level encryption profile configuration information.

• Id (path, required) — Get the ID for the field-level encryption profile configuration information.

/2020-05-31/field-level-encryption-profile/{Id}/config

Update a field-level encryption profile.

• Id (path, required) — The ID of the field-level encryption profile request.
• If-Match (header) — The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL .

/2020-05-31/function/{Name}

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 .

• Name (path, required) — The name of the function whose code you are getting.
• Stage (query) — The function's stage, either DEVELOPMENT or LIVE .

/2020-05-31/distribution/{DistributionId}/invalidation/{Id}

Get the information about an invalidation.

• DistributionId (path, required) — The distribution's ID.
• Id (path, required) — The identifier for the invalidation request, for example, IDFDVBD632BHDS5 .

/2020-05-31/key-group/{Id}/config

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 .

• Id (path, required) — The identifier of the key group whose configuration you are getting. To get the identifier, use ListKeyGroups .

/2020-05-31/origin-access-control/{Id}/config

Gets a CloudFront origin access control configuration.

• Id (path, required) — The unique identifier of the origin access control.

/2020-05-31/origin-access-control/{Id}/config

Updates a CloudFront origin access control.

• Id (path, required) — The unique identifier of the origin access control that you are updating.
• If-Match (header) — The current version ( ETag value) of the origin access control that you are updating.

/2020-05-31/origin-request-policy/{Id}/config

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 .

• Id (path, required) — 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 .

/2020-05-31/public-key/{Id}/config

Gets a public key configuration.

• Id (path, required) — The identifier of the public key whose configuration you are getting.

/2020-05-31/conflicting-alias#DistributionId&Alias

Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own. Use this operation to find aliases that are in use in CloudFront that conflict or overlap with the provided alias. For example, if you provide www.example.com as input, the returned list can include www.example.com and the overlapping wildcard alternate domain name ( *.example.com ), if they exist. If you provide *.example.com as input, the returned list can include *.example.com and any alternate domain names covered by that wildcard (for example, www.example.com , test.example.com , dev.example.com , and so on), if they exist. To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide . You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• DistributionId (query, required) — The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
• Alias (query, required) — The alias (also called a CNAME) to search for conflicting aliases.
• Marker (query) — Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases 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 (query) — The maximum number of conflicting aliases that you want in the response.

/2020-05-31/distributionsByCachePolicyId/{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 the NextMarker value from the current response as the Marker value in the subsequent request.

• Marker (query) — 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 (query) — The maximum number of distribution IDs that you want in the response.
• CachePolicyId (path, required) — The ID of the cache policy whose associated distribution IDs you want to list.

/2020-05-31/distributionsByKeyGroupId/{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 the NextMarker value from the current response as the Marker value in the subsequent request.

• Marker (query) — 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 (query) — The maximum number of distribution IDs that you want in the response.
• KeyGroupId (path, required) — The ID of the key group whose associated distribution IDs you are listing.

/2020-05-31/distributionsByOriginRequestPolicyId/{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 the NextMarker value from the current response as the Marker value in the subsequent request.

• Marker (query) — 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 (query) — The maximum number of distribution IDs that you want in the response.
• OriginRequestPolicyId (path, required) — The ID of the origin request policy whose associated distribution IDs you want to list.

/2020-05-31/distributionsByRealtimeLogConfig/

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.

/2020-05-31/realtime-log-config/

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 .

/2020-05-31/distributionsByResponseHeadersPolicyId/{ResponseHeadersPolicyId}

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

• Marker (query) — 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 (query) — The maximum number of distribution IDs that you want to get in the response.
• ResponseHeadersPolicyId (path, required) — The ID of the response headers policy whose associated distribution IDs you want to list.

/2020-05-31/distributionsByWebACLId/{WebACLId}

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

• Marker (query) — 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 (query) — The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
• WebACLId (path, required) — The ID of the 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.

/2020-05-31/tagging#Resource

List tags for a CloudFront resource.

• Resource (query, required) — An ARN of a CloudFront resource.

/2020-05-31/function/{Name}/publish#If-Match

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 .

• Name (path, required) — The name of the function that you are publishing.
• If-Match (header, required) — The current version ( ETag value) of the function that you are publishing, which you can get using DescribeFunction .

/2020-05-31/tagging#Operation=Tag&Resource

Add tags to a CloudFront resource.

• Resource (query, required) — An ARN of a CloudFront resource.
• Operation (query, required)

/2020-05-31/function/{Name}/test#If-Match

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 .

• Name (path, required) — The name of the function that you are testing.
• If-Match (header, required) — The current version ( ETag value) of the function that you are testing, which you can get using DescribeFunction .

/2020-05-31/tagging#Operation=Untag&Resource

Remove tags from a CloudFront resource.

• Resource (query, required) — An ARN of a CloudFront resource.
• Operation (query, required)

/2020-05-31/distribution/{Id}/promote-staging-config

Copies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases (also known as alternate domain names or CNAMEs) and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution. You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.

• Id (path, required) — The identifier of the primary distribution to which you are copying a staging distribution's configuration.
• StagingDistributionId (query) — The identifier of the staging distribution whose configuration you are copying to the primary distribution.
• If-Match (header) — The current versions ( ETag values) of both primary and staging distributions. Provide these in the following format: <primary ETag>, <staging ETag>