Amazon Incident Manager · JSON Structure

Incident Manager Incident Template Structure

Basic details used in creating a response plan. The response plan is then used to create an incident record.

Type: object Properties: 6 Required: 2
AutomationDevOpsIncident ManagementOperations

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

Properties

dedupeString impact incidentTags notificationTargets summary title

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-incident-manager/refs/heads/main/json-structure/incident-manager-incident-template-structure.json",
  "name": "IncidentTemplate",
  "description": "Basic details used in creating a response plan. The response plan is then used to create an incident record.",
  "type": "object",
  "properties": {
    "dedupeString": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DedupeString"
        },
        {
          "description": "Used to stop Incident Manager from creating multiple incident records for the same incident. "
        }
      ]
    },
    "impact": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Impact"
        },
        {
          "description": "The impact of the incident on your customers and applications. "
        }
      ]
    },
    "incidentTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagMap"
        },
        {
          "description": "Tags to assign to the template. When the <code>StartIncident</code> API action is called, Incident Manager assigns the tags specified in the template to the incident."
        }
      ]
    },
    "notificationTargets": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationTargetSet"
        },
        {
          "description": "The Amazon SNS targets that are notified when updates are made to an incident."
        }
      ]
    },
    "summary": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncidentSummary"
        },
        {
          "description": "The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context."
        }
      ]
    },
    "title": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncidentTitle"
        },
        {
          "description": "The title of the incident. "
        }
      ]
    }
  },
  "required": [
    "impact",
    "title"
  ]
}