IoTSiteWise / Client / describe_query

describe_query¶

IoTSiteWise.Client.describe_query(**kwargs)¶

Retrieves information about a query, including its status.

Request Syntax

response = client.describe_query(
    workspaceName='string',
    queryId='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace associated with the query.
queryId (string) –
[REQUIRED]

The unique identifier for the query execution.

Return type:

dict

Returns:

Response Syntax

{
    'queryId': 'string',
    'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING',
    'submittedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1),
    'statistics': {
        'rowCount': 123,
        'bytesScanned': 123,
        'executionTimeInMillis': 123
    },
    'errorMessage': 'string'
}

Response Structure

(dict) –

Contains the response for the DescribeQuery operation.
- queryId (string) –
  
  The unique identifier for the query execution.
- status (string) –
  
  The current query status.
- submittedAt (datetime) –
  
  The date and time when the query was submitted, in Unix epoch time.
- completedAt (datetime) –
  
  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.
- statistics (dict) –
  
  The query execution statistics. This field is present when the query status is COMPLETED.
  - rowCount (integer) –
    
    The total number of rows returned by the query.
  - bytesScanned (integer) –
    
    The total number of bytes scanned during query execution.
  - executionTimeInMillis (integer) –
    
    The total query execution time, in milliseconds.
- errorMessage (string) –
  
  A human-readable error description. This field is present when the query status is FAILED.

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException