IotSiteWiseAction

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/json-schema/iot-events-iot-site-wise-action-schema.json",
  "title": "IotSiteWiseAction",
  "description": "<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The expressions accept literals, operators, functions, references, and substitutions 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>propertyAlias</code> parameter can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>assetId</code> parameter can be <code>$input.TurbineInput.assetId1</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>propertyAlias</code> parameter uses a substitution template. </p> <p> <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code> </p> </li> </ul> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> <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": {
    "entryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyEntryId"
        },
        {
          "description": "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."
        }
      ]
    },
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetId"
        },
        {
          "description": "The ID of the asset that has the specified property."
        }
      ]
    },
    "propertyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyId"
        },
        {
          "description": "The ID of the asset property."
        }
      ]
    },
    "propertyAlias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyAlias"
        },
        {
          "description": "The alias of the asset property."
        }
      ]
    },
    "propertyValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyValue"
        },
        {
          "description": "The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. "
        }
      ]
    }
  }
}