Publish property value updates to Amazon DynamoDB - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Publish property value updates to Amazon DynamoDB

This tutorial introduces a convenient way to store your data by using Amazon DynamoDB, making it easier to access historical asset data without repeatedly querying the Amazon IoT SiteWise API. After you complete this tutorial, you can create custom software that consumes your asset data, such as a live map of wind speed and direction over an entire wind farm. If you want to monitor and visualize your data without implementing a custom software solution, see Monitor data with Amazon IoT SiteWise Monitor.

In this tutorial, you build on the Amazon IoT SiteWise demo that provides a sample set of data for a wind farm. You configure property value updates from the wind farm demo to send data, through Amazon IoT Core rules, to a DynamoDB table that you create. When you enable property value updates, Amazon IoT SiteWise sends your data to Amazon IoT Core in MQTT messages. Then, define Amazon IoT Core rules that perform actions, such as the DynamoDB action, depending on the contents of those messages. For more information, see Interact with other Amazon services.

Prerequisites

To complete this tutorial, you need the following:

  • An Amazon account. If you don't have one, see Set up an Amazon account.

  • A development computer running Windows, macOS, Linux, or Unix to access the Amazon Web Services Management Console. For more information, see What is the Amazon Web Services Management Console?

  • An IAM user with administrator permissions.

  • A running Amazon IoT SiteWise wind farm demo. When you set up the demo, it defines models and assets in Amazon IoT SiteWise and streams data to them to represent a wind farm. For more information, see Use the Amazon IoT SiteWise demo.

Step 1: Configure Amazon IoT SiteWise to publish property value updates

In this procedure, you enable property value notifications on your demo turbine assets' Wind Speed properties. After you enable property value notifications, Amazon IoT SiteWise publishes each value update in an MQTT message to Amazon IoT Core.

To enable property value update notifications on asset properties
  1. Sign in to the Amazon IoT SiteWise console.

  2. Review the Amazon IoT SiteWise endpoints and quotas where Amazon IoT SiteWise is supported and switch Amazon Regions, if necessary. Switch to a Region where you're running the Amazon IoT SiteWise demo.

  3. In the left navigation pane, choose Assets.

    Amazon IoT SiteWise "Assets" left navigation element screenshot.
  4. Choose the arrow next to Demo Wind Farm Asset to expand the wind farm asset's hierarchy.

    Amazon IoT SiteWise "Demo Wind Farm Asset" hierarchy screenshot.
  5. Choose a demo turbine and choose Edit.

    Amazon IoT SiteWise "Demo Turbine Asset" screenshot.
  6. Update the Wind Speed property's Notification status to ENABLED.

    Amazon IoT SiteWise "Edit notification status" screenshot.
  7. Choose Save asset at the bottom of the page.

  8. Repeat steps 5 through 7 for each demo turbine asset.

  9. Choose a demo turbine (for example, Demo Turbine Asset 1).

  10. Choose Measurements.

  11. Choose the copy icon next to the Wind Speed property to copy the notification topic to your clipboard. Save the notification topic to use later in this tutorial. You only need to record the notification topic from one turbine.

    Amazon IoT SiteWise "Copy notification topic" screenshot.

    The notification topic should look like the following example.

    $aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

Step 2: Create a rule in Amazon IoT Core

In this procedure, you create a rule in Amazon IoT Core that parses the property value notification messages and inserts data into an Amazon DynamoDB table. Amazon IoT Core rules parse MQTT messages and perform actions based on the contents and topic of each message. Then, you create a rule with a DynamoDB action to insert data to a DynamoDB table that you create as part of this tutorial.

To create a rule with a DynamoDB action
  1. Navigate to the Amazon IoT console. If a Get started button appears, choose it.

  2. In the left navigation pane, choose Act and then choose Rules.

    Amazon IoT Core "Create a rule" screenshot.
  3. If a You don't have any rules yet dialog box appears, choose Create a rule. Otherwise, choose Create.

  4. Enter a name and description for the rule.

    Amazon IoT Core "Create a rule" page screenshot with "Name" and "Description" highlighted.
  5. Find the notification topic that you saved earlier in this tutorial.

    $aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

    Replace the asset ID (the ID after assets/) in the topic with a +. This selects the wind speed property for all demo wind turbine assets. The + topic filter accepts all nodes from a single level in a topic. Your topic should look like the following example.

    $aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/+/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
  6. Enter the following rule query statement. Replace the topic in the FROM section with your notification topic.

    SELECT payload.assetId AS asset, (SELECT VALUE (value.doubleValue) FROM payload.values) AS windspeed, timestamp() AS timestamp FROM '$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/+/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE' WHERE type = 'PropertyValueUpdate'
  7. Under Set one or more actions, choose Add action.

    Amazon IoT Core "Create a rule" page screenshot with "Add action" highlighted.
  8. On the Select an action page, choose Split message into multiple columns of a DynamoDB table (DynamoDBv2).

    Amazon IoT Core "Select an action" page screenshot with the DynamoDBv2 action highlighted.
  9. Choose Configure action at the bottom of the page.

  10. On the Configure action page, choose Create a new resource.

    The DynamoDB console opens in a new tab. Keep the rule action tab open while you complete the following procedures.

Step 3: Create a DynamoDB table

In this procedure, you create an Amazon DynamoDB table to receive wind speed data from the rule action.

To create a DynamoDB table
  1. In the DynamoDB console dashboard, choose Create table.

  2. Enter a name for your table.

    DynamoDB "Create table" page screenshot.
  3. For Primary key, do the following:

    1. Enter timestamp as the partition key.

    2. Choose the Number type.

    3. Select the Add sort key check box.

    4. Enter asset as the sort key, and leave the default sort key type of String.

  4. Choose Create.

    When the Table is being created notice disappears, your table is ready.

  5. Return to the tab with the Configure action page. Keep the DynamoDB tab open while you complete the following procedures.

Step 4: Configure the DynamoDB rule action

In this procedure, you configure the Amazon DynamoDB rule action to insert data from property value updates to your new DynamoDB table.

To configure the DynamoDB rule action
  1. On the Configure action page, refresh the Table name list, and choose your new DynamoDB table.

    Amazon IoT Core "Configure DynamoDBv2 action" page screenshot with the table finder highlighted.
  2. Choose Create role to create an IAM role that grants Amazon IoT Core access to perform the rule action.

  3. Enter a role name and choose Create role.

    Amazon IoT Core "Configure DynamoDBv2 action" page screenshot with "Create role" highlighted.
  4. Choose Add action.

  5. Choose Create rule at the bottom of the page to finish creating the rule.

    Your demo asset data should start appearing in your DynamoDB table.

Step 5: Explore data in DynamoDB

In this procedure, you explore the demo assets' wind speed data in your new Amazon DynamoDB table.

To explore asset data in DynamoDB
  1. Return to the tab with the DynamoDB table open.

  2. In the table you created earlier, choose the Items tab to view the data in the table. Refresh the page if you don't see rows in the table. If rows don't appear after a few minutes, see Troubleshoot a rule (DynamoDB).

    DynamoDB table page screenshot with the "Items" tab highlighted.
  3. In a row in the table, choose the edit icon to expand the data.

    DynamoDB table page screenshot with the edit icon on a row highlighted.
  4. Choose the arrow next to the windspeed structure to expand the list of wind speed data points. Each list reflects a batch of wind speed data points sent to Amazon IoT SiteWise by the wind farm demo. You might want a different data format if you set up a rule action for your own use. For more information, see Query asset property notifications in Amazon IoT SiteWise.

    DynamoDB "Edit table row" panel screenshot.

Now that you have completed the tutorial, disable or delete the rule and delete your DynamoDB table to avoid incurring additional charges. To clean up your resources, see Step 6: Clean up resources after the tutorial.

Step 6: Clean up resources after the tutorial

After you complete the tutorial, clean up your resources to avoid incurring additional charges. Your demo wind farm assets are deleted at the end of the duration that you chose when you created the demo. You can also delete the demo manually. For more information, see Delete the Amazon IoT SiteWise demo.

Use the following procedures to disable property value update notifications (if you didn't delete the demo), disable or delete your Amazon IoT rule, and delete your DynamoDB table.

To disable property value update notifications on asset properties
  1. Navigate to the Amazon IoT SiteWise console.

  2. In the left navigation pane, choose Assets.

    Amazon IoT SiteWise "Assets" left navigation element screenshot.
  3. Choose the arrow next to Demo Wind Farm Asset to expand the wind farm asset's hierarchy.

    Amazon IoT SiteWise "Demo Wind Farm Asset" hierarchy screenshot.
  4. Choose a demo turbine and choose Edit.

    Amazon IoT SiteWise "Demo Turbine Asset" screenshot.
  5. Update the Wind Speed property's Notification status to DISABLED.

    Amazon IoT SiteWise "Edit notification status" screenshot.
  6. Choose Save asset at the bottom of the page.

  7. Repeat steps 4 through 6 for each demo turbine asset.

To disable or delete a rule in Amazon IoT Core
  1. Navigate to the Amazon IoT console.

  2. In the left navigation pane, choose Act and then choose Rules.

  3. Choose the menu on your rule and choose Disable or Delete.

    Amazon IoT Core "Rules" page screenshot with a rule's menu open and highlighted.
To delete a DynamoDB table
  1. Navigate to the DynamoDB console.

  2. In the left navigation pane, choose Tables.

  3. Choose the table you created earlier, WindSpeedData.

  4. Choose Delete table.

    DynamoDB "Table" page screenshot with "Delete table" highlighted.
  5. In the Delete table dialog, choose Delete.

    DynamoDB "Delete table" dialog screenshot with "Delete" highlighted.