Amazon Lookout for Metrics · JSON Structure

Amazon Lookout For Metrics Sns Configuration Structure

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.

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

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

Properties

RoleArn SnsTopicArn SnsFormat

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-sns-configuration-structure.json",
  "name": "SNSConfiguration",
  "description": "Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.",
  "type": "object",
  "properties": {
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The ARN of the IAM role that has access to the target SNS topic."
        }
      ]
    },
    "SnsTopicArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The ARN of the target SNS topic."
        }
      ]
    },
    "SnsFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SnsFormat"
        },
        {
          "description": "<p>The format of the SNS topic.</p> <ul> <li> <p> <code>JSON</code> \u2013 Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.</p> </li> <li> <p> <code>LONG_TEXT</code> \u2013 Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.</p> </li> <li> <p> <code>SHORT_TEXT</code> \u2013 Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.</p> </li> </ul>"
        }
      ]
    }
  },
  "required": [
    "RoleArn",
    "SnsTopicArn"
  ]
}