Skip to content

list_event_sources async

list_event_sources(
    *,
    config_overrides: Optional[AsyncCloudWatchEventsClientConfig] = 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 to retrieve the next set of results.

  • 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_cloudwatch_events/_services/async_cloud_watch_events.py
async def list_event_sources(
    self,
    *,
    config_overrides: Optional[AsyncCloudWatchEventsClientConfig] = None,
    name_prefix: Optional[
        "capo_cloudwatch_events.types.event_source_name_prefix.EventSourceNamePrefix"
    ] = None,
    next_token: Optional[
        "capo_cloudwatch_events.types.next_token.NextToken"
    ] = None,
    limit: Optional["capo_cloudwatch_events.types.limit_max100.LimitMax100"] = None,
) -> "capo_cloudwatch_events.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 to retrieve the next set of results.</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_cloudwatch_events.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_cloudwatch_events.errors.operation_disabled_exception.OperationDisabledException: <p>The operation you are attempting is not available in this region.</p>
        capo_cloudwatch_events.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_events.types.list_event_sources_request.ListEventSourcesRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_events.types.list_event_sources_response.ListEventSourcesResponse"
    ]:
        import capo_cloudwatch_events._operations.aws_events.list_event_sources

        (
            output,
            http_response,
        ) = await capo_cloudwatch_events._operations.aws_events.list_event_sources.async_list_event_sources(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEventSources")
    )
    input_: capo_cloudwatch_events.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output