Skip to content

list_event_sources

list_event_sources(
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
    name_prefix: Optional[EventSourceNamePrefix] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[LimitMax100] = None,
) -> ListEventSourcesResponse

You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.

Parameters:

  • name_prefix (Optional[EventSourceNamePrefix], default: None ) –

    Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

  • next_token (Optional[NextToken], default: None ) –

    The token returned by a previous call, which you can use to retrieve the next set of results.

    The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

    Using an expired pagination token results in an HTTP 400 InvalidToken error.

  • limit (Optional[LimitMax100], default: None ) –

    Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.

Raises:

Source code in docs_src/capo_eventbridge/_services/event_bridge.py
def list_event_sources(
    self,
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
    name_prefix: Optional[
        "capo_eventbridge.types.event_source_name_prefix.EventSourceNamePrefix"
    ] = None,
    next_token: Optional["capo_eventbridge.types.next_token.NextToken"] = None,
    limit: Optional["capo_eventbridge.types.limit_max100.LimitMax100"] = None,
) -> "capo_eventbridge.types.list_event_sources_response.ListEventSourcesResponse":
    """<p>You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html">CreateEventBus</a>.</p>

    Args:
        name_prefix: <p>Specifying this limits the results to only those partner event sources with names that start with the specified prefix.</p>
        next_token: <p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p> Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>
        limit: <p>Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.</p>

    Raises:
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.operation_disabled_exception.OperationDisabledException: <p>The operation you are attempting is not available in this region.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridge.types.list_event_sources_request.ListEventSourcesRequest]",
    ) -> OperationResponse[
        "capo_eventbridge.types.list_event_sources_response.ListEventSourcesResponse"
    ]:
        import capo_eventbridge._operations.aws_events.list_event_sources

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEventSources")
    )
    input_: capo_eventbridge.types.list_event_sources_request.ListEventSourcesRequest = {}
    if name_prefix is not None:
        input_["name_prefix"] = name_prefix
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

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