CloudFront / Client / list_cache_policies
list_cache_policies#
- CloudFront.Client.list_cache_policies(**kwargs)#
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 theMarker
value in the subsequent request.See also: AWS API Documentation
Request Syntax
response = client.list_cache_policies( Type='managed'|'custom', Marker='string', MaxItems='string' )
- Parameters:
Type (string) –
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 (string) – 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 (string) – The maximum number of cache policies that you want in the response.
- Return type:
dict
- Returns:
Response Syntax
{ 'CachePolicyList': { 'NextMarker': 'string', 'MaxItems': 123, 'Quantity': 123, 'Items': [ { 'Type': 'managed'|'custom', 'CachePolicy': { 'Id': 'string', 'LastModifiedTime': datetime(2015, 1, 1), 'CachePolicyConfig': { 'Comment': 'string', 'Name': 'string', 'DefaultTTL': 123, 'MaxTTL': 123, 'MinTTL': 123, 'ParametersInCacheKeyAndForwardedToOrigin': { 'EnableAcceptEncodingGzip': True|False, 'EnableAcceptEncodingBrotli': True|False, 'HeadersConfig': { 'HeaderBehavior': 'none'|'whitelist', 'Headers': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'CookiesConfig': { 'CookieBehavior': 'none'|'whitelist'|'allExcept'|'all', 'Cookies': { 'Quantity': 123, 'Items': [ 'string', ] } }, 'QueryStringsConfig': { 'QueryStringBehavior': 'none'|'whitelist'|'allExcept'|'all', 'QueryStrings': { 'Quantity': 123, 'Items': [ 'string', ] } } } } } }, ] } }
Response Structure
(dict) –
CachePolicyList (dict) –
A list of cache policies.
NextMarker (string) –
If there are more items in the list than are in this response, this element is present. It contains the value that you should use in the
Marker
field of a subsequent request to continue listing cache policies where you left off.MaxItems (integer) –
The maximum number of cache policies requested.
Quantity (integer) –
The total number of cache policies returned in the response.
Items (list) –
Contains the cache policies in the list.
(dict) –
Contains a cache policy.
Type (string) –
The type of cache policy, either
managed
(created by Amazon Web Services) orcustom
(created in this Amazon Web Services account).CachePolicy (dict) –
The cache policy.
Id (string) –
The unique identifier for the cache policy.
LastModifiedTime (datetime) –
The date and time when the cache policy was last modified.
CachePolicyConfig (dict) –
The cache policy configuration.
Comment (string) –
A comment to describe the cache policy. The comment cannot be longer than 128 characters.
Name (string) –
A unique name to identify the cache policy.
DefaultTTL (integer) –
The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object’s time to live (TTL) only when the origin does not send
Cache-Control
orExpires
headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.The default value for this field is 86400 seconds (one day). If the value of
MinTTL
is more than 86400 seconds, then the default value for this field is the same as the value ofMinTTL
.MaxTTL (integer) –
The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends
Cache-Control
orExpires
headers with the object. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.The default value for this field is 31536000 seconds (one year). If the value of
MinTTL
orDefaultTTL
is more than 31536000 seconds, then the default value for this field is the same as the value ofDefaultTTL
.MinTTL (integer) –
The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
ParametersInCacheKeyAndForwardedToOrigin (dict) –
The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
EnableAcceptEncodingGzip (boolean) –
A flag that can affect whether the
Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.This field is related to the
EnableAcceptEncodingBrotli
field. If one or both of these fields istrue
and the viewer request includes theAccept-Encoding
header, then CloudFront does the following:Normalizes the value of the viewer’s
Accept-Encoding
headerIncludes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to
true
, and this cache behavior also has an origin request policy attached, do not include theAccept-Encoding
header in the origin request policy. CloudFront always includes theAccept-Encoding
header in origin requests when the value of this field istrue
, so including this header in an origin request policy has no effect.If both of these fields are
false
, then CloudFront treats theAccept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually addAccept-Encoding
to the headers whitelist like any other HTTP header.EnableAcceptEncodingBrotli (boolean) –
A flag that can affect whether the
Accept-Encoding
HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.This field is related to the
EnableAcceptEncodingGzip
field. If one or both of these fields istrue
and the viewer request includes theAccept-Encoding
header, then CloudFront does the following:Normalizes the value of the viewer’s
Accept-Encoding
headerIncludes the normalized header in the cache key
Includes the normalized header in the request to the origin, if a request is necessary
For more information, see Compression support in the Amazon CloudFront Developer Guide.
If you set this value to
true
, and this cache behavior also has an origin request policy attached, do not include theAccept-Encoding
header in the origin request policy. CloudFront always includes theAccept-Encoding
header in origin requests when the value of this field istrue
, so including this header in an origin request policy has no effect.If both of these fields are
false
, then CloudFront treats theAccept-Encoding
header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually addAccept-Encoding
to the headers whitelist like any other HTTP header.HeadersConfig (dict) –
An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
HeaderBehavior (string) –
Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none
– No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set tonone
, any headers that are listed in anOriginRequestPolicy
are included in origin requests.whitelist
– Only the HTTP headers that are listed in theHeaders
type are included in the cache key and in requests that CloudFront sends to the origin.
Headers (dict) –
Contains a list of HTTP header names.
Quantity (integer) –
The number of header names in the
Items
list.Items (list) –
A list of HTTP header names.
(string) –
CookiesConfig (dict) –
An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
CookieBehavior (string) –
Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none
– No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set tonone
, any cookies that are listed in anOriginRequestPolicy
are included in origin requests.whitelist
– Only the cookies in viewer requests that are listed in theCookieNames
type are included in the cache key and in requests that CloudFront sends to the origin.allExcept
– All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except for those that are listed in theCookieNames
type, which are not included.all
– All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
Cookies (dict) –
Contains a list of cookie names.
Quantity (integer) –
The number of cookie names in the
Items
list.Items (list) –
A list of cookie names.
(string) –
QueryStringsConfig (dict) –
An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
QueryStringBehavior (string) –
Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
none
– No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set tonone
, any query strings that are listed in anOriginRequestPolicy
are included in origin requests.whitelist
– Only the query strings in viewer requests that are listed in theQueryStringNames
type are included in the cache key and in requests that CloudFront sends to the origin.allExcept
– All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in theQueryStringNames
type, which are not included.all
– All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
QueryStrings (dict) –
Contains the specific query strings in viewer requests that either are or are not included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the
QueryStringBehavior
field in theCachePolicyQueryStringsConfig
type is set towhitelist
(the listed query strings are included) orallExcept
(the listed query strings are not included, but all other query strings are).Quantity (integer) –
The number of query string names in the
Items
list.Items (list) –
A list of query string names.
(string) –
Exceptions
CloudFront.Client.exceptions.AccessDenied
CloudFront.Client.exceptions.NoSuchCachePolicy
CloudFront.Client.exceptions.InvalidArgument