{ "$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": "
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.
Possible impacts:
1 - Critical impact, full application failure that impacts many to all customers.
2 - High impact, partial application failure with impact to many customers.
3 - Medium impact, the application is providing reduced service to customers.
4 - Low impact, customer aren't impacted by the problem yet.
5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
The Amazon SNS targets that Incident Manager notifies when a client updates an incident.
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/IncidentRecordStatus" }, { "description": "The status of the incident. Possible statuses areOpen or Resolved."
}
]
},
"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"
]
}