execute_query

IoTTwinMaker.Client.execute_query(**kwargs)

Run queries to access information from your knowledge graph of entities within individual workspaces.

See also: AWS API Documentation

Request Syntax

response = client.execute_query(
    workspaceId='string',
    queryStatement='string',
    maxResults=123,
    nextToken='string'
)

Parameters

• workspaceId (string) --

  [REQUIRED]

  The ID of the workspace.

• queryStatement (string) --

  [REQUIRED]

  The query statement.

• maxResults (integer) --

  The maximum number of results to return at one time. The default is 25.

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

• nextToken (string) -- The string that specifies the next page of results.

Return type

dict

Returns

Response Syntax

{
    'columnDescriptions': [
        {
            'name': 'string',
            'type': 'NODE'|'EDGE'|'VALUE'
        },
    ],
    'rows': [
        {
            'rowData': [
                {...}|[...]|123|123.4|'string'|True|None,
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • columnDescriptions (list) --

    A list of ColumnDescription objects.

    • (dict) --

      A description of the column in the query results.

      • name (string) --

        The name of the column description.

      • type (string) --

        The type of the column description.

  • rows (list) --

    Represents a single row in the query results.

    • (dict) --

      Represents a single row in the query results.

      • rowData (list) --

        The data in a row of query results.

        • (document) --

  • nextToken (string) --

    The string that specifies the next page of results.

Exceptions

• IoTTwinMaker.Client.exceptions.InternalServerException
• IoTTwinMaker.Client.exceptions.AccessDeniedException
• IoTTwinMaker.Client.exceptions.QueryTimeoutException
• IoTTwinMaker.Client.exceptions.ThrottlingException
• IoTTwinMaker.Client.exceptions.ValidationException
• IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException