Skip to content

put_event_configuration

Operation

put_event_configuration

put_event_configuration(request: PutEventConfigurationInput | PutEventConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutEventConfigurationInputDict]) -> 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
request PutEventConfigurationInput | PutEventConfigurationInputDict | 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[PutEventConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutEventConfigurationOutput

An instance of PutEventConfigurationOutput.

put_event_configuration async

put_event_configuration(request: PutEventConfigurationInput | PutEventConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutEventConfigurationInputDict]) -> 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
request PutEventConfigurationInput | PutEventConfigurationInputDict | 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[PutEventConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutEventConfigurationOutput

An instance of PutEventConfigurationOutput.

Input

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

PutEventConfigurationInputDict

Bases: TypedDict

Dictionary form of PutEventConfigurationInput.

Attributes

aggregation_configurations instance-attribute
aggregation_configurations: Sequence[AggregationConfiguration | AggregationConfigurationDict] | None

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

context_key_selectors instance-attribute
context_key_selectors: Sequence[ContextKeySelector | ContextKeySelectorDict] | None

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

event_data_store instance-attribute
event_data_store: str | 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 instance-attribute
max_event_size: str | 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 instance-attribute
trail_name: str | None

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

PutEventConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for PutEventConfigurationInput structure.

Attributes

aggregation_configurations class-attribute instance-attribute
aggregation_configurations: list[AggregationConfiguration] | 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 = ...

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 = ...

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: str | 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 = ...

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

Output

PutEventConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for PutEventConfigurationOutput structure.

Attributes

aggregation_configurations class-attribute instance-attribute
aggregation_configurations: list[AggregationConfiguration] | 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 = ...

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 = ...

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: str | None = ...

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

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.

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

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