Skip to content

update_incident_record async

update_incident_record(
    arn: Arn,
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    title: Optional[IncidentTitle] = None,
    summary: Optional[IncidentSummary] = None,
    impact: Optional[Impact] = None,
    status: Optional[IncidentRecordStatus] = None,
    chat_channel: Optional[ChatChannel] = None,
    notification_targets: Optional[NotificationTargetSet] = None,
) -> UpdateIncidentRecordOutput

Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

Parameters:

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

    A token that ensures that a client calls the operation only once with the specified details.

  • arn (Arn) –

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

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

    A brief description of the incident.

  • summary (Optional[IncidentSummary], default: None ) –

    A longer description of what occurred during the incident.

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

    Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.

    Supported impact codes

    • 1 - Critical

    • 2 - High

    • 3 - Medium

    • 4 - Low

    • 5 - No Impact

  • status (Optional[IncidentRecordStatus], default: None ) –

    The status of the incident. Possible statuses are Open or Resolved.

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

    The Chatbot chat channel where responders can collaborate.

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

    The Amazon SNS targets that Incident Manager notifies when a client updates an incident.

    Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.

Raises:

Source code in docs_src/capo_ssm_incidents/_services/async_ssm_incidents.py
async def update_incident_record(
    self,
    arn: "capo_ssm_incidents.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
    client_token: Optional[
        "capo_ssm_incidents.types.client_token.ClientToken"
    ] = None,
    title: Optional["capo_ssm_incidents.types.incident_title.IncidentTitle"] = None,
    summary: Optional[
        "capo_ssm_incidents.types.incident_summary.IncidentSummary"
    ] = None,
    impact: Optional["capo_ssm_incidents.types.impact.Impact"] = None,
    status: Optional[
        "capo_ssm_incidents.types.incident_record_status.IncidentRecordStatus"
    ] = None,
    chat_channel: Optional[
        "capo_ssm_incidents.types.chat_channel.ChatChannel"
    ] = None,
    notification_targets: Optional[
        "capo_ssm_incidents.types.notification_target_set.NotificationTargetSet"
    ] = None,
) -> "capo_ssm_incidents.types.update_incident_record_output.UpdateIncidentRecordOutput":
    """<p>Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>

    Args:
        client_token: <p>A token that ensures that a client calls the operation only once with the specified details.</p>
        arn: <p>The Amazon Resource Name (ARN) of the incident record you are updating.</p>
        title: <p>A brief description of the incident.</p>
        summary: <p>A longer description of what occurred during the incident.</p>
        impact: <p>Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the 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>
        status: <p>The status of the incident. Possible statuses are <code>Open</code> or <code>Resolved</code>.</p>
        chat_channel: <p>The Chatbot chat channel where responders can collaborate.</p>
        notification_targets: <p>The Amazon SNS targets that Incident Manager notifies when a client updates an incident.</p> <p>Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_incidents.types.update_incident_record_input.UpdateIncidentRecordInput]",
    ) -> AsyncOperationResponse[
        "capo_ssm_incidents.types.update_incident_record_output.UpdateIncidentRecordOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.update_incident_record

        (
            output,
            http_response,
        ) = await capo_ssm_incidents._operations.ssm_incidents.update_incident_record.async_update_incident_record(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateIncidentRecord")
    )
    input_: capo_ssm_incidents.types.update_incident_record_input.UpdateIncidentRecordInput = {
        "arn": arn
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if title is not None:
        input_["title"] = title
    if summary is not None:
        input_["summary"] = summary
    if impact is not None:
        input_["impact"] = impact
    if status is not None:
        input_["status"] = status
    if chat_channel is not None:
        input_["chat_channel"] = chat_channel
    if notification_targets is not None:
        input_["notification_targets"] = notification_targets

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output