Map external alarm state streams in AWS IoT SiteWise - AWS IoT SiteWise
Map external alarm state streams (console)Map external alarm state streams (AWS CLI)

Map external alarm state streams in AWS IoT SiteWise

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 Manage data streams for AWS IoT SiteWise.

Map external alarm state streams (console)

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 Manage data streams for AWS IoT SiteWise.

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.

  4. Choose Edit.

  5. Scroll to Alarms and expand the section.

  6. Under External Alarms, enter the alias in Property alias – optional.

  7. Choose Save.

Map external alarm state streams (AWS CLI)

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 Manage data streams for AWS IoT SiteWise.

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. You can also use the external ID. If you created an asset and don't know its assetId, use the ListAssets API to list all the assets for a specific model. 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 Update an asset property alias.