Skip to content

UpdateResponsePlanInput

Source code in docs_src/capo_ssm_incidents/types/update_response_plan_input.py
class UpdateResponsePlanInput(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>"""
    arn: "capo_ssm_incidents.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the response plan.</p>"""
    display_name: NotRequired[
        "capo_ssm_incidents.types.response_plan_display_name.ResponsePlanDisplayName"
    ]
    """<p>The long format name of the response plan. The display name can't contain spaces.</p>"""
    incident_template_title: NotRequired[
        "capo_ssm_incidents.types.incident_title.IncidentTitle"
    ]
    """<p>The short format name of the incident. The title can't contain spaces.</p>"""
    incident_template_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>"""
    incident_template_summary: NotRequired[
        "capo_ssm_incidents.types.incident_summary.IncidentSummary"
    ]
    """<p>A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.</p>"""
    incident_template_dedupe_string: NotRequired[
        "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>"""
    incident_template_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>"""
    chat_channel: NotRequired["capo_ssm_incidents.types.chat_channel.ChatChannel"]
    """<p>The Chatbot chat channel used for collaboration during an incident.</p> <p>Use the empty structure to remove the chat channel from the response plan.</p>"""
    engagements: NotRequired["capo_ssm_incidents.types.engagement_set.EngagementSet"]
    """<p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.</p>"""
    actions: NotRequired["capo_ssm_incidents.types.actions_list.ActionsList"]
    """<p>The actions that this response plan takes at the beginning of an incident.</p>"""
    incident_template_tags: NotRequired[
        "capo_ssm_incidents.types.tag_map_update.TagMapUpdate"
    ]
    """<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. To call this action, you must also have permission to call the <code>TagResource</code> API action for the incident record resource.</p>"""
    integrations: NotRequired["capo_ssm_incidents.types.integrations.Integrations"]
    """<p>Information about third-party services integrated into the response plan.</p>"""

actions instance-attribute

actions: NotRequired[ActionsList]

The actions that this response plan takes at the beginning of an incident.

arn instance-attribute

arn: Arn

The Amazon Resource Name (ARN) of the response plan.

chat_channel instance-attribute

chat_channel: NotRequired[ChatChannel]

The Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

display_name instance-attribute

display_name: NotRequired[ResponsePlanDisplayName]

The long format name of the response plan. The display name can't contain spaces.

engagements instance-attribute

engagements: NotRequired[EngagementSet]

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incident_template_dedupe_string instance-attribute

incident_template_dedupe_string: NotRequired[DedupeString]

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

incident_template_impact instance-attribute

incident_template_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

incident_template_notification_targets instance-attribute

incident_template_notification_targets: NotRequired[NotificationTargetSet]

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

incident_template_summary instance-attribute

incident_template_summary: NotRequired[IncidentSummary]

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

incident_template_tags instance-attribute

incident_template_tags: NotRequired[TagMapUpdate]

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. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

incident_template_title instance-attribute

incident_template_title: NotRequired[IncidentTitle]

The short format name of the incident. The title can't contain spaces.

integrations instance-attribute

integrations: NotRequired[Integrations]

Information about third-party services integrated into the response plan.