Module Values.QueryResponseSource

Query is a synchronous operation that enables you to run a query against your Amazon Timestream data. If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream. The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling. Query will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the code sample for details. Your query request will fail in the following cases: If you submit a Query request with the same client token outside of the 5-minute idempotency window. If you submit a Query request with the same client token, but change other parameters, within the 5-minute idempotency window. If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: Query aborted as max page response size has been exceeded by the output result row If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

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

    A unique ID for the given query.

    *)
  2. nextToken : PaginationToken.t option;
    (*

    A pagination token that can be used again on a Query call to get the next set of results.

    *)
  3. rows : RowList.t option;
    (*

    The result set rows returned by the query.

    *)
  4. columnInfo : ColumnInfoList.t option;
    (*

    The column data types of the returned result set.

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

    Information about the status of the query, including progress and bytes scanned.

    *)
  6. queryInsightsResponse : QueryInsightsResponse.t option;
    (*

    Encapsulates QueryInsights containing insights and metrics related to the query that you executed.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `ConflictException of ConflictException.t
  3. | `InternalServerException of InternalServerException.t
  4. | `InvalidEndpointException of InvalidEndpointException.t
  5. | `QueryExecutionException of QueryExecutionException.t
  6. | `ThrottlingException of ThrottlingException.t
  7. | `ValidationException of ValidationException.t
  8. | `Unknown_operation_error of string * string option
]
Sourceval make : ?queryId:??? -> ?nextToken:??? -> ?rows:??? -> ?columnInfo:??? -> ?queryStatus:??? -> ?queryInsightsResponse:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `InternalServerException of InternalServerException.t | `InvalidEndpointException of InvalidEndpointException.t | `QueryExecutionException of QueryExecutionException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `ConflictException of ConflictException.t | `InternalServerException of InternalServerException.t | `InvalidEndpointException of InvalidEndpointException.t | `QueryExecutionException of QueryExecutionException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * Awso.Botodata.value) 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