Amazon IoT Events · Schema

Attributes

Attributes schema

Event DetectionIoTState MachineAutomation
View JSON Schema on GitHub

JSON Schema

iot-events-attributes-schema.json Raw ↑
{
  "$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-attributes-schema.json",
  "title": "Attributes",
  "description": "Attributes schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "jsonPath"
    ],
    "properties": {
      "jsonPath": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AttributeJsonPath"
          },
          {
            "description": "<p>An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (<code>BatchPutMessage</code>). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the <code>condition</code> expressions used by detectors. </p> <p>Syntax: <code>&lt;field-name&gt;.&lt;field-name&gt;...</code> </p>"
          }
        ]
      }
    },
    "description": "The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors. "
  }
}