list_queries¶
Operation¶
async
¶
list_queries(input: ListQueriesInput, plugins: list[Plugin] | None = None) -> ListQueriesOutput
Returns a list of queries and query statuses for the past seven days.
You must specify an ARN value for EventDataStore. Optionally, to
shorten the list of results, you can specify a time range, formatted as
timestamps, by adding StartTime and EndTime parameters, and a
QueryStatus value. Valid values for QueryStatus include QUEUED,
RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListQueriesInput
|
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 |
|---|---|
ListQueriesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListQueriesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
end_time: datetime | None = None
Use with StartTime to bound a ListQueries request, and limit its
results to only those queries run within a specified time period.
class-attribute
instance-attribute
¶
event_data_store: str | None = None
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of queries to show on a page.
class-attribute
instance-attribute
¶
next_token: str | None = None
A token you can use to get the next page of results.
class-attribute
instance-attribute
¶
query_status: QueryStatus | None = None
The status of queries that you want to return in results. Valid values
for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED,
TIMED_OUT, or CANCELLED.