update_realtime_log_config¶
Operation¶
async
¶
update_realtime_log_config(input: UpdateRealtimeLogConfigInput, plugins: list[Plugin] | None = None) -> UpdateRealtimeLogConfigOutput
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
-
Call
GetRealtimeLogConfigto get the current real-time log configuration. -
Locally modify the parameters in the real-time log configuration that you want to update.
-
Call this API (
UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's Name or ARN.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateRealtimeLogConfigInput
|
An instance of |
required |
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 |
|---|---|
UpdateRealtimeLogConfigOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRealtimeLogConfigInput structure.
Attributes¶
class-attribute
instance-attribute
¶
arn: str | None = ...
The Amazon Resource Name (ARN) for this real-time log configuration.
class-attribute
instance-attribute
¶
end_points: list[EndPoint] | None = ...
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
class-attribute
instance-attribute
¶
A list of fields to include in each real-time log record.
For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
class-attribute
instance-attribute
¶
name: str | None = ...
The name for this real-time log configuration.
class-attribute
instance-attribute
¶
sampling_rate: int | None = ...
The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateRealtimeLogConfigOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
A real-time log configuration.
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.