[ aws . cloudtrail ]

list-queries

Description

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 , or CANCELLED .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-queries
--event-data-store <value>
[--next-token <value>]
[--max-results <value>]
[--start-time <value>]
[--end-time <value>]
[--query-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--event-data-store (string)

The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

--next-token (string)

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

--max-results (integer)

The maximum number of queries to show on a page.

--start-time (timestamp)

Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

--end-time (timestamp)

Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

--query-status (string)

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .

Possible values:

• QUEUED

• RUNNING

• FINISHED

• FAILED

• CANCELLED

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Queries -> (list)

Lists matching query results, and shows query ID, status, and creation time of each query.

(structure)

A SQL string of criteria about events that you want to collect in an event data store.

QueryId -> (string)

The ID of a query.

QueryStatus -> (string)

The status of the query. This can be QUEUED , RUNNING , FINISHED , FAILED , or CANCELLED .

CreationTime -> (timestamp)

The creation time of a query.

NextToken -> (string)

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