Skip to content

list_distributions_by_realtime_log_config

Operation

list_distributions_by_realtime_log_config

Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.

You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.

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 ListDistributionsByRealtimeLogConfigInput | ListDistributionsByRealtimeLogConfigInputDict | 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[ListDistributionsByRealtimeLogConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDistributionsByRealtimeLogConfigOutput

An instance of ListDistributionsByRealtimeLogConfigOutput.

list_distributions_by_realtime_log_config async

Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.

You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.

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 ListDistributionsByRealtimeLogConfigInput | ListDistributionsByRealtimeLogConfigInputDict | 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[ListDistributionsByRealtimeLogConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListDistributionsByRealtimeLogConfigOutput

An instance of ListDistributionsByRealtimeLogConfigOutput.

Input

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

ListDistributionsByRealtimeLogConfigInputDict

Bases: TypedDict

Dictionary form of ListDistributionsByRealtimeLogConfigInput.

Attributes

marker instance-attribute
marker: str | None

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

realtime_log_config_arn instance-attribute
realtime_log_config_arn: str | None

The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.

realtime_log_config_name instance-attribute
realtime_log_config_name: str | None

The name of the real-time log configuration whose associated distributions you want to list.

ListDistributionsByRealtimeLogConfigInput dataclass

Bases: _SerdeShape

Dataclass for ListDistributionsByRealtimeLogConfigInput 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 distributions. The response includes distributions 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 distributions that you want in the response.

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

The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.

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

The name of the real-time log configuration whose associated distributions you want to list.

Output

ListDistributionsByRealtimeLogConfigOutput dataclass

Bases: _SerdeShape

Dataclass for ListDistributionsByRealtimeLogConfigOutput structure.

Attributes

distribution_list class-attribute instance-attribute
distribution_list: DistributionList | None = ...

A distribution list.

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.