Module Values.DescribeQueryResponseSource

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.

Sourcetype nonrec t = {
  1. queryId : UUID.t option;
    (*

    The ID of the query.

    *)
  2. queryString : QueryStatement.t option;
    (*

    The SQL code of a query.

    *)
  3. queryStatus : QueryStatus.t option;
    (*

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

    *)
  4. queryStatistics : QueryStatisticsForDescribeQuery.t option;
    (*

    Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

    *)
  5. errorMessage : ErrorMessage.t option;
    (*

    The error message returned if a query failed.

    *)
  6. deliveryS3Uri : DeliveryS3Uri.t option;
    (*

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

    *)
  7. deliveryStatus : DeliveryStatus.t option;
    (*

    The delivery status.

    *)
  8. prompt : Prompt.t option;
    (*

    The prompt used for a generated query. For information about generated queries, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.

    *)
  9. eventDataStoreOwnerAccountId : AccountId.t option;
    (*

    The account ID of the event data store owner.

    *)
}
Sourcetype nonrec error = [
  1. | `EventDataStoreARNInvalidException of EventDataStoreARNInvalidException.t
  2. | `EventDataStoreNotFoundException of EventDataStoreNotFoundException.t
  3. | `InactiveEventDataStoreException of InactiveEventDataStoreException.t
  4. | `InvalidParameterException of InvalidParameterException.t
  5. | `NoManagementAccountSLRExistsException of NoManagementAccountSLRExistsException.t
  6. | `OperationNotPermittedException of OperationNotPermittedException.t
  7. | `QueryIdNotFoundException of QueryIdNotFoundException.t
  8. | `UnsupportedOperationException of UnsupportedOperationException.t
  9. | `Unknown_operation_error of string * string option
]
Sourceval make : ?queryId:??? -> ?queryString:??? -> ?queryStatus:??? -> ?queryStatistics:??? -> ?errorMessage:??? -> ?deliveryS3Uri:??? -> ?deliveryStatus:??? -> ?prompt:??? -> ?eventDataStoreOwnerAccountId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `EventDataStoreARNInvalidException of unit | `EventDataStoreNotFoundException of unit | `InactiveEventDataStoreException of unit | `InvalidParameterException of unit | `NoManagementAccountSLRExistsException of unit | `OperationNotPermittedException of unit | `QueryIdNotFoundException of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationException of unit ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `EventDataStoreARNInvalidException of unit | `EventDataStoreNotFoundException of unit | `InactiveEventDataStoreException of unit | `InvalidParameterException of unit | `NoManagementAccountSLRExistsException of unit | `OperationNotPermittedException of unit | `QueryIdNotFoundException of unit | `Unknown_operation_error of string * string option | `UnsupportedOperationException of unit ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of UUID.t | `Structure of (string * [> `Integer of Integer.t | `Long of Long.t | `Timestamp of Date.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t