IncidentRecord
The record of the incident that's created when an incident occurs.
Contents
- arn
-
The Amazon Resource Name (ARN) of the incident record.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+Required: Yes
- creationTime
-
The timestamp for when Incident Manager created the incident record.
Type: Timestamp
Required: Yes
- dedupeString
-
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: Yes
- impact
-
The impact of the incident on 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
-
- incidentRecordSource
-
Details about the action that started the incident.
Type: IncidentRecordSource object
Required: Yes
- lastModifiedBy
-
Who modified the incident most recently.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+Required: Yes
- lastModifiedTime
-
The timestamp for when the incident was most recently modified.
Type: Timestamp
Required: Yes
- status
-
The current status of the incident.
Type: String
Valid Values:
OPEN | RESOLVEDRequired: Yes
- title
-
The title of the incident.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
Required: Yes
- automationExecutions
-
The runbook, or automation document, that's run at the beginning of the incident.
Type: Array of AutomationExecution objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- chatChannel
-
The chat channel used for collaboration during an incident.
Type: ChatChannel object
Note: This object is a Union. Only one member of this object can be specified or returned.
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
- resolvedTime
-
The timestamp for when the incident was resolved. This appears as a timeline event.
Type: Timestamp
Required: No
- summary
-
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
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:
