IncidentRecord - AWS Systems Manager Incident Manager

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

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

Required: No

creationTime

The time that 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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: Yes

impact

The impact of the incident on customers and applications.

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 time at which the incident was most recently modified.

Type: Timestamp

Required: Yes

notificationTargets

The 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 time at which the incident was resolved. This appears as a timeline event.

Type: Timestamp

Required: No

status

The current status of the incident.

Type: String

Valid Values: OPEN | RESOLVED

Required: Yes

summary

The summary of the incident. The summary is a brief synopsis of what occurred, what is currently happening, and context.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4000.

Required: No

title

The title of the incident.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: