IoTSiteWise / Client / list_queries

list_queries¶

IoTSiteWise.Client.list_queries(**kwargs)¶

Retrieves a paginated list of queries for a workspace.

Request Syntax

response = client.list_queries(
    workspaceName='string',
    filter='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace to list queries for.
filter (string) – An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING.
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.

Return type:

dict

Returns:

Response Syntax

{
    'queries': [
        {
            'queryId': 'string',
            'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING',
            'submittedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Contains the response for the ListQueries operation.
- queries (list) –
  
  A list of query summaries for the workspace.
  - (dict) –
    
    Contains summary information about a query.
    - 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.
- nextToken (string) –
  
  The token for the next set of results, or null if there are no additional results.

Exceptions

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