Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeQuery

Retrieves information about a query, including its status.

Request Syntax


GET /workspaces/workspaceName/queries/queryId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

queryId

The unique identifier for the query execution.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

Required: Yes

workspaceName

The name of the workspace associated with the query.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "completedAt": number,
   "errorMessage": "string",
   "queryId": "string",
   "statistics": { 
      "bytesScanned": number,
      "executionTimeInMillis": number,
      "rowCount": number
   },
   "status": "string",
   "submittedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

completedAt

The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.

Type: Timestamp

errorMessage

A human-readable error description. This field is present when the query status is FAILED.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

queryId

The unique identifier for the query execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-]+

statistics

The query execution statistics. This field is present when the query status is COMPLETED.

Type: QueryStatistics object

status

The current query status.

Type: String

submittedAt

The date and time when the query was submitted, in Unix epoch time.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429