Skip to content

get_event_configuration

Operation

get_event_configuration

get_event_configuration(request: GetEventConfigurationInput | GetEventConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventConfigurationInputDict]) -> GetEventConfigurationOutput

Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.

Parameters:

Name Type Description Default
request GetEventConfigurationInput | GetEventConfigurationInputDict | 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[GetEventConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEventConfigurationOutput

An instance of GetEventConfigurationOutput.

get_event_configuration async

get_event_configuration(request: GetEventConfigurationInput | GetEventConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventConfigurationInputDict]) -> GetEventConfigurationOutput

Retrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.

Parameters:

Name Type Description Default
request GetEventConfigurationInput | GetEventConfigurationInputDict | 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[GetEventConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEventConfigurationOutput

An instance of GetEventConfigurationOutput.

Input

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

GetEventConfigurationInputDict

Bases: TypedDict

Dictionary form of GetEventConfigurationInput.

Attributes

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 you want to retrieve event configuration settings.

trail_name instance-attribute
trail_name: str | None

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

GetEventConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for GetEventConfigurationInput structure.

Attributes

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 you want to retrieve event configuration settings.

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

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

Output

GetEventConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for GetEventConfigurationOutput structure.

Attributes

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

The 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 are returned.

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 for which the event configuration settings are returned.