Skip to content

list_distributions_by_cache_policy_id

Operation

list_distributions_by_cache_policy_id

list_distributions_by_cache_policy_id(request: ListDistributionsByCachePolicyIdInput | ListDistributionsByCachePolicyIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDistributionsByCachePolicyIdInputDict]) -> ListDistributionsByCachePolicyIdOutput

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.

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
request ListDistributionsByCachePolicyIdInput | ListDistributionsByCachePolicyIdInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDistributionsByCachePolicyIdInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDistributionsByCachePolicyIdOutput

An instance of ListDistributionsByCachePolicyIdOutput.

list_distributions_by_cache_policy_id async

list_distributions_by_cache_policy_id(request: ListDistributionsByCachePolicyIdInput | ListDistributionsByCachePolicyIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDistributionsByCachePolicyIdInputDict]) -> ListDistributionsByCachePolicyIdOutput

Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.

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
request ListDistributionsByCachePolicyIdInput | ListDistributionsByCachePolicyIdInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListDistributionsByCachePolicyIdInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDistributionsByCachePolicyIdOutput

An instance of ListDistributionsByCachePolicyIdOutput.

Input

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

ListDistributionsByCachePolicyIdInputDict

Bases: TypedDict

Dictionary form of ListDistributionsByCachePolicyIdInput.

Attributes

cache_policy_id instance-attribute
cache_policy_id: Required[str]

The ID of the cache policy whose associated distribution IDs you want to list.

marker instance-attribute
marker: str | None

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs 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 distribution IDs that you want in the response.

ListDistributionsByCachePolicyIdInput dataclass

Bases: _SerdeShape

Dataclass for ListDistributionsByCachePolicyIdInput structure.

Attributes

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

The ID of the cache policy whose associated distribution IDs you want to list.

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

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs 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 distribution IDs that you want in the response.

Output

ListDistributionsByCachePolicyIdOutput dataclass

Bases: _SerdeShape

Dataclass for ListDistributionsByCachePolicyIdOutput structure.

Attributes

distribution_id_list class-attribute instance-attribute
distribution_id_list: DistributionIdList | None = ...

A list of distribution IDs.

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.