Amazon IoT Events · JSON Structure

Iot Events State Structure

Information that defines a state of a detector.

Type: object Properties: 4 Required: 1
Event DetectionIoTState MachineAutomation

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

Properties

stateName onInput onEnter onExit

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

JSON Structure

Raw ↑
{
  "$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-state-structure.json",
  "name": "State",
  "description": "Information that defines a state of a detector.",
  "type": "object",
  "properties": {
    "stateName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StateName"
        },
        {
          "description": "The name of the state."
        }
      ]
    },
    "onInput": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OnInputLifecycle"
        },
        {
          "description": "When an input is received and the <code>condition</code> is TRUE, perform the specified <code>actions</code>."
        }
      ]
    },
    "onEnter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OnEnterLifecycle"
        },
        {
          "description": "When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE."
        }
      ]
    },
    "onExit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OnExitLifecycle"
        },
        {
          "description": "When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is <code>TRUE</code>."
        }
      ]
    }
  },
  "required": [
    "stateName"
  ]
}