Skip to content

IncidentRecord

Source code in docs_src/capo_ssm_incidents/types/incident_record.py
class IncidentRecord(TypedDict, closed=True):
    arn: "capo_ssm_incidents.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the incident record.</p>"""
    title: "capo_ssm_incidents.types.incident_title.IncidentTitle"
    """<p>The title of the incident.</p>"""
    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 of the incident.</p>"""
    status: "capo_ssm_incidents.types.incident_record_status.IncidentRecordStatus"
    """<p>The current status of the incident.</p>"""
    impact: "capo_ssm_incidents.types.impact.Impact"
    """<p>The impact of the incident on 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>"""
    creation_time: "datetime.datetime"
    """<p>The timestamp for when Incident Manager created the incident record.</p>"""
    resolved_time: NotRequired["datetime.datetime"]
    """<p>The timestamp for when the incident was resolved. This appears as a timeline event.</p>"""
    last_modified_time: "datetime.datetime"
    """<p>The timestamp for when the incident was most recently modified.</p>"""
    last_modified_by: "capo_ssm_incidents.types.arn.Arn"
    """<p>Who modified the incident most recently.</p>"""
    automation_executions: NotRequired[
        "capo_ssm_incidents.types.automation_execution_set.AutomationExecutionSet"
    ]
    """<p>The runbook, or automation document, that's run at the beginning of the incident.</p>"""
    incident_record_source: (
        "capo_ssm_incidents.types.incident_record_source.IncidentRecordSource"
    )
    """<p>Details about the action that started the incident.</p>"""
    dedupe_string: "capo_ssm_incidents.types.dedupe_string.DedupeString"
    """<p>The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.</p>"""
    chat_channel: NotRequired["capo_ssm_incidents.types.chat_channel.ChatChannel"]
    """<p>The chat channel used for collaboration during an incident.</p>"""
    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>"""

arn instance-attribute

arn: Arn

The Amazon Resource Name (ARN) of the incident record.

automation_executions instance-attribute

automation_executions: NotRequired[AutomationExecutionSet]

The runbook, or automation document, that's run at the beginning of the incident.

chat_channel instance-attribute

chat_channel: NotRequired[ChatChannel]

The chat channel used for collaboration during an incident.

creation_time instance-attribute

creation_time: datetime

The timestamp for when Incident Manager created the incident record.

dedupe_string instance-attribute

dedupe_string: DedupeString

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

impact instance-attribute

impact: Impact

The impact of the incident on customers and applications.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

incident_record_source instance-attribute

incident_record_source: IncidentRecordSource

Details about the action that started the incident.

last_modified_by instance-attribute

last_modified_by: Arn

Who modified the incident most recently.

last_modified_time instance-attribute

last_modified_time: datetime

The timestamp for when the incident was most recently modified.

notification_targets instance-attribute

notification_targets: NotRequired[NotificationTargetSet]

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

resolved_time instance-attribute

resolved_time: NotRequired[datetime]

The timestamp for when the incident was resolved. This appears as a timeline event.

status instance-attribute

The current status of the 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 of the incident.

title instance-attribute

The title of the incident.