Skip to content

start_event_data_store_ingestion

Operation

start_event_data_store_ingestion

start_event_data_store_ingestion(request: StartEventDataStoreIngestionInput | StartEventDataStoreIngestionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartEventDataStoreIngestionInputDict]) -> StartEventDataStoreIngestionOutput
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.

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

Parameters:

Name Type Description Default
request StartEventDataStoreIngestionInput | StartEventDataStoreIngestionInputDict | 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[StartEventDataStoreIngestionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartEventDataStoreIngestionOutput

An instance of StartEventDataStoreIngestionOutput.

start_event_data_store_ingestion async

start_event_data_store_ingestion(request: StartEventDataStoreIngestionInput | StartEventDataStoreIngestionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartEventDataStoreIngestionInputDict]) -> StartEventDataStoreIngestionOutput
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.

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

Parameters:

Name Type Description Default
request StartEventDataStoreIngestionInput | StartEventDataStoreIngestionInputDict | 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[StartEventDataStoreIngestionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartEventDataStoreIngestionOutput

An instance of StartEventDataStoreIngestionOutput.

Input

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

StartEventDataStoreIngestionInputDict

Bases: TypedDict

Dictionary form of StartEventDataStoreIngestionInput.

Attributes

event_data_store instance-attribute
event_data_store: Required[str]

The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.

StartEventDataStoreIngestionInput dataclass

Bases: _SerdeShape

Dataclass for StartEventDataStoreIngestionInput 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 for which you want to start ingestion.

Output

StartEventDataStoreIngestionOutput dataclass

Bases: _SerdeShape

Dataclass for StartEventDataStoreIngestionOutput structure.

Attributes

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.