Skip to content

CloudTrail  >  Operations  >  put_event_configuration

put_event_configuration

Operation

put_event_configuration async 

put_event_configuration(input: PutEventConfigurationInput, plugins: list[Plugin] | None = None) -> PutEventConfigurationOutput

Updates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.

Parameters:

Name Type Description Default
input PutEventConfigurationInput

An instance of PutEventConfigurationInput.

 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
PutEventConfigurationOutput

An instance of PutEventConfigurationOutput.

Input

PutEventConfigurationInput dataclass

Dataclass for PutEventConfigurationInput structure.

Attributes

aggregation_configurations class-attribute instance-attribute 
aggregation_configurations: list[AggregationConfiguration] | None = None

The list of aggregation configurations that you want to configure for the trail.

context_key_selectors class-attribute instance-attribute 
context_key_selectors: list[ContextKeySelector] | None = None

A list of context key selectors that will be included to provide enriched event data.

event_data_store class-attribute instance-attribute 
event_data_store: str | None = None

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which event configuration settings are updated.

max_event_size class-attribute instance-attribute 
max_event_size: MaxEventSize | None = None

The maximum allowed size for events to be stored in the specified event data store. If you are using context key selectors, MaxEventSize must be set to Large.

trail_name class-attribute instance-attribute 
trail_name: str | None = None

The name of the trail for which you want to update event configuration settings.

Output

PutEventConfigurationOutput dataclass

Dataclass for PutEventConfigurationOutput structure.

Attributes

aggregation_configurations class-attribute instance-attribute 
aggregation_configurations: list[AggregationConfiguration] | None = None

A list of aggregation configurations that are configured for the trail.

context_key_selectors class-attribute instance-attribute 
context_key_selectors: list[ContextKeySelector] | None = None

The list of context key selectors that are configured for the event data store.

event_data_store_arn class-attribute instance-attribute 
event_data_store_arn: str | None = None

The Amazon Resource Name (ARN) or ID suffix of the ARN of the event data store for which the event configuration settings were updated.

max_event_size class-attribute instance-attribute 
max_event_size: MaxEventSize | None = None

The maximum allowed size for events stored in the specified event data store.

trail_arn class-attribute instance-attribute 
trail_arn: str | None = None

The Amazon Resource Name (ARN) of the trail that has aggregation enabled.