Skip to content

delete_timeline_event async

delete_timeline_event(
    incident_record_arn: Arn,
    event_id: UUID,
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
) -> DeleteTimelineEventOutput

Deletes a timeline event from an incident.

Parameters:

  • incident_record_arn (Arn) –

    The Amazon Resource Name (ARN) of the incident that includes the timeline event.

  • event_id (UUID) –

    The ID of the event to update. You can use ListTimelineEvents to find an event's ID.

Raises:

Source code in docs_src/capo_ssm_incidents/_services/async_ssm_incidents.py
async def delete_timeline_event(
    self,
    incident_record_arn: "capo_ssm_incidents.types.arn.Arn",
    event_id: "capo_ssm_incidents.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncSSMIncidentsClientConfig] = None,
) -> "capo_ssm_incidents.types.delete_timeline_event_output.DeleteTimelineEventOutput":
    """<p>Deletes a timeline event from an incident.</p>

    Args:
        incident_record_arn: <p>The Amazon Resource Name (ARN) of the incident that includes the timeline event.</p>
        event_id: <p>The ID of the event to update. You can use <code>ListTimelineEvents</code> to find an event's ID.</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.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</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.delete_timeline_event_input.DeleteTimelineEventInput]",
    ) -> AsyncOperationResponse[
        "capo_ssm_incidents.types.delete_timeline_event_output.DeleteTimelineEventOutput"
    ]:
        import capo_ssm_incidents._operations.ssm_incidents.delete_timeline_event

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTimelineEvent")
    )
    input_: capo_ssm_incidents.types.delete_timeline_event_input.DeleteTimelineEventInput = {
        "incident_record_arn": incident_record_arn,
        "event_id": event_id,
    }

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