Amazon IoT Events · JSON Structure

Iot Events Payload Structure

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Type: object Properties: 2 Required: 2
Event DetectionIoTState MachineAutomation

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

Properties

contentExpression type

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-payload-structure.json",
  "name": "Payload",
  "description": "<p>Information needed to configure the payload.</p> <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use <code>contentExpression</code>.</p>",
  "type": "object",
  "properties": {
    "contentExpression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContentExpression"
        },
        {
          "description": "The content of the payload. You can use a string expression that includes quoted strings (<code>'&lt;string&gt;'</code>), variables (<code>$variable.&lt;variable-name&gt;</code>), input values (<code>$input.&lt;input-name&gt;.&lt;path-to-datum&gt;</code>), string concatenations, and quoted strings that contain <code>${}</code> as the content. The recommended maximum size of a content expression is 1 KB."
        }
      ]
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PayloadType"
        },
        {
          "description": "The value of the payload type can be either <code>STRING</code> or <code>JSON</code>."
        }
      ]
    }
  },
  "required": [
    "contentExpression",
    "type"
  ]
}