CloudFront / Client / list_origin_request_policies

list_origin_request_policies#

CloudFront.Client.list_origin_request_policies(**kwargs)#

Gets a list of origin request policies.

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.

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

See also: AWS API Documentation

Request Syntax

response = client.list_origin_request_policies(
    Type='managed'|'custom',
    Marker='string',
    MaxItems='string'
)
Parameters:

  • Type (string) –

    A filter to return only the specified kinds of origin request policies. Valid values are:

    • managed – Returns only the managed policies created by Amazon Web Services.

    • custom – Returns only the custom policies created in your Amazon Web Services account.

  • Marker (string) – Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.

  • MaxItems (string) – The maximum number of origin request policies that you want in the response.

Return type:

dict

Returns:

Response Syntax

{
    'OriginRequestPolicyList': {
        'NextMarker': 'string',
        'MaxItems': 123,
        'Quantity': 123,
        'Items': [
            {
                'Type': 'managed'|'custom',
                'OriginRequestPolicy': {
                    'Id': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'OriginRequestPolicyConfig': {
                        'Comment': 'string',
                        'Name': 'string',
                        'HeadersConfig': {
                            'HeaderBehavior': 'none'|'whitelist'|'allViewer'|'allViewerAndWhitelistCloudFront'|'allExcept',
                            'Headers': {
                                'Quantity': 123,
                                'Items': [
                                    'string',
                                ]
                            }
                        },
                        'CookiesConfig': {
                            'CookieBehavior': 'none'|'whitelist'|'all'|'allExcept',
                            'Cookies': {
                                'Quantity': 123,
                                'Items': [
                                    'string',
                                ]
                            }
                        },
                        'QueryStringsConfig': {
                            'QueryStringBehavior': 'none'|'whitelist'|'all'|'allExcept',
                            'QueryStrings': {
                                'Quantity': 123,
                                'Items': [
                                    'string',
                                ]
                            }
                        }
                    }
                }
            },
        ]
    }
}

Response Structure

  • (dict) –

    • OriginRequestPolicyList (dict) –

      A list of origin request 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 origin request policies where you left off.

      • MaxItems (integer) –

        The maximum number of origin request policies requested.

      • Quantity (integer) –

        The total number of origin request policies returned in the response.

      • Items (list) –

        Contains the origin request policies in the list.

        • (dict) –

          Contains an origin request policy.

          • Type (string) –

            The type of origin request policy, either managed (created by Amazon Web Services) or custom (created in this Amazon Web Services account).

          • OriginRequestPolicy (dict) –

            The origin request policy.

            • Id (string) –

              The unique identifier for the origin request policy.

            • LastModifiedTime (datetime) –

              The date and time when the origin request policy was last modified.

            • OriginRequestPolicyConfig (dict) –

              The origin request policy configuration.

              • Comment (string) –

                A comment to describe the origin request policy. The comment cannot be longer than 128 characters.

              • Name (string) –

                A unique name to identify the origin request policy.

              • HeadersConfig (dict) –

                The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.

                • HeaderBehavior (string) –

                  Determines whether any HTTP headers are included in requests that CloudFront sends to the origin. Valid values are:

                  • none – No HTTP headers in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in a CachePolicy are included in origin requests.

                  • whitelist – Only the HTTP headers that are listed in the Headers type are included in requests that CloudFront sends to the origin.

                  • allViewer – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin.

                  • allViewerAndWhitelistCloudFront – All HTTP headers in viewer requests and the additional CloudFront headers that are listed in the Headers type are included in requests that CloudFront sends to the origin. The additional headers are added by CloudFront.

                  • allExcept – All HTTP headers in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the Headers type, which are not included.

                • 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) –

                The cookies from viewer requests to include in origin requests.

                • CookieBehavior (string) –

                  Determines whether cookies in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

                  • none – No cookies in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any cookies that are listed in a CachePolicy are included in origin requests.

                  • whitelist – Only the cookies in viewer requests that are listed in the CookieNames type are included in requests that CloudFront sends to the origin.

                  • all – All cookies in viewer requests are included in requests that CloudFront sends to the origin.

                  • allExcept – All cookies in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the CookieNames type, which are not included.

                • 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) –

                The URL query strings from viewer requests to include in origin requests.

                • QueryStringBehavior (string) –

                  Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

                  • none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

                  • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

                  • all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

                  • allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

                • QueryStrings (dict) –

                  Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig 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) –

Exceptions