UpdateIncidentRecordInput

UpdateIncidentRecordInput schema

AutomationDevOpsIncident ManagementOperations

Properties

Name Type Description
arn object
chatChannel object
clientToken object
impact object
notificationTargets object
status object
summary object
title object
View JSON Schema on GitHub

JSON Schema

incident-manager-update-incident-record-input-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-update-incident-record-input-schema.json",
  "title": "UpdateIncidentRecordInput",
  "description": "UpdateIncidentRecordInput schema",
  "type": "object",
  "properties": {
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Arn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the incident record you are updating."
        }
      ]
    },
    "chatChannel": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChatChannel"
        },
        {
          "description": "The Chatbot chat channel where responders can collaborate."
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A token that ensures that a client calls the operation only once with the specified details."
        }
      ]
    },
    "impact": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Impact"
        },
        {
          "description": "<p>Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.</p> <p class=\"title\"> <b>Possible impacts:</b> </p> <ul> <li> <p> <code>1</code> - Critical impact, full application failure that impacts many to all customers. </p> </li> <li> <p> <code>2</code> - High impact, partial application failure with impact to many customers.</p> </li> <li> <p> <code>3</code> - Medium impact, the application is providing reduced service to customers.</p> </li> <li> <p> <code>4</code> - Low impact, customer aren't impacted by the problem yet.</p> </li> <li> <p> <code>5</code> - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.</p> </li> </ul>"
        }
      ]
    },
    "notificationTargets": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NotificationTargetSet"
        },
        {
          "description": "<p>The Amazon SNS targets that Incident Manager notifies when a client updates an incident.</p> <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.</p>"
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncidentRecordStatus"
        },
        {
          "description": "The status of the incident. Possible statuses are <code>Open</code> or <code>Resolved</code>."
        }
      ]
    },
    "summary": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncidentSummary"
        },
        {
          "description": "A longer description of what occurred during the incident."
        }
      ]
    },
    "title": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IncidentTitle"
        },
        {
          "description": "A brief description of the incident."
        }
      ]
    }
  },
  "required": [
    "arn"
  ]
}