Amazon IoT Events · JSON Structure

Iot Events Email Configuration Structure

Contains the configuration information of email notifications.

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

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

Properties

from content 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-email-configuration-structure.json",
  "name": "EmailConfiguration",
  "description": "Contains the configuration information of email notifications.",
  "type": "object",
  "properties": {
    "from": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FromEmail"
        },
        {
          "description": "<p>The email address that sends emails.</p> <important> <p>If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html\">verify the email address that sends emails in Amazon SES</a>.</p> </important>"
        }
      ]
    },
    "content": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailContent"
        },
        {
          "description": "Contains the subject and message of an email."
        }
      ]
    },
    "recipients": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailRecipients"
        },
        {
          "description": "<p>Contains the information of one or more recipients who receive the emails.</p> <important> <p>You must <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html\">add the users that receive emails to your AWS SSO store</a>.</p> </important>"
        }
      ]
    }
  },
  "required": [
    "from",
    "recipients"
  ]
}