Amazon Lookout for Metrics · JSON Structure

Amazon Lookout For Metrics Update Alert Request Structure

UpdateAlertRequest schema from Amazon Lookout for Metrics API

Type: object Properties: 5 Required: 1
Anomaly DetectionBusiness IntelligenceMachine LearningMetricsMonitoring

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

Properties

AlertArn AlertDescription AlertSensitivityThreshold Action 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-update-alert-request-structure.json",
  "name": "UpdateAlertRequest",
  "description": "UpdateAlertRequest schema from Amazon Lookout for Metrics API",
  "type": "object",
  "properties": {
    "AlertArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The ARN of the alert to update."
        }
      ]
    },
    "AlertDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlertDescription"
        },
        {
          "description": "A description of the alert."
        }
      ]
    },
    "AlertSensitivityThreshold": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SensitivityThreshold"
        },
        {
          "description": "An integer from 0 to 100 specifying the alert sensitivity threshold."
        }
      ]
    },
    "Action": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Action"
        },
        {
          "description": "Action that will be triggered when there is an alert."
        }
      ]
    },
    "AlertFilters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AlertFilters"
        },
        {
          "description": "The configuration of the alert filters, containing MetricList and DimensionFilterList."
        }
      ]
    }
  },
  "required": [
    "AlertArn"
  ]
}