2023/02/22 - Amazon CloudFront - 5 updated api methods
Changes CloudFront now supports block lists in origin request policies so that you can forward all headers, cookies, or query string from viewer requests to the origin *except* for those specified in the block list.
{'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}
Response {'OriginRequestPolicy': {'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}}
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find a valid object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
See also: AWS API Documentation
Request Syntax
client.create_origin_request_policy(
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',
]
}
}
}
)
dict
[REQUIRED]
An origin request policy configuration.
Comment (string) --
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
Name (string) -- [REQUIRED]
A unique name to identify the origin request policy.
HeadersConfig (dict) -- [REQUIRED]
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
HeaderBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
(string) --
CookiesConfig (dict) -- [REQUIRED]
The cookies from viewer requests to include in origin requests.
CookieBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
(string) --
QueryStringsConfig (dict) -- [REQUIRED]
The URL query strings from viewer requests to include in origin requests.
QueryStringBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of query string names in the Items list.
Items (list) --
A list of query string names.
(string) --
dict
Response Syntax
{
'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',
]
}
}
}
},
'Location': 'string',
'ETag': 'string'
}
Response Structure
(dict) --
OriginRequestPolicy (dict) --
An 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) --
Location (string) --
The fully qualified URI of the origin request policy just created.
ETag (string) --
The current version of the origin request policy.
{'OriginRequestPolicy': {'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}}
Gets an origin request policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
See also: AWS API Documentation
Request Syntax
client.get_origin_request_policy(
Id='string'
)
string
[REQUIRED]
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
dict
Response Syntax
{
'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',
]
}
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
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) --
ETag (string) --
The current version of the origin request policy.
{'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the policy's identifier. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
See also: AWS API Documentation
Request Syntax
client.get_origin_request_policy_config(
Id='string'
)
string
[REQUIRED]
The unique identifier for the origin request policy. If the origin request policy is attached to a distribution's cache behavior, you can get the policy's identifier using ListDistributions or GetDistribution. If the origin request policy is not attached to a cache behavior, you can get the identifier using ListOriginRequestPolicies.
dict
Response Syntax
{
'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',
]
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
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) --
ETag (string) --
The current version of the origin request policy.
{'OriginRequestPolicyList': {'Items': {'OriginRequestPolicy': {'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}}}}
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
client.list_origin_request_policies(
Type='managed'|'custom',
Marker='string',
MaxItems='string'
)
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.
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.
string
The maximum number of origin request policies that you want in the response.
dict
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) --
{'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}
Response {'OriginRequestPolicy': {'OriginRequestPolicyConfig': {'CookiesConfig': {'CookieBehavior': {'allExcept'}},
'HeadersConfig': {'HeaderBehavior': {'allExcept'}},
'QueryStringsConfig': {'QueryStringBehavior': {'allExcept'}}}}}
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use GetOriginRequestPolicyConfig to get the current configuration.
Locally modify the fields in the origin request policy configuration that you want to update.
Call UpdateOriginRequestPolicy by providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
See also: AWS API Documentation
Request Syntax
client.update_origin_request_policy(
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',
]
}
}
},
Id='string',
IfMatch='string'
)
dict
[REQUIRED]
An origin request policy configuration.
Comment (string) --
A comment to describe the origin request policy. The comment cannot be longer than 128 characters.
Name (string) -- [REQUIRED]
A unique name to identify the origin request policy.
HeadersConfig (dict) -- [REQUIRED]
The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront.
HeaderBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of header names in the Items list.
Items (list) --
A list of HTTP header names.
(string) --
CookiesConfig (dict) -- [REQUIRED]
The cookies from viewer requests to include in origin requests.
CookieBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of cookie names in the Items list.
Items (list) --
A list of cookie names.
(string) --
QueryStringsConfig (dict) -- [REQUIRED]
The URL query strings from viewer requests to include in origin requests.
QueryStringBehavior (string) -- [REQUIRED]
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) -- [REQUIRED]
The number of query string names in the Items list.
Items (list) --
A list of query string names.
(string) --
string
[REQUIRED]
The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior's OriginRequestPolicyId field in the response to GetDistributionConfig.
string
The version of the origin request policy that you are updating. The version is returned in the origin request policy's ETag field in the response to GetOriginRequestPolicyConfig.
dict
Response Syntax
{
'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',
]
}
}
}
},
'ETag': 'string'
}
Response Structure
(dict) --
OriginRequestPolicy (dict) --
An 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) --
ETag (string) --
The current version of the origin request policy.