IoTSiteWise / Paginator / ExecuteQuery
ExecuteQuery#
- class IoTSiteWise.Paginator.ExecuteQuery#
paginator = client.get_paginator('execute_query')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
IoTSiteWise.Client.execute_query()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( queryStatement='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
queryStatement (string) –
[REQUIRED]
The IoT SiteWise query statement.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'columns': [ { 'name': 'string', 'type': { 'scalarType': 'BOOLEAN'|'INT'|'DOUBLE'|'TIMESTAMP'|'STRING' } }, ], 'rows': [ { 'data': [ { 'scalarValue': 'string', 'arrayValue': {'... recursive ...'}, 'rowValue': {'... recursive ...'}, 'nullValue': True|False }, ] }, ], 'NextToken': 'string' }
Response Structure
(dict) –
columns (list) –
Represents a single column in the query results.
(dict) –
A description of the column in the query results.
name (string) –
The name of the column description.
type (dict) –
The type of the column description.
scalarType (string) –
The allowed data types that the column has as it’s value.
rows (list) –
Represents a single row in the query results.
(dict) –
Represents a single row in the query results.
data (list) –
List of data points in a single row of the result set.
(dict) –
Represents a single data point in a query result.
scalarValue (string) –
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
arrayValue (list) –
Indicates if the data point is an array.
rowValue (dict) –
Indicates if the data point is a row.
nullValue (boolean) –
Indicates if the data point is null.
NextToken (string) –
A token to resume pagination.