IotSiteWiseAction
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.
You must use expressions for all parameters in IotSiteWiseAction. The
expressions accept literals, operators, functions, references, and substitutions
templates.
Examples
-
For literal values, the expressions must contain single quotes. For example, the value for the
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'. -
For references, you must specify either variables or input values. For example, the value for the
assetIdparameter can be$input.TurbineInput.assetId1. -
For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.In the following example, the value for the
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'
You must specify either propertyAlias or both assetId and
propertyId to identify the target asset property in AWS IoT SiteWise.
For more information, see Expressions in the AWS IoT Events Developer Guide.
Contents
- assetId
-
The ID of the asset that has the specified property.
Type: String
Required: No
- entryId
-
A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
Type: String
Required: No
- propertyAlias
-
The alias of the asset property.
Type: String
Required: No
- propertyId
-
The ID of the asset property.
Type: String
Required: No
- propertyValue
-
The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
Type: AssetPropertyValue object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
