Amazon IoT Events · JSON Structure

Iot Events Notification Action Structure

Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.

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

NotificationAction 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

action smsConfigurations emailConfigurations

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-notification-action-structure.json",
  "name": "NotificationAction",
  "description": "Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.",
  "type": "object",
  "properties": {
    "action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationTargetActions"
        },
        {
          "description": "Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html\">AWS Lambda function provided by AWS IoT Events</a>."
        }
      ]
    },
    "smsConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SMSConfigurations"
        },
        {
          "description": "Contains the configuration information of SMS notifications."
        }
      ]
    },
    "emailConfigurations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailConfigurations"
        },
        {
          "description": "Contains the configuration information of email notifications."
        }
      ]
    }
  },
  "required": [
    "action"
  ]
}