[ aws . cloudtrail ]

get-query-results

Description

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-query-results
--event-data-store <value>
--query-id <value>
[--next-token <value>]
[--max-query-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--event-data-store (string)

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

--query-id (string)

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

--next-token (string)

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

--max-query-results (integer)

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

--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

QueryStatus -> (string)

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

QueryStatistics -> (structure)

Shows the count of query results.

ResultsCount -> (integer)

The number of results returned.

TotalResultsCount -> (integer)

The total number of results returned by a query.

BytesScanned -> (long)

The total bytes that the query scanned in the event data store. This value matches the number of bytes for which your account is billed for the query, unless the query is still running.

QueryResultRows -> (list)

Contains the individual event results of the query.

(list)

(map)

key -> (string)

value -> (string)

NextToken -> (string)

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

ErrorMessage -> (string)

The error message returned if a query failed.