Skip to content

IncidentTemplate

Source code in docs_src/capo_ssm_incidents/types/incident_template.py
class IncidentTemplate(TypedDict, closed=True):
    title: "capo_ssm_incidents.types.incident_title.IncidentTitle"
    """<p>The title of the incident. </p>"""
    impact: "capo_ssm_incidents.types.impact.Impact"
    """<p>The impact of the incident on your customers and applications.</p> <p class="title"> <b>Supported impact codes</b> </p> <ul> <li> <p> <code>1</code> - Critical</p> </li> <li> <p> <code>2</code> - High</p> </li> <li> <p> <code>3</code> - Medium</p> </li> <li> <p> <code>4</code> - Low</p> </li> <li> <p> <code>5</code> - No Impact</p> </li> </ul>"""
    summary: NotRequired["capo_ssm_incidents.types.incident_summary.IncidentSummary"]
    """<p>The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.</p>"""
    dedupe_string: NotRequired["capo_ssm_incidents.types.dedupe_string.DedupeString"]
    """<p>The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.</p> <p>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 <code>dedupeString</code> field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.</p> <note> <p>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.</p> </note>"""
    notification_targets: NotRequired[
        "capo_ssm_incidents.types.notification_target_set.NotificationTargetSet"
    ]
    """<p>The Amazon SNS targets that are notified when updates are made to an incident.</p>"""
    incident_tags: NotRequired["capo_ssm_incidents.types.tag_map.TagMap"]
    """<p>Tags to assign to the template. When the <code>StartIncident</code> API action is called, Incident Manager assigns the tags specified in the template to the incident.</p>"""

dedupe_string instance-attribute

dedupe_string: NotRequired[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.

impact instance-attribute

impact: 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

incident_tags instance-attribute

incident_tags: NotRequired[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.

notification_targets instance-attribute

notification_targets: NotRequired[NotificationTargetSet]

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

summary instance-attribute

summary: NotRequired[IncidentSummary]

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

title instance-attribute

The title of the incident.