Skip to content

CloudFront  >  Operations  >  list_response_headers_policies

list_response_headers_policies

Operation

list_response_headers_policies async

list_response_headers_policies(request: ListResponseHeadersPoliciesInput | ListResponseHeadersPoliciesInputDict, /, *, plugins: list[Plugin] | None = None) -> ListResponseHeadersPoliciesOutput
list_response_headers_policies(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListResponseHeadersPoliciesInputDict]) -> ListResponseHeadersPoliciesOutput

Gets a list of response headers policies.

You can optionally apply a filter to get 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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ListResponseHeadersPoliciesOutput

An instance of ListResponseHeadersPoliciesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ListResponseHeadersPoliciesInput dataclass

Bases: _SerdeShape

Dataclass for ListResponseHeadersPoliciesInput structure.

Attributes
marker class-attribute instance-attribute
marker: str | None = ...

Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers 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 class-attribute instance-attribute
max_items: int | None = ...

The maximum number of response headers policies that you want to get in the response.

type class-attribute instance-attribute
type: str | None = ...

A filter to get only the specified kind of response headers policies. Valid values are:

  • managed -- Gets only the managed policies created by Amazon Web Services.

  • custom -- Gets only the custom policies created in your Amazon Web Services account.

Dictionaries

ListResponseHeadersPoliciesInputDict

Bases: TypedDict

Dictionary form of ListResponseHeadersPoliciesInput.

Attributes
marker instance-attribute
marker: str | None

Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers 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 instance-attribute
max_items: int | None

The maximum number of response headers policies that you want to get in the response.

type instance-attribute
type: str | None

A filter to get only the specified kind of response headers policies. Valid values are:

  • managed -- Gets only the managed policies created by Amazon Web Services.

  • custom -- Gets only the custom policies created in your Amazon Web Services account.

Output

ListResponseHeadersPoliciesOutput dataclass

Bases: _SerdeShape

Dataclass for ListResponseHeadersPoliciesOutput structure.

Attributes

response_headers_policy_list class-attribute instance-attribute
response_headers_policy_list: ResponseHeadersPolicyList | None = ...

A list of response headers policies.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.