Amazon IoT Events · JSON Structure

Iot Events Update Alarm Model Request Structure

UpdateAlarmModelRequest schema

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

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

Properties

alarmModelDescription roleArn severity alarmRule alarmNotification alarmEventActions alarmCapabilities

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-update-alarm-model-request-structure.json",
  "name": "UpdateAlarmModelRequest",
  "description": "UpdateAlarmModelRequest schema",
  "type": "object",
  "properties": {
    "alarmModelDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlarmModelDescription"
        },
        {
          "description": "The description of the alarm model."
        }
      ]
    },
    "roleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmazonResourceName"
        },
        {
          "description": "The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>."
        }
      ]
    },
    "severity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Severity"
        },
        {
          "description": "A non-negative integer that reflects the severity level of the alarm."
        }
      ]
    },
    "alarmRule": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlarmRule"
        },
        {
          "description": "Defines when your alarm is invoked."
        }
      ]
    },
    "alarmNotification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlarmNotification"
        },
        {
          "description": "Contains information about one or more notification actions."
        }
      ]
    },
    "alarmEventActions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlarmEventActions"
        },
        {
          "description": "Contains information about one or more alarm actions."
        }
      ]
    },
    "alarmCapabilities": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlarmCapabilities"
        },
        {
          "description": "Contains the configuration information of alarm state changes."
        }
      ]
    }
  },
  "required": [
    "roleArn",
    "alarmRule"
  ]
}