EventBridgeV2 / Paginator / ListEventSources

ListEventSources¶

class EventBridgeV2.Paginator.ListEventSources¶

paginator = client.get_paginator('list_event_sources')

paginate(**kwargs)¶

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

Request Syntax

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

Parameters:

EventBusArn (string) – The Amazon Resource Name (ARN) that uniquely identifies an event bus.
NamePrefix (string) – EventSource name. First character alphanumeric; the rest may add ‘.’, ‘-’, ‘_’. Names may not begin with the reserved “aws.” prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2///), mirroring EventBusName, so a name the ARN cannot represent cannot be created.
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

{
    'EventSources': [
        {
            'EventSourceArn': 'string',
            'Name': 'string',
            'EventBusArn': 'string',
            'Type': 'AWS_SERVICE_EVENTS'|'PARTNER_EVENTS',
            'State': 'CREATING'|'ACTIVE'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
            'Revoked': True|False,
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'EventSourceAccountId': 'string'
        },
    ],

}

Response Structure

(dict) –
- EventSources (list) –
  
  List of EventSource summaries.
  - (dict) –
    
    Summary of an EventSource, as returned by ListEventSources.
    - EventSourceArn (string) –
      
      EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource’s name. The id segment is a 25-character identifier generated by the service.
    - Name (string) –
      
      EventSource name. First character alphanumeric; the rest may add ‘.’, ‘-’, ‘_’. Names may not begin with the reserved “aws.” prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2///), mirroring EventBusName, so a name the ARN cannot represent cannot be created.
    - EventBusArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies an event bus.
    - Type (string) –
      
      Origin type of an EventSource: an AWS service’s events (AWS_SERVICE_EVENTS) or a partner event source’s events (PARTNER_EVENTS).
    - State (string) –
      
      Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.
    - Revoked (boolean) –
      
      True when the bus owner has withdrawn this EventSource. Present only when true, so a bus owner listing EventSources sees at a glance which ones they revoked. See DescribeEventSourceResponse$Revoked.
    - CreationTime (datetime) –
      
      The time the EventSource was created.
    - LastModifiedTime (datetime) –
      
      The time the EventSource was last modified.
    - EventSourceAccountId (string) –
      
      AWS Account Id.