Skip to content

CloudTrail  >  Operations  >  restore_event_data_store

restore_event_data_store

Operation

restore_event_data_store async 

restore_event_data_store(input: RestoreEventDataStoreInput, plugins: list[Plugin] | None = None) -> RestoreEventDataStoreOutput
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.

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

Parameters:

Name Type Description Default
input RestoreEventDataStoreInput

An instance of RestoreEventDataStoreInput.

 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
RestoreEventDataStoreOutput

An instance of RestoreEventDataStoreOutput.

Input

RestoreEventDataStoreInput dataclass

Dataclass for RestoreEventDataStoreInput structure.

Attributes

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

The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.

Output

RestoreEventDataStoreOutput dataclass

Dataclass for RestoreEventDataStoreOutput structure.

Attributes

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

The advanced event selectors that were used to select events.

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

The billing mode for the event data store.

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

The timestamp of an event data store's creation.

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

The event data store ARN.

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = 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 = None

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

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

The name of the event data store.

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

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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

The retention period, in days.

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

The status of the event data store.

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

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

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

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