EventBridge / Client / list_event_buses

list_event_buses#

EventBridge.Client.list_event_buses(**kwargs)#

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

See also: AWS API Documentation

Request Syntax

response = client.list_event_buses(
    NamePrefix='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • NamePrefix (string) – Specifying this limits the results to only those event buses with names that start with the specified prefix.

  • NextToken (string) – The token returned by a previous call to retrieve the next set of results.

  • Limit (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'EventBuses': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Policy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • EventBuses (list) –

      This list of event buses.

      • (dict) –

        An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). Your account’s default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

        • Name (string) –

          The name of the event bus.

        • Arn (string) –

          The ARN of the event bus.

        • Policy (string) –

          The permissions policy of the event bus, describing which other Amazon Web Services accounts can write events to this event bus.

    • NextToken (string) –

      A token you can use in a subsequent operation to retrieve the next set of results.

Exceptions

  • EventBridge.Client.exceptions.InternalException