Skip to content

list_event_buses

list_event_buses(
    *,
    config_overrides: Optional[EventBridgeV2ClientConfig] = None,
    name_prefix: Optional[EventBusName] = None,
    event_bus_account_id: Optional[AccountId] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListEventBusesResponse

Lists the event buses visible to the caller: buses the account owns and buses shared with it through AWS RAM. Shared entries carry identity fields only (Name, EventBusArn, EventBusAccountId); owned entries carry every summary field. Set EventBusAccountId to scope the list to one owner account.

Raises:

  • AccessDeniedException –

    The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.

  • InternalException –

    The request failed because of an internal service error. Retry the request.

  • InvalidInputException –

    A request parameter is missing or not valid.

  • ThrottlingException –

    The request was throttled because it exceeds a request rate limit. Retry the request with backoff.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_eventbridgev2/_services/event_bridge_v2.py
def list_event_buses(
    self,
    *,
    config_overrides: Optional[EventBridgeV2ClientConfig] = None,
    name_prefix: Optional[
        "capo_eventbridgev2.types.event_bus_name.EventBusName"
    ] = None,
    event_bus_account_id: Optional[
        "capo_eventbridgev2.types.account_id.AccountId"
    ] = None,
    next_token: Optional["capo_eventbridgev2.types.next_token.NextToken"] = None,
    max_results: Optional["capo_eventbridgev2.types.max_results.MaxResults"] = None,
) -> "capo_eventbridgev2.types.list_event_buses_response.ListEventBusesResponse":
    """Lists the event buses visible to the caller: buses the account owns and buses shared with it through AWS RAM. Shared entries carry identity fields only (Name, EventBusArn, EventBusAccountId); owned entries carry every summary field. Set EventBusAccountId to scope the list to one owner account.

    Raises:
        capo_eventbridgev2.errors.access_denied_exception.AccessDeniedException: The caller does not have the permissions required to perform the operation. This error is also returned when the operation cannot use the AWS KMS key for the event bus.
        capo_eventbridgev2.errors.internal_exception.InternalException: The request failed because of an internal service error. Retry the request.
        capo_eventbridgev2.errors.invalid_input_exception.InvalidInputException: A request parameter is missing or not valid.
        capo_eventbridgev2.errors.throttling_exception.ThrottlingException: The request was throttled because it exceeds a request rate limit. Retry the request with backoff.
        capo_eventbridgev2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridgev2.types.list_event_buses_request.ListEventBusesRequest]",
    ) -> OperationResponse[
        "capo_eventbridgev2.types.list_event_buses_response.ListEventBusesResponse"
    ]:
        import capo_eventbridgev2._operations.aws_events_v2.list_event_buses

        output, http_response = (
            capo_eventbridgev2._operations.aws_events_v2.list_event_buses.list_event_buses(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEventBuses")
    )
    input_: capo_eventbridgev2.types.list_event_buses_request.ListEventBusesRequest = {}
    if name_prefix is not None:
        input_["name_prefix"] = name_prefix
    if event_bus_account_id is not None:
        input_["event_bus_account_id"] = event_bus_account_id
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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