Using the AWS IoT TwinMaker knowledge graph

Before using the AWS IoT TwinMaker knowledge graph, make sure you have reviewed the following prerequisites:

• You have an AWS IoT TwinMaker workspace. You can create a workspace in the AWS IoT TwinMaker console.

• You are familiar with AWS IoT TwinMaker's entity-component system and how to create entities. For more information, see Create your first entity.

• You are familiar with AWS IoT TwinMaker's data connectors. For more information, see AWS IoT TwinMaker data connectors.

Note

In order to use the AWS IoT TwinMaker knowledge graph, you need to be in either the standard or tiered bundle pricing modes. For more information, see Switch AWS IoT TwinMaker pricing modes.

Using the AWS IoT TwinMaker knowledge graph in the AWS console

The following procedures show you how to write, run, save, and edit queries.

Open the query editor

Use this procedure to navigate to the knowledge graph query editor:

1. Open the AWS IoT TwinMaker console.

2. Open the workspace in which you wish to use knowledge graph.

3. In the left navigation menu, choose Query editor.

4. This opens the query editor. You are now ready to run queries on your workspace's resources.

Run a query

Use this procedure to run a query and generate a graph.

1. In the query editor, choose the Editor tab to open the syntax editor.

2. In the editor space, write the query you wish to run against your workspace's resources, as shown in the following screenshot.

   

   In the example shown in the preceding screenshot, the request searches for entities that contain vav_% in the name. The query organizes these entities defined by a feed relationship between them.

   Note

   The knowledge graph syntax is written using PartiQL. For information on using this syntax, see AWS IoT TwinMaker knowledge graph additional resources.

3. Choose Run query to run the request you just created.

4. After choosing Run query, a graph is generated based on the request, as shown in the following screenshot.

   

   The example graph shown in the preceding screenshot is based on the query run in step 2.

5. The results of the query are also presented in a list. Choose results to view the query results.

6. Optionally, choose Export as to export the query results in a JSON or CSV format.

This covers the basic use of knowledge graph in the console. For more information and examples demonstrating the knowledge graph syntax, see AWS IoT TwinMaker knowledge graph additional resources.