query_results
Creates, updates, deletes, gets or lists a query_results resource.
Overview
| Name | query_results |
| Type | Resource |
| Id | aws.iotsitewise.query_results |
Fields
The following fields are returned by SELECT queries:
- get_query_results
| Name | Datatype | Description |
|---|---|---|
row | array | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_query_results | select | workspace_name, query_id, region | maxResults, nextToken | Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
query_id | string | The unique identifier for the query execution. |
region | string | AWS region (default: us-east-1) |
workspace_name | string | The name of the workspace associated with the query. |
maxResults | integer | The maximum number of results to return for each paginated request. |
nextToken | string | The token to be used for the next set of paginated results. |
SELECT examples
- get_query_results
Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.
SELECT
row
FROM aws.iotsitewise.query_results
WHERE workspace_name = '{{ workspace_name }}' -- required
AND query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;