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

GetQueryResults

Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.

Request Syntax


GET /workspaces/workspaceName/queries/queryId/results?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return for each paginated request.

Valid Range: Minimum value of 1. Maximum value of 10000.

nextToken

The token to be used for the next set of paginated results.

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

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

{
   "columnInfo": [ 
      { 
         "name": "string",
         "type": "string"
      }
   ],
   "nextToken": "string",
   "rows": [ 
      [ "string" ]
   ]
}

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.

columnInfo

A list of column metadata for the query results. Each entry contains the column name and data type. Present when the query status is COMPLETED.

Type: Array of ColumnInformation objects

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

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

rows

The result rows. Each row is a list of string column values, positional to match the columnInfo order. Present when the query status is COMPLETED.

Type: Array of arrays of strings

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

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