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.
Parameters:
-
type
(Optional[OriginRequestPolicyType], default:
None
)
–
A filter to return only the specified kinds of origin request policies. Valid values are:
-
marker
(Optional[string], default:
None
)
–
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.
-
max_items
(Optional[integer], default:
None
)
–
The maximum number of origin request policies that you want in the response.
Raises:
Source code in docs_src/capo_cloudfront/_services/cloud_front.py
| def list_origin_request_policies(
self,
*,
config_overrides: Optional[CloudFrontClientConfig] = None,
type: Optional[
"capo_cloudfront.types.origin_request_policy_type.OriginRequestPolicyType"
] = None,
marker: Optional["capo_cloudfront.types.string.string"] = None,
max_items: Optional["capo_cloudfront.types.integer.integer"] = None,
) -> "capo_cloudfront.types.list_origin_request_policies_result.ListOriginRequestPoliciesResult":
"""<p>Gets a list of origin request policies.</p> <p>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.</p> <p>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 <code>NextMarker</code> value from the current response as the <code>Marker</code> value in the subsequent request.</p>
Args:
type: <p>A filter to return only the specified kinds of origin request policies. Valid values are:</p> <ul> <li> <p> <code>managed</code> – Returns only the managed policies created by Amazon Web Services.</p> </li> <li> <p> <code>custom</code> – Returns only the custom policies created in your Amazon Web Services account.</p> </li> </ul>
marker: <p>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 <code>NextMarker</code> from the current page's response.</p>
max_items: <p>The maximum number of origin request policies that you want in the response.</p>
Raises:
capo_cloudfront.errors.access_denied.AccessDenied: <p>Access denied.</p>
capo_cloudfront.errors.invalid_argument.InvalidArgument: <p>An argument is invalid.</p>
capo_cloudfront.errors.no_such_origin_request_policy.NoSuchOriginRequestPolicy: <p>The origin request policy does not exist.</p>
capo_cloudfront.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudfront.types.list_origin_request_policies_request.ListOriginRequestPoliciesRequest]",
) -> OperationResponse[
"capo_cloudfront.types.list_origin_request_policies_result.ListOriginRequestPoliciesResult"
]:
import capo_cloudfront._operations.cloudfront2020_05_31.list_origin_request_policies
output, http_response = (
capo_cloudfront._operations.cloudfront2020_05_31.list_origin_request_policies.list_origin_request_policies(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListOriginRequestPolicies")
)
input_: capo_cloudfront.types.list_origin_request_policies_request.ListOriginRequestPoliciesRequest = {}
if type is not None:
input_["type"] = type
if marker is not None:
input_["marker"] = marker
if max_items is not None:
input_["max_items"] = max_items
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|