Skip to content

CloudTrail  >  Operations  >  get_query_results

get_query_results

Operation

get_query_results async 

get_query_results(input: GetQueryResultsInput, plugins: list[Plugin] | None = None) -> GetQueryResultsOutput

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.

Parameters:

Name Type Description Default
input GetQueryResultsInput

An instance of GetQueryResultsInput.

 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
GetQueryResultsOutput

An instance of GetQueryResultsOutput.

Input

GetQueryResultsInput dataclass

Dataclass for GetQueryResultsInput structure.

Attributes

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

The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

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

The account ID of the event data store owner.

max_query_results class-attribute instance-attribute 
max_query_results: int | None = None

The maximum number of query results to display on a single page.

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

A token you can use to get the next page of query results.

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

The ID of the query for which you want to get results.

Output

GetQueryResultsOutput dataclass

Dataclass for GetQueryResultsOutput structure.

Attributes

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

The error message returned if a query failed.

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

A token you can use to get the next page of query results.

query_result_rows class-attribute instance-attribute 
query_result_rows: list[list[dict[str, str]]] | None = None

Contains the individual event results of the query.

query_statistics class-attribute instance-attribute 
query_statistics: QueryStatistics | None = None

Shows the count of query results.

query_status class-attribute instance-attribute 
query_status: QueryStatus | None = None

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.