start_query¶
Operation¶
async
¶
start_query(input: StartQueryInput, plugins: list[Plugin] | None = None) -> StartQueryOutput
Starts a CloudTrail Lake query. Use the QueryStatement parameter to
provide your SQL query, enclosed in single quotation marks. Use the
optional DeliveryS3Uri parameter to deliver the query results to an S3
bucket.
StartQuery requires you specify either the QueryStatement parameter,
or a QueryAlias and any QueryParameters. In the current release, the
QueryAlias and QueryParameters parameters are used only for the
queries that populate the CloudTrail Lake dashboards.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartQueryInput
|
An instance of |
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 |
|---|---|
StartQueryOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for StartQueryInput structure.
Attributes¶
class-attribute
instance-attribute
¶
delivery_s3_uri: str | None = None
The URI for the S3 bucket where CloudTrail delivers the query results.
class-attribute
instance-attribute
¶
event_data_store_owner_account_id: str | None = None
The account ID of the event data store owner.
class-attribute
instance-attribute
¶
query_alias: str | None = None
The alias that identifies a query template.
class-attribute
instance-attribute
¶
The query parameters for the specified QueryAlias.
Output¶
dataclass
¶
Dataclass for StartQueryOutput structure.