Describe Query

cloudtrail_describe_query

R Documentation

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status¶

Description¶

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

You must specify either a QueryID or a QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias.

Usage¶

cloudtrail_describe_query(EventDataStore, QueryId, QueryAlias)

Arguments¶

EventDataStore: The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
QueryId: The query ID.
QueryAlias: The alias that identifies a query template.

Value¶

A list with the following syntax:

list(
  QueryId = "string",
  QueryString = "string",
  QueryStatus = "QUEUED"|"RUNNING"|"FINISHED"|"FAILED"|"CANCELLED"|"TIMED_OUT",
  QueryStatistics = list(
    EventsMatched = 123,
    EventsScanned = 123,
    BytesScanned = 123,
    ExecutionTimeInMillis = 123,
    CreationTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  ErrorMessage = "string",
  DeliveryS3Uri = "string",
  DeliveryStatus = "SUCCESS"|"FAILED"|"FAILED_SIGNING_FILE"|"PENDING"|"RESOURCE_NOT_FOUND"|"ACCESS_DENIED"|"ACCESS_DENIED_SIGNING_FILE"|"CANCELLED"|"UNKNOWN"
)

Request syntax¶

svc$describe_query(
  EventDataStore = "string",
  QueryId = "string",
  QueryAlias = "string"
)