Skip to content

get_realtime_log_config

Operation

get_realtime_log_config

get_realtime_log_config(request: GetRealtimeLogConfigInput | GetRealtimeLogConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRealtimeLogConfigInputDict]) -> GetRealtimeLogConfigOutput

Gets a real-time log configuration.

To get a real-time log configuration, you can provide the configuration's 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 get.

Parameters:

Name Type Description Default
request GetRealtimeLogConfigInput | GetRealtimeLogConfigInputDict | 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[GetRealtimeLogConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRealtimeLogConfigOutput

An instance of GetRealtimeLogConfigOutput.

get_realtime_log_config async

get_realtime_log_config(request: GetRealtimeLogConfigInput | GetRealtimeLogConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRealtimeLogConfigInputDict]) -> GetRealtimeLogConfigOutput

Gets a real-time log configuration.

To get a real-time log configuration, you can provide the configuration's 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 get.

Parameters:

Name Type Description Default
request GetRealtimeLogConfigInput | GetRealtimeLogConfigInputDict | 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[GetRealtimeLogConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRealtimeLogConfigOutput

An instance of GetRealtimeLogConfigOutput.

Input

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

GetRealtimeLogConfigInputDict

Bases: TypedDict

Dictionary form of GetRealtimeLogConfigInput.

Attributes

arn instance-attribute
arn: str | None

The Amazon Resource Name (ARN) of the real-time log configuration to get.

name instance-attribute
name: str | None

The name of the real-time log configuration to get.

GetRealtimeLogConfigInput dataclass

Bases: _SerdeShape

Dataclass for GetRealtimeLogConfigInput structure.

Attributes

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

The Amazon Resource Name (ARN) of the real-time log configuration to get.

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

The name of the real-time log configuration to get.

Output

GetRealtimeLogConfigOutput dataclass

Bases: _SerdeShape

Dataclass for GetRealtimeLogConfigOutput structure.

Attributes

realtime_log_config class-attribute instance-attribute
realtime_log_config: RealtimeLogConfig | None = ...

A real-time log configuration.

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.