Skip to content

update_response_plan

update_response_plan(
    arn: Arn,
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    display_name: Optional[ResponsePlanDisplayName] = None,
    incident_template_title: Optional[IncidentTitle] = None,
    incident_template_impact: Optional[Impact] = None,
    incident_template_summary: Optional[IncidentSummary] = None,
    incident_template_dedupe_string: Optional[DedupeString] = None,
    incident_template_notification_targets: Optional[NotificationTargetSet] = None,
    chat_channel: Optional[ChatChannel] = None,
    engagements: Optional[EngagementSet] = None,
    actions: Optional[ActionsList] = None,
    incident_template_tags: Optional[TagMapUpdate] = None,
    integrations: Optional[Integrations] = None,
) -> UpdateResponsePlanOutput

Updates the specified response plan.

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

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

  • arn (Arn) –

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

  • display_name (Optional[ResponsePlanDisplayName], default: None ) –

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

  • incident_template_title (Optional[IncidentTitle], default: None ) –

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

  • incident_template_impact (Optional[Impact], default: None ) –

    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_summary (Optional[IncidentSummary], default: None ) –

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

  • incident_template_dedupe_string (Optional[DedupeString], default: None ) –

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

  • incident_template_notification_targets (Optional[NotificationTargetSet], default: None ) –

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

  • chat_channel (Optional[ChatChannel], default: None ) –

    The Chatbot chat channel used for collaboration during an incident.

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

  • engagements (Optional[EngagementSet], default: None ) –

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

  • actions (Optional[ActionsList], default: None ) –

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

  • incident_template_tags (Optional[TagMapUpdate], default: None ) –

    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.

  • integrations (Optional[Integrations], default: None ) –

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

Raises:

Source code in docs_src/capo_ssm_incidents/_services/ssm_incidents.py
def update_response_plan(
    self,
    arn: "capo_ssm_incidents.types.arn.Arn",
    *,
    config_overrides: Optional[SSMIncidentsClientConfig] = None,
    client_token: Optional[
        "capo_ssm_incidents.types.client_token.ClientToken"
    ] = None,
    display_name: Optional[
        "capo_ssm_incidents.types.response_plan_display_name.ResponsePlanDisplayName"
    ] = None,
    incident_template_title: Optional[
        "capo_ssm_incidents.types.incident_title.IncidentTitle"
    ] = None,
    incident_template_impact: Optional[
        "capo_ssm_incidents.types.impact.Impact"
    ] = None,
    incident_template_summary: Optional[
        "capo_ssm_incidents.types.incident_summary.IncidentSummary"
    ] = None,
    incident_template_dedupe_string: Optional[
        "capo_ssm_incidents.types.dedupe_string.DedupeString"
    ] = None,
    incident_template_notification_targets: Optional[
        "capo_ssm_incidents.types.notification_target_set.NotificationTargetSet"
    ] = None,
    chat_channel: Optional[
        "capo_ssm_incidents.types.chat_channel.ChatChannel"
    ] = None,
    engagements: Optional[
        "capo_ssm_incidents.types.engagement_set.EngagementSet"
    ] = None,
    actions: Optional["capo_ssm_incidents.types.actions_list.ActionsList"] = None,
    incident_template_tags: Optional[
        "capo_ssm_incidents.types.tag_map_update.TagMapUpdate"
    ] = None,
    integrations: Optional[
        "capo_ssm_incidents.types.integrations.Integrations"
    ] = None,
) -> (
    "capo_ssm_incidents.types.update_response_plan_output.UpdateResponsePlanOutput"
):
    """<p>Updates the specified response plan.</p>

    Args:
        client_token: <p>A token ensuring that the operation is called only once with the specified details.</p>
        arn: <p>The Amazon Resource Name (ARN) of the response plan.</p>
        display_name: <p>The long format name of the response plan. The display name can't contain spaces.</p>
        incident_template_title: <p>The short format name of the incident. The title can't contain spaces.</p>
        incident_template_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: <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: <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: <p>The Amazon SNS targets that are notified when updates are made to an incident.</p>
        chat_channel: <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: <p>The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.</p>
        actions: <p>The actions that this response plan takes at the beginning of an incident.</p>
        incident_template_tags: <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: <p>Information about third-party services integrated into the response plan.</p>

    Raises:
        capo_ssm_incidents.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
        capo_ssm_incidents.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource causes an inconsistent state.</p>
        capo_ssm_incidents.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_ssm_incidents.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which doesn't exist. </p>
        capo_ssm_incidents.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_ssm_incidents.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ssm_incidents.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_incidents.types.update_response_plan_input.UpdateResponsePlanInput]",
    ) -> OperationResponse[
        "capo_ssm_incidents.types.update_response_plan_output.UpdateResponsePlanOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.update_response_plan

        output, http_response = (
            capo_ssm_incidents._operations.ssm_incidents.update_response_plan.update_response_plan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateResponsePlan")
    )
    input_: capo_ssm_incidents.types.update_response_plan_input.UpdateResponsePlanInput = {
        "arn": arn
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if display_name is not None:
        input_["display_name"] = display_name
    if incident_template_title is not None:
        input_["incident_template_title"] = incident_template_title
    if incident_template_impact is not None:
        input_["incident_template_impact"] = incident_template_impact
    if incident_template_summary is not None:
        input_["incident_template_summary"] = incident_template_summary
    if incident_template_dedupe_string is not None:
        input_["incident_template_dedupe_string"] = incident_template_dedupe_string
    if incident_template_notification_targets is not None:
        input_["incident_template_notification_targets"] = (
            incident_template_notification_targets
        )
    if chat_channel is not None:
        input_["chat_channel"] = chat_channel
    if engagements is not None:
        input_["engagements"] = engagements
    if actions is not None:
        input_["actions"] = actions
    if incident_template_tags is not None:
        input_["incident_template_tags"] = incident_template_tags
    if integrations is not None:
        input_["integrations"] = integrations

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output