Amazon IoT Events · Schema

Events

Events schema

Event DetectionIoTState MachineAutomation
View JSON Schema on GitHub

JSON Schema

iot-events-events-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-events-schema.json",
  "title": "Events",
  "description": "Events schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "eventName"
    ],
    "properties": {
      "eventName": {
        "allOf": [
          {
            "$ref": "#/components/schemas/EventName"
          },
          {
            "description": "The name of the event."
          }
        ]
      },
      "condition": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Condition"
          },
          {
            "description": "Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE)."
          }
        ]
      },
      "actions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Actions"
          },
          {
            "description": "The actions to be performed."
          }
        ]
      }
    },
    "description": "Specifies the <code>actions</code> to be performed when the <code>condition</code> evaluates to TRUE."
  }
}