EventBridgeV2 / Paginator / ListSubscribers

ListSubscribers¶

class EventBridgeV2.Paginator.ListSubscribers¶

paginator = client.get_paginator('list_subscribers')

paginate(**kwargs)¶

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

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) – Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.
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

{
    'Subscribers': [
        {
            'SubscriberArn': 'string',
            'Name': 'string',
            'EventBusArn': 'string',
            'TargetArn': 'string',
            'Type': 'FIFO'|'UNORDERED',
            'Revoked': True|False,
            'State': 'RUNNING'|'STOPPED',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'SubscriberAccountId': 'string'
        },
    ],

}

Response Structure

(dict) –
- Subscribers (list) –
  
  List of subscriber summaries.
  - (dict) –
    
    Summary of a subscriber, as returned by ListSubscribers.
    - SubscriberArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies a subscriber.
    - Name (string) –
      
      Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include ‘.’, ‘-’, and ‘_’.
    - EventBusArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies an event bus.
    - TargetArn (string) –
      
      ARN of the target a subscriber invokes. The resource grammar is service-neutral because target services use different separators and the USI form omits region and account.
    - Type (string) –
      
      Delivery ordering mode of a subscriber: FIFO delivers events in order within an event group; UNORDERED delivers without an ordering guarantee.
    - Revoked (boolean) –
      
      True when the bus owner has revoked this subscriber. Present only when true, so a bus owner listing subscribers sees at a glance which ones they revoked. See DescribeSubscriberResponse$Revoked.
    - State (string) –
      
      Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means “provisioned and healthy”. Delivery requires State RUNNING on a subscriber that is not revoked.
    - CreationTime (datetime) –
      
      The time the subscriber was created.
    - LastModifiedTime (datetime) –
      
      The time the subscriber was last modified.
    - SubscriberAccountId (string) –
      
      AWS Account Id.