IncidentTemplate
Basic details used in creating a response plan. The response plan is then used to create an incident record.
Contents
- impact
-
The impact of the incident on your customers and applications.
Supported impact codes
-
1- Critical -
2- High -
3- Medium -
4- Low -
5- No Impact
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 5.
Required: Yes
-
- title
-
The title of the incident.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- dedupeString
-
The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.
A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the
dedupeStringfield when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.Note
By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
- incidentTags
-
Tags to assign to the template. When the
StartIncidentAPI action is called, Incident Manager assigns the tags specified in the template to the incident.Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^[A-Za-z0-9 _=@:.+-/]*$Required: No
- notificationTargets
-
The Amazon SNS targets that are notified when updates are made to an incident.
Type: Array of NotificationTargetItem objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- summary
-
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
