Mapping external alarm state streams - AWS IoT SiteWise

Mapping external alarm state streams

You can define property aliases to map your data streams to your alarm state properties. This helps you easily identify an alarm state property when you ingest or retrieve data. For more information about property aliases, see Mapping industrial data streams to asset properties.

Mapping external alarm state streams (console)

You can use the AWS IoT SiteWise console to set an alias for an alarm state property.

To set a property alias for an alarm state property (console)

  1. Navigate to the AWS IoT SiteWise console.

  2. In the navigation pane, choose Assets.

  3. Choose the asset for which you want to set a property alias.

    Tip

    You can choose the arrow icon to expand an asset hierarchy to find your asset.

    
        AWS IoT SiteWise "Assets" page screenshot with an asset hierarchy
          highlighted.
  4. Choose Alarms.

  5. Select the external alarm for which you want to set a property alias.

  6. Choose View.

  7. In the Alarm state details pane, choose Edit.

  8. Enter the property alias.

  9. Choose Update.

Mapping external alarm state streams (CLI)

You can use the AWS Command Line Interface (AWS CLI) to set an alias for an alarm state property.

You must know your asset's assetId and property's propertyId to complete this procedure. If you created an asset but don't know its assetId, use the ListAssets operation to view all of your assets for a specific model. Then, use the DescribeAsset operation to view your asset's properties including property IDs.

Note

The DescribeAsset response includes the list of composite asset models for the asset. Each alarm is a composite model. To find the propertyId, find the composite model for the alarm, and then find the AWS/ALARM_STATE property in that composite model.

For more information about how to set the property alias, see Setting a property alias (CLI).