Amazon IoT Events · JSON Structure

Iot Events S M S Configuration Structure

Contains the configuration information of SMS notifications.

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

SMSConfiguration 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

senderId additionalMessage recipients

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-s-m-s-configuration-structure.json",
  "name": "SMSConfiguration",
  "description": "Contains the configuration information of SMS notifications.",
  "type": "object",
  "properties": {
    "senderId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SMSSenderId"
        },
        {
          "description": "The sender ID."
        }
      ]
    },
    "additionalMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationAdditionalMessage"
        },
        {
          "description": "The message that you want to send. The message can be up to 200 characters."
        }
      ]
    },
    "recipients": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecipientDetails"
        },
        {
          "description": "<p>Specifies one or more recipients who receive the message.</p> <important> <p>You must <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html\">add the users that receive SMS messages to your AWS SSO store</a>.</p> </important>"
        }
      ]
    }
  },
  "required": [
    "recipients"
  ]
}