Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444270263.9 KB

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for <code>EventDataStore</code>, and a value for <code>QueryID</code>.

post/#X-Amz-Target=com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.DescribeQuery

Headers

X-Amz-Target'com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.DescribeQuery' required

Request body

EventDataStorestring

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.EventDataStore is no longer required by DescribeQueryRequest

QueryIdstring required

The query ID.

Response

Success

QueryIdstring

The ID of the query.

QueryStringstring

The SQL code of a query.

QueryStatus'QUEUED' | 'RUNNING' | 'FINISHED' | 'FAILED' | 'CANCELLED' | 'TIMED_OUT'

The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code>

ErrorMessagestring

The error message returned if a query failed.

DeliveryS3Uristring

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

DeliveryStatus'SUCCESS' | 'FAILED' | 'FAILED_SIGNING_FILE' | 'PENDING' | 'RESOURCE_NOT_FOUND' | 'ACCESS_DENIED' | 'ACCESS_DENIED_SIGNING_FILE' | 'CANCELLED' | 'UNKNOWN'

The delivery status.