EventBridgeV2 / Paginator / ListEventBuses

ListEventBuses¶

class EventBridgeV2.Paginator.ListEventBuses¶

paginator = client.get_paginator('list_event_buses')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EventBridgeV2.Client.list_event_buses().

Request Syntax

response_iterator = paginator.paginate(
    NamePrefix='string',
    EventBusAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

NamePrefix (string) – Name of an event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus’s ARN. The same type is used everywhere a bus name appears.
EventBusAccountId (string) – AWS Account Id.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'EventBuses': [
        {
            'Name': 'string',
            'EventBusArn': 'string',
            'Description': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'State': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ACTIVE'|'DELETE_FAILED',
            'StateReason': 'string',
            'EventBusAccountId': 'string'
        },
    ],

}

Response Structure

(dict) –
- EventBuses (list) –
  
  List of event bus summaries.
  - (dict) –
    
    Summary of an event bus, as returned by ListEventBuses.
    - Name (string) –
      
      Name of an event bus. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’. The grammar matches the name segment of EventBusArn (event-busv2//), so every valid name can be represented in the bus’s ARN. The same type is used everywhere a bus name appears.
    - EventBusArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies an event bus.
    - Description (string) –
      
      Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.
    - CreationTime (datetime) –
      
      The time the event bus was created.
    - LastModifiedTime (datetime) –
      
      The time the event bus was last modified.
    - State (string) –
      
      Lifecycle state of an event bus.
      - CREATING: Bus creation is in progress.
      - CREATE_FAILED: Bus creation failed; see StateReason. The bus cannot be recovered or recreated in place: delete it with DeleteEventBus, then create a new bus.
      - ACTIVE: Bus is fully operational and can accept events.
      - UPDATING: Bus update is in progress.
      - UPDATE_FAILED: Bus update failed; the bus remains operational with its previous configuration.
      - DELETING: Bus deletion is actively in progress.
      - DELETE_FAILED: Bus deletion failed; see StateReason. Retry DeleteEventBus after removing subscribers and event sources.
    - StateReason (string) –
      
      Human-readable explanation of why an event bus is in its current State. Omitted when the bus is in a normal operational state (ACTIVE). It stands in for the error response an asynchronous failure cannot return, so it applies only to resources with an asynchronous lifecycle: event buses. EventSources and subscribers are provisioned synchronously and report failures directly on the request.
    - EventBusAccountId (string) –
      
      AWS Account Id.