Skip to content

cancel_replay

cancel_replay(
    replay_name: ReplayName,
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
) -> CancelReplayResponse

Cancels the specified replay.

Parameters:

  • replay_name (ReplayName) –

    The name of the replay to cancel.

Raises:

Source code in docs_src/capo_eventbridge/_services/event_bridge.py
def cancel_replay(
    self,
    replay_name: "capo_eventbridge.types.replay_name.ReplayName",
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
) -> "capo_eventbridge.types.cancel_replay_response.CancelReplayResponse":
    """<p>Cancels the specified replay.</p>

    Args:
        replay_name: <p>The name of the replay to cancel.</p>

    Raises:
        capo_eventbridge.errors.concurrent_modification_exception.ConcurrentModificationException: <p>There is concurrent modification on a rule, target, archive, or replay.</p>
        capo_eventbridge.errors.illegal_status_exception.IllegalStatusException: <p>An error occurred because a replay can be canceled only when the state is Running or Starting.</p>
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridge.types.cancel_replay_request.CancelReplayRequest]",
    ) -> OperationResponse[
        "capo_eventbridge.types.cancel_replay_response.CancelReplayResponse"
    ]:
        import capo_eventbridge._operations.aws_events.cancel_replay

        output, http_response = (
            capo_eventbridge._operations.aws_events.cancel_replay.cancel_replay(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelReplay")
    )
    input_: capo_eventbridge.types.cancel_replay_request.CancelReplayRequest = {
        "replay_name": replay_name
    }

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