Skip to content

CloudTrail Lake will no longer be open to new customers starting May 31, 2026

Description

CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change.

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 QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specified RefreshId.

Usage

cloudtrail_describe_query(EventDataStore, QueryId, QueryAlias,
  RefreshId, EventDataStoreOwnerAccountId)

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.

  • RefreshId

    The ID of the dashboard refresh.

  • EventDataStoreOwnerAccountId

    The account ID of the event data store owner.

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",
  Prompt = "string",
  EventDataStoreOwnerAccountId = "string"
)

Request syntax

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