Amazon IoT Events · JSON Structure

Iot Events Firehose Action Structure

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

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

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

Properties

deliveryStreamName separator payload

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-firehose-action-structure.json",
  "name": "FirehoseAction",
  "description": "Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.",
  "type": "object",
  "properties": {
    "deliveryStreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStreamName"
        },
        {
          "description": "The name of the Kinesis Data Firehose delivery stream where the data is written."
        }
      ]
    },
    "separator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FirehoseSeparator"
        },
        {
          "description": "A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma)."
        }
      ]
    },
    "payload": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Payload"
        },
        {
          "description": "You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream."
        }
      ]
    }
  },
  "required": [
    "deliveryStreamName"
  ]
}