Amazon IoT Events · JSON Structure

Iot Events Asset Property Variant Structure

A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. 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 integerValue parameter can be '100'.
For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.
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 doubleValue parameter uses a substitution template.

'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

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

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

Type: object Properties: 4

Event DetectionIoTState MachineAutomation

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

Properties

stringValue integerValue doubleValue booleanValue

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-variant-structure.json",
  "name": "AssetPropertyVariant",
  "description": "<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyVariant</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>integerValue</code> parameter can be <code>'100'</code>.</p> </li> <li> <p>For references, you must specify either variables or parameters. For example, the value for the <code>booleanValue</code> parameter can be <code>$variable.offline</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. </p> <p>In the following example, the value for the <code>doubleValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</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> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>",
  "type": "object",
  "properties": {
    "stringValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyStringValue"
        },
        {
          "description": "The asset property value is a string. You must use an expression, and the evaluated result should be a string."
        }
      ]
    },
    "integerValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyIntegerValue"
        },
        {
          "description": "The asset property value is an integer. You must use an expression, and the evaluated result should be an integer."
        }
      ]
    },
    "doubleValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyDoubleValue"
        },
        {
          "description": "The asset property value is a double. You must use an expression, and the evaluated result should be a double."
        }
      ]
    },
    "booleanValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyBooleanValue"
        },
        {
          "description": "The asset property value is a Boolean value that must be <code>'TRUE'</code> or <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a Boolean value."
        }
      ]
    }
  }
}