Skip to content

StartIncidentInput

Source code in docs_src/capo_ssm_incidents/types/start_incident_input.py
class StartIncidentInput(TypedDict, closed=True):
    client_token: NotRequired["capo_ssm_incidents.types.client_token.ClientToken"]
    """<p>A token ensuring that the operation is called only once with the specified details.</p>"""
    response_plan_arn: "capo_ssm_incidents.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident. </p>"""
    title: NotRequired["capo_ssm_incidents.types.incident_title.IncidentTitle"]
    """<p>Provide a title for the incident. Providing a title overwrites the title provided by the response plan. </p>"""
    impact: NotRequired["capo_ssm_incidents.types.impact.Impact"]
    """<p>Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.</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>"""
    trigger_details: NotRequired[
        "capo_ssm_incidents.types.trigger_details.TriggerDetails"
    ]
    """<p>Details of what created the incident record in Incident Manager.</p>"""
    related_items: NotRequired[
        "capo_ssm_incidents.types.related_item_list.RelatedItemList"
    ]
    """<p>Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket. </p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A token ensuring that the operation is called only once with the specified details.

impact instance-attribute

impact: NotRequired[Impact]

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

related_items instance-attribute

related_items: NotRequired[RelatedItemList]

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

response_plan_arn instance-attribute

response_plan_arn: Arn

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

title instance-attribute

title: NotRequired[IncidentTitle]

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

trigger_details instance-attribute

trigger_details: NotRequired[TriggerDetails]

Details of what created the incident record in Incident Manager.