Skip to content

get_event_data_store

Operation

get_event_data_store

get_event_data_store(request: GetEventDataStoreInput | GetEventDataStoreInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventDataStoreInputDict]) -> GetEventDataStoreOutput
Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Parameters:

Name Type Description Default
request GetEventDataStoreInput | GetEventDataStoreInputDict | 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[GetEventDataStoreInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEventDataStoreOutput

An instance of GetEventDataStoreOutput.

get_event_data_store async

get_event_data_store(request: GetEventDataStoreInput | GetEventDataStoreInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEventDataStoreInputDict]) -> GetEventDataStoreOutput
Warning

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

Parameters:

Name Type Description Default
request GetEventDataStoreInput | GetEventDataStoreInputDict | 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[GetEventDataStoreInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetEventDataStoreOutput

An instance of GetEventDataStoreOutput.

Input

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

GetEventDataStoreInputDict

Bases: TypedDict

Dictionary form of GetEventDataStoreInput.

Attributes

event_data_store instance-attribute
event_data_store: Required[str]

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

GetEventDataStoreInput dataclass

Bases: _SerdeShape

Dataclass for GetEventDataStoreInput structure.

Attributes

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

The ARN (or ID suffix of the ARN) of the event data store about which you want information.

Output

GetEventDataStoreOutput dataclass

Bases: _SerdeShape

Dataclass for GetEventDataStoreOutput structure.

Attributes

advanced_event_selectors class-attribute instance-attribute
advanced_event_selectors: list[AdvancedEventSelector] | None = ...

The advanced event selectors used to select events for the data store.

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

The billing mode for the event data store.

created_timestamp class-attribute instance-attribute
created_timestamp: datetime | None = ...

The timestamp of the event data store's creation.

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

The event data store Amazon Resource Number (ARN).

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

If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.

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

Indicates the Lake query federation status. The status is ENABLED if Lake query federation is enabled, or DISABLED if Lake query federation is disabled. You cannot delete an event data store if the FederationStatus is ENABLED.

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

Specifies the KMS key ID that encrypts the events delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the following format.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

multi_region_enabled class-attribute instance-attribute
multi_region_enabled: bool | None = ...

Indicates whether the event data store includes events from all Regions, or only from the Region in which it was created.

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

The name of the event data store.

organization_enabled class-attribute instance-attribute
organization_enabled: bool | None = ...

Indicates whether an event data store is collecting logged events for an organization in Organizations.

partition_keys class-attribute instance-attribute
partition_keys: list[PartitionKey] | None = ...

The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes event data into partitions based on values derived from partition keys.

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.

retention_period class-attribute instance-attribute
retention_period: int | None = ...

The retention period of the event data store, in days.

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

The status of an event data store.

termination_protection_enabled class-attribute instance-attribute
termination_protection_enabled: bool | None = ...

Indicates that termination protection is enabled.

updated_timestamp class-attribute instance-attribute
updated_timestamp: datetime | None = ...

Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.