Amazon IoT Events · Schema

EmailConfigurations

EmailConfigurations schema

Event DetectionIoTState MachineAutomation
View JSON Schema on GitHub

JSON Schema

iot-events-email-configurations-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-events/refs/heads/main/json-schema/iot-events-email-configurations-schema.json",
  "title": "EmailConfigurations",
  "description": "EmailConfigurations schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "from",
      "recipients"
    ],
    "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>"
          }
        ]
      }
    },
    "description": "Contains the configuration information of email notifications."
  }
}