list_distributions_by_key_group¶
Operation¶
list_distributions_by_key_group
async
¶
list_distributions_by_key_group(request: ListDistributionsByKeyGroupInput | ListDistributionsByKeyGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> ListDistributionsByKeyGroupOutput
list_distributions_by_key_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDistributionsByKeyGroupInputDict]) -> ListDistributionsByKeyGroupOutput
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
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 |
|---|---|
ListDistributionsByKeyGroupOutput
|
An instance of |
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¶
ListDistributionsByKeyGroupInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDistributionsByKeyGroupInput structure.
Attributes¶
key_group_id
class-attribute
instance-attribute
¶
key_group_id: str | None = ...
The ID of the key group whose associated distribution IDs you are listing.
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.
Dictionaries¶
ListDistributionsByKeyGroupInputDict
¶
Bases: TypedDict
Dictionary form of ListDistributionsByKeyGroupInput.
Attributes¶
key_group_id
instance-attribute
¶
The ID of the key group whose associated distribution IDs you are listing.
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.
Output¶
ListDistributionsByKeyGroupOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListDistributionsByKeyGroupOutput 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
¶
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.