Skip to content

deactivate_event_source async 

deactivate_event_source(
    name: EventSourceName,
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
) -> None

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Parameters:

  • name (EventSourceName) –

    The name of the partner event source to deactivate.

Raises:

Source code in docs_src/capo_eventbridge/_services/async_event_bridge.py 
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
async def deactivate_event_source(
    self,
    name: "capo_eventbridge.types.event_source_name.EventSourceName",
    *,
    config_overrides: Optional[AsyncEventBridgeClientConfig] = None,
) -> None:
    """<p>You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. </p> <p>When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.</p> <p>To activate a deactivated partner event source, use <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html">ActivateEventSource</a>.</p>

    Args:
        name: <p>The name of the partner event source to deactivate.</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.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.invalid_state_exception.InvalidStateException: <p>The specified state is not a valid state for an event source.</p>
        capo_eventbridge.errors.operation_disabled_exception.OperationDisabledException: <p>The operation you are attempting is not available in this region.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_eventbridge.types.deactivate_event_source_request.DeactivateEventSourceRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_eventbridge._operations.aws_events.deactivate_event_source

        (
            output,
            http_response,
        ) = await capo_eventbridge._operations.aws_events.deactivate_event_source.async_deactivate_event_source(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeactivateEventSource")
    )
    input_: capo_eventbridge.types.deactivate_event_source_request.DeactivateEventSourceRequest = {
        "name": name
    }

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