distributions_by_response_headers_policy_ids
Creates, updates, deletes, gets or lists a distributions_by_response_headers_policy_ids resource.
Overview
| Name | distributions_by_response_headers_policy_ids |
| Type | Resource |
| Id | aws.cloudfront.distributions_by_response_headers_policy_ids |
Fields
The following fields are returned by SELECT queries:
- list_distributions_by_response_headers_policy_id
| Name | Datatype | Description |
|---|---|---|
is_truncated | boolean | A flag that indicates whether more distribution IDs remain to be listed. If your results were truncated, you can make a subsequent request using the Marker request field to retrieve more distribution IDs in the list. |
items | string | Contains the distribution IDs in the list. |
marker | string | The value provided in the Marker request field. |
max_items | integer | The maximum number of distribution IDs requested. |
next_marker | string | Contains the value that you should use in the Marker field of a subsequent request to continue listing distribution IDs where you left off. |
quantity | integer | The total number of distribution IDs returned in the response. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_distributions_by_response_headers_policy_id | select | response_headers_policy_id, region | Marker, MaxItems | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
response_headers_policy_id | string | The ID of the response headers policy whose associated distribution IDs you want to list. |
Marker | string | 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 | string | The maximum number of distribution IDs that you want to get in the response. |
SELECT examples
- list_distributions_by_response_headers_policy_id
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.
SELECT
is_truncated,
items,
marker,
max_items,
next_marker,
quantity
FROM aws.cloudfront.distributions_by_response_headers_policy_ids
WHERE response_headers_policy_id = '{{ response_headers_policy_id }}' -- required
AND region = '{{ region }}' -- required
AND Marker = '{{ Marker }}'
AND MaxItems = '{{ MaxItems }}'
;