Skip to content

/AWS1/CL_SMIINCIDENTTEMPLATE

Basic details used in creating a response plan. The response plan is then used to create an incident record.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_TITLE TYPE /AWS1/SMIINCIDENTTITLE /AWS1/SMIINCIDENTTITLE

The title of the incident.

IV_IMPACT TYPE /AWS1/SMIIMPACT /AWS1/SMIIMPACT

The impact of the incident on your customers and applications.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

Optional arguments:

IV_SUMMARY TYPE /AWS1/SMIINCIDENTSUMMARY /AWS1/SMIINCIDENTSUMMARY

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

IV_DEDUPESTRING TYPE /AWS1/SMIDEDUPESTRING /AWS1/SMIDEDUPESTRING

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 dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

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.

IT_NOTIFICATIONTARGETS TYPE /AWS1/CL_SMINOTIFTARGETITEM=>TT_NOTIFICATIONTARGETSET TT_NOTIFICATIONTARGETSET

The Amazon SNS targets that are notified when updates are made to an incident.

IT_INCIDENTTAGS TYPE /AWS1/CL_SMITAGMAP_W=>TT_TAGMAP TT_TAGMAP

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.


Queryable Attributes

title

The title of the incident.

Accessible with the following methods

Method Description
GET_TITLE() Getter for TITLE, with configurable default
ASK_TITLE() Getter for TITLE w/ exceptions if field has no value
HAS_TITLE() Determine if TITLE has a value

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

Accessible with the following methods

Method Description
GET_IMPACT() Getter for IMPACT, with configurable default
ASK_IMPACT() Getter for IMPACT w/ exceptions if field has no value
HAS_IMPACT() Determine if IMPACT has a value

summary

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

Accessible with the following methods

Method Description
GET_SUMMARY() Getter for SUMMARY, with configurable default
ASK_SUMMARY() Getter for SUMMARY w/ exceptions if field has no value
HAS_SUMMARY() Determine if SUMMARY has a value

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 dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

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.

Accessible with the following methods

Method Description
GET_DEDUPESTRING() Getter for DEDUPESTRING, with configurable default
ASK_DEDUPESTRING() Getter for DEDUPESTRING w/ exceptions if field has no value
HAS_DEDUPESTRING() Determine if DEDUPESTRING has a value

notificationTargets

The Amazon SNS targets that are notified when updates are made to an incident.

Accessible with the following methods

Method Description
GET_NOTIFICATIONTARGETS() Getter for NOTIFICATIONTARGETS, with configurable default
ASK_NOTIFICATIONTARGETS() Getter for NOTIFICATIONTARGETS w/ exceptions if field has no
HAS_NOTIFICATIONTARGETS() Determine if NOTIFICATIONTARGETS has a value

incidentTags

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

Accessible with the following methods

Method Description
GET_INCIDENTTAGS() Getter for INCIDENTTAGS, with configurable default
ASK_INCIDENTTAGS() Getter for INCIDENTTAGS w/ exceptions if field has no value
HAS_INCIDENTTAGS() Determine if INCIDENTTAGS has a value