CloudFront / Client / get_cache_policy

get_cache_policy#

CloudFront.Client.get_cache_policy(**kwargs)#

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

response = client.get_cache_policy(
    Id='string'
)
Parameters:

Id (string) –

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

Return type:

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. 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 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 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 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 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 the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

            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 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 the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

            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 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 to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – Only the HTTP headers that are listed in the Headers 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 to none, any cookies that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – Only the cookies in viewer requests that are listed in the CookieNames 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 the CookieNames 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 to none, any query strings that are listed in an OriginRequestPolicy are included in origin requests.

              • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames 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 the QueryStringNames 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 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.

Exceptions