:doc:`UserNotifications <../../notifications>` / Paginator / ListNotificationHubs

********************
ListNotificationHubs
********************



.. py:class:: UserNotifications.Paginator.ListNotificationHubs

  ::

    
    paginator = client.get_paginator('list_notification_hubs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`UserNotifications.Client.list_notification_hubs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/notifications-2018-05-10/ListNotificationHubs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'notificationHubs': [
                {
                    'notificationHubRegion': 'string',
                    'statusSummary': {
                        'status': 'ACTIVE'|'REGISTERING'|'DEREGISTERING'|'INACTIVE',
                        'reason': 'string'
                    },
                    'creationTime': datetime(2015, 1, 1),
                    'lastActivationTime': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **notificationHubs** *(list) --* 

          The ``NotificationHubs`` in the account.

          
          

          - *(dict) --* 

            Describes an overview of a ``NotificationHub``.

             

            A ``NotificationConfiguration`` is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.

            
            

            - **notificationHubRegion** *(string) --* 

              The Region of the resource.

              
            

            - **statusSummary** *(dict) --* 

              The status summary of the resource.

              
              

              - **status** *(string) --* 

                Status information about the ``NotificationHub``.

                 

                
                * Values: 

                  
                  * ``ACTIVE`` 

                    
                    * Incoming ``NotificationEvents`` are replicated to this ``NotificationHub``.
                    

                  
                   
                  * ``REGISTERING`` 

                    
                    * The ``NotificationConfiguration`` is initializing. A ``NotificationConfiguration`` with this status can't be deregistered.
                    

                  
                   
                  * ``DEREGISTERING`` 

                    
                    * The ``NotificationConfiguration`` is being deleted. You can't register additional ``NotificationHubs`` in the same Region as a ``NotificationConfiguration`` with this status.
                    

                  
                  

                
                

                
              

              - **reason** *(string) --* 

                An explanation for the current status.

                
          
            

            - **creationTime** *(datetime) --* 

              The date and time the ``NotificationHubOverview`` was created.

              
            

            - **lastActivationTime** *(datetime) --* 

              The most recent time this ``NotificationHub`` had an ``ACTIVE`` status.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    