IncidentTemplate

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

AutomationDevOpsIncident ManagementOperations

Properties

Name Type Description
dedupeString object
impact object
incidentTags object
notificationTargets object
summary object
title object
View JSON Schema on GitHub

JSON Schema

incident-manager-incident-template-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/json-schema/incident-manager-incident-template-schema.json",
  "title": "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"
  ]
}