Amazon IoT Events · JSON Structure

Iot Events Iot Topic Publish Action Structure

Information required to publish the MQTT message through the AWS IoT message broker.

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

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

Properties

mqttTopic 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-iot-topic-publish-action-structure.json",
  "name": "IotTopicPublishAction",
  "description": "Information required to publish the MQTT message through the AWS IoT message broker.",
  "type": "object",
  "properties": {
    "mqttTopic": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MQTTTopic"
        },
        {
          "description": "The MQTT topic of the message. You can use a string expression that includes variables (<code>$variable.&lt;variable-name&gt;</code>) and input values (<code>$input.&lt;input-name&gt;.&lt;path-to-datum&gt;</code>) as the topic string."
        }
      ]
    },
    "payload": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Payload"
        },
        {
          "description": "You can configure the action payload when you publish a message to an AWS IoT Core topic."
        }
      ]
    }
  },
  "required": [
    "mqttTopic"
  ]
}