Amazon IoT Events · JSON Structure

Iot Events Asset Property Value Structure

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'.
For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality.

For more information, see Expressions in the AWS IoT Events Developer Guide.

Type: object Properties: 3

Event DetectionIoTState MachineAutomation

AssetPropertyValue is a JSON Structure definition published by Amazon IoT Events, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

value timestamp quality

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/json-structure/iot-events-asset-property-value-structure.json",
  "name": "AssetPropertyValue",
  "description": "<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>quality</code> parameter can be <code>'GOOD'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>quality</code> parameter can be <code>$input.TemperatureInput.sensorData.quality</code>.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>",
  "type": "object",
  "properties": {
    "value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyVariant"
        },
        {
          "description": "The value to send to an asset property."
        }
      ]
    },
    "timestamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyTimestamp"
        },
        {
          "description": "The timestamp associated with the asset property value. The default is the current event time."
        }
      ]
    },
    "quality": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyQuality"
        },
        {
          "description": "The quality of the asset property value. The value must be <code>'GOOD'</code>, <code>'BAD'</code>, or <code>'UNCERTAIN'</code>."
        }
      ]
    }
  }
}