Amazon Lookout for Metrics · JSON Structure

Amazon Lookout For Metrics Create Alert Request Structure

CreateAlertRequest schema from Amazon Lookout for Metrics API

Type: object Properties: 7 Required: 3
Anomaly DetectionBusiness IntelligenceMachine LearningMetricsMonitoring

CreateAlertRequest is a JSON Structure definition published by Amazon Lookout for Metrics, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

AlertName AlertSensitivityThreshold AlertDescription AnomalyDetectorArn Action Tags AlertFilters

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-lookout-for-metrics/refs/heads/main/json-structure/amazon-lookout-for-metrics-create-alert-request-structure.json",
  "name": "CreateAlertRequest",
  "description": "CreateAlertRequest schema from Amazon Lookout for Metrics API",
  "type": "object",
  "properties": {
    "AlertName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlertName"
        },
        {
          "description": "The name of the alert."
        }
      ]
    },
    "AlertSensitivityThreshold": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitivityThreshold"
        },
        {
          "description": "An integer from 0 to 100 specifying the alert sensitivity threshold."
        }
      ]
    },
    "AlertDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlertDescription"
        },
        {
          "description": "A description of the alert."
        }
      ]
    },
    "AnomalyDetectorArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The ARN of the detector to which the alert is attached."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Action"
        },
        {
          "description": "Action that will be triggered when there is an alert."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "A list of <a href=\"https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html\">tags</a> to apply to the alert."
        }
      ]
    },
    "AlertFilters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlertFilters"
        },
        {
          "description": "The configuration of the alert filters, containing MetricList and DimensionFilterList."
        }
      ]
    }
  },
  "required": [
    "AlertName",
    "AnomalyDetectorArn",
    "Action"
  ]
}