AWS API Changes

2020/09/10 - Amazon CloudFront - 5 updated api methods

Changes Cloudfront adds support for Brotli. You can enable brotli caching and compression support by enabling it in your Cache Policy.

CreateCachePolicy (updated)

Link ¶
Changes (request, response)
Request

{'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}

Response

{'CachePolicy': {'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}}

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 .

See also: AWS API Documentation

Request Syntax

client.create_cache_policy(
    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',
                    ]
                }
            }
        }
    }
)

type CachePolicyConfig

dict

param CachePolicyConfig

[REQUIRED]

A cache policy configuration.

Comment (string) --

A comment to describe the cache policy.
Name (string) -- [REQUIRED]

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 or Expires 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 of MinTTL .
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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
MinTTL (integer) -- [REQUIRED]

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 automatically included in requests that CloudFront sends to the origin.
- EnableAcceptEncodingGzip (boolean) -- [REQUIRED]
  
  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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
  - Normalizes the value of the viewer’s Accept-Encoding header
  - Includes the normalized header in the cache key
  - Includes the normalized header in the request to the origin
  If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
  
  For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
  
  If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
  - Normalizes the value of the viewer’s Accept-Encoding header
  - Includes the normalized header in the cache key
  - Includes the normalized header in the request to the origin
  If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
  
  For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
  
  If both of these fields are false , then CloudFront treats the Accept-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 add Accept-Encoding to the headers whitelist like any other HTTP header.
- HeadersConfig (dict) -- [REQUIRED]
  
  An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - HeaderBehavior (string) -- [REQUIRED]
    
    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
  - Headers (dict) --
    
    Contains a list of HTTP header names.
    - Quantity (integer) -- [REQUIRED]
      
      The number of header names in the Items list.
    - Items (list) --
      
      A list of HTTP header names.
      - (string) --
- CookiesConfig (dict) -- [REQUIRED]
  
  An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - CookieBehavior (string) -- [REQUIRED]
    
    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
  - Cookies (dict) --
    
    Contains a list of cookie names.
    - Quantity (integer) -- [REQUIRED]
      
      The number of cookie names in the Items list.
    - Items (list) --
      
      A list of cookie names.
      - (string) --
- QueryStringsConfig (dict) -- [REQUIRED]
  
  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 automatically included in requests that CloudFront sends to the origin.
  - QueryStringBehavior (string) -- [REQUIRED]
    
    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
    - Quantity (integer) -- [REQUIRED]
      
      The number of query string names in the Items list.
    - Items (list) --
      
      A list of query string names.
      - (string) --

rtype

dict

returns

Response Syntax

{
    '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',
                        ]
                    }
                }
            }
        }
    },
    'Location': 'string',
    'ETag': 'string'
}

Response Structure

(dict) --
- CachePolicy (dict) --
  
  A 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.
    - 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 or Expires 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 of MinTTL .
    - 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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
    - 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 automatically 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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 automatically included in requests that CloudFront sends to the origin.
        
        HeaderBehavior (string) --
        
        Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin.
        
        CookieBehavior (string) --
        
        Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All cookies in viewer requests are included in the cache key and are automatically included 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 automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (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) --
- Location (string) --
  
  The fully qualified URI of the cache policy just created.
- ETag (string) --
  
  The current version of the cache policy.

GetCachePolicy (updated)

Link ¶
Changes (response)

{'CachePolicy': {'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}}

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 .

See also: AWS API Documentation

Request Syntax

client.get_cache_policy(
    Id='string'
)

type Id

string

param Id

[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 .

rtype

dict

returns

Response Syntax

{
    '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',
                        ]
                    }
                }
            }
        }
    },
    'ETag': 'string'
}

Response Structure

(dict) --
- 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.
    - 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 or Expires 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 of MinTTL .
    - 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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
    - 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 automatically 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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 automatically included in requests that CloudFront sends to the origin.
        
        HeaderBehavior (string) --
        
        Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin.
        
        CookieBehavior (string) --
        
        Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All cookies in viewer requests are included in the cache key and are automatically included 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 automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (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) --
- ETag (string) --
  
  The current version of the cache policy.

GetCachePolicyConfig (updated)

Link ¶
Changes (response)

{'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}

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 .

See also: AWS API Documentation

Request Syntax

client.get_cache_policy_config(
    Id='string'
)

type Id

string

param Id

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    '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',
                    ]
                }
            }
        }
    },
    'ETag': 'string'
}

Response Structure

(dict) --
- CachePolicyConfig (dict) --
  
  The cache policy configuration.
  - Comment (string) --
    
    A comment to describe the cache policy.
  - 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 or Expires 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 of MinTTL .
  - 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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
  - 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 automatically 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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
      - Normalizes the value of the viewer’s Accept-Encoding header
      - Includes the normalized header in the cache key
      - Includes the normalized header in the request to the origin
      If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
      
      For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
      
      If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
      - Normalizes the value of the viewer’s Accept-Encoding header
      - Includes the normalized header in the cache key
      - Includes the normalized header in the request to the origin
      If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
      
      For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
      
      If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 automatically included in requests that CloudFront sends to the origin.
      - HeaderBehavior (string) --
        
        Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin.
      - CookieBehavior (string) --
        
        Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All cookies in viewer requests are included in the cache key and are automatically included 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 automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (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) --
- ETag (string) --
  
  The current version of the cache policy.

ListCachePolicies (updated)

Link ¶
Changes (response)

{'CachePolicyList': {'Items': {'CachePolicy': {'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}}}}

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.

See also: AWS API Documentation

Request Syntax

client.list_cache_policies(
    Type='managed'|'custom',
    Marker='string',
    MaxItems='string'
)

type Type

string

param 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.

type Marker

string

param 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.

type MaxItems

string

param MaxItems

The maximum number of cache policies that you want in the response.

rtype

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 AWS) or custom (created in this AWS 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.
        
        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 or Expires 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 of MinTTL .
        
        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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
        
        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 automatically 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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 automatically included in requests that CloudFront sends to the origin.
        
        HeaderBehavior (string) --
        
        Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin.
        
        CookieBehavior (string) --
        
        Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All cookies in viewer requests are included in the cache key and are automatically included 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 automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (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) --

UpdateCachePolicy (updated)

Link ¶
Changes (request, response)
Request

{'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}

Response

{'CachePolicy': {'CachePolicyConfig': {'ParametersInCacheKeyAndForwardedToOrigin': {'EnableAcceptEncodingBrotli': 'boolean'}}}}

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.

See also: AWS API Documentation

Request Syntax

client.update_cache_policy(
    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',
                    ]
                }
            }
        }
    },
    Id='string',
    IfMatch='string'
)

type CachePolicyConfig

dict

param CachePolicyConfig

[REQUIRED]

A cache policy configuration.

Comment (string) --

A comment to describe the cache policy.
Name (string) -- [REQUIRED]

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 or Expires 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 of MinTTL .
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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
MinTTL (integer) -- [REQUIRED]

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 automatically included in requests that CloudFront sends to the origin.
- EnableAcceptEncodingGzip (boolean) -- [REQUIRED]
  
  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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
  - Normalizes the value of the viewer’s Accept-Encoding header
  - Includes the normalized header in the cache key
  - Includes the normalized header in the request to the origin
  If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
  
  For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
  
  If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
  - Normalizes the value of the viewer’s Accept-Encoding header
  - Includes the normalized header in the cache key
  - Includes the normalized header in the request to the origin
  If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
  
  For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
  
  If both of these fields are false , then CloudFront treats the Accept-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 add Accept-Encoding to the headers whitelist like any other HTTP header.
- HeadersConfig (dict) -- [REQUIRED]
  
  An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - HeaderBehavior (string) -- [REQUIRED]
    
    Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
  - Headers (dict) --
    
    Contains a list of HTTP header names.
    - Quantity (integer) -- [REQUIRED]
      
      The number of header names in the Items list.
    - Items (list) --
      
      A list of HTTP header names.
      - (string) --
- CookiesConfig (dict) -- [REQUIRED]
  
  An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and automatically included in requests that CloudFront sends to the origin.
  - CookieBehavior (string) -- [REQUIRED]
    
    Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - all – All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.
  - Cookies (dict) --
    
    Contains a list of cookie names.
    - Quantity (integer) -- [REQUIRED]
      
      The number of cookie names in the Items list.
    - Items (list) --
      
      A list of cookie names.
      - (string) --
- QueryStringsConfig (dict) -- [REQUIRED]
  
  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 automatically included in requests that CloudFront sends to the origin.
  - QueryStringBehavior (string) -- [REQUIRED]
    
    Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
    - none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
    - whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
    - all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (the listed query strings * are not * included, but all other query strings are).
    - Quantity (integer) -- [REQUIRED]
      
      The number of query string names in the Items list.
    - Items (list) --
      
      A list of query string names.
      - (string) --

type Id

string

param Id

[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 .

type IfMatch

string

param IfMatch

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 .

rtype

dict

returns

Response Syntax

{
    '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',
                        ]
                    }
                }
            }
        }
    },
    'ETag': 'string'
}

Response Structure

(dict) --
- CachePolicy (dict) --
  
  A 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.
    - 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 or Expires 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 of MinTTL .
    - 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 or Expires 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 or DefaultTTL is more than 31536000 seconds, then the default value for this field is the same as the value of DefaultTTL .
    - 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 automatically 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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:
        
        Normalizes the value of the viewer’s Accept-Encoding header
        
        Includes the normalized header in the cache key
        
        Includes the normalized header in the request to the origin
        
        If one or both of these fields are true , you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.
        
        For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide .
        
        If both of these fields are false , then CloudFront treats the Accept-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 add Accept-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 automatically included in requests that CloudFront sends to the origin.
        
        HeaderBehavior (string) --
        
        Determines whether any HTTP headers are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any headers that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The HTTP headers that are listed in the Headers type are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin.
        
        CookieBehavior (string) --
        
        Determines whether any cookies in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any cookies that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The cookies in viewer requests that are listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All cookies in viewer requests that are * not * listed in the CookieNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All cookies in viewer requests are included in the cache key and are automatically included 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 automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:
        
        none – Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin. Even when this field is set to none , any query strings that are listed in an OriginRequestPolicy are included in origin requests.
        
        whitelist – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        allExcept – All query strings in viewer requests that are * not * listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.
        
        all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings * are * included) or allExcept (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) --
- ETag (string) --
  
  The current version of the cache policy.