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

******************************
ListNotificationConfigurations
******************************



.. py:class:: UserNotifications.Paginator.ListNotificationConfigurations

  ::

    
    paginator = client.get_paginator('list_notification_configurations')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          eventRuleSource='string',
          channelArn='string',
          status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
          subtype='ACCOUNT'|'ADMIN_MANAGED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type eventRuleSource: string
    :param eventRuleSource: 

      The matched event source.

       

      Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, ``aws.ec2`` and ``aws.cloudwatch``. For more information, see `Event delivery from Amazon Web Services services <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level>`__ in the *Amazon EventBridge User Guide*.

      

    
    :type channelArn: string
    :param channelArn: 

      The Amazon Resource Name (ARN) of the Channel to match.

      

    
    :type status: string
    :param status: 

      The ``NotificationConfiguration`` status to match.

       

      
      * Values: 

        
        * ``ACTIVE`` 

          
          * All ``EventRules`` are ``ACTIVE`` and any call can be run.
          

        
         
        * ``PARTIALLY_ACTIVE`` 

          
          * Some ``EventRules`` are ``ACTIVE`` and some are ``INACTIVE``. Any call can be run.
           
          * Any call can be run.
          

        
         
        * ``INACTIVE`` 

          
          * All ``EventRules`` are ``INACTIVE`` and any call can be run.
          

        
         
        * ``DELETING`` 

          
          * This ``NotificationConfiguration`` is being deleted.
           
          * Only ``GET`` and ``LIST`` calls can be run.
          

        
        

      
      

      

    
    :type subtype: string
    :param subtype: 

      The subtype used to filter the notification configurations in the request.

      

    
    :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**

      
      ::

        {
            'notificationConfigurations': [
                {
                    'arn': 'string',
                    'name': 'string',
                    'description': 'string',
                    'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
                    'creationTime': datetime(2015, 1, 1),
                    'aggregationDuration': 'LONG'|'SHORT'|'NONE',
                    'subtype': 'ACCOUNT'|'ADMIN_MANAGED'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **notificationConfigurations** *(list) --* 

          The ``NotificationConfigurations`` in the account.

          
          

          - *(dict) --* 

            Contains the complete list of fields for a NotificationConfiguration.

            
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the ``NotificationConfiguration`` resource.

              
            

            - **name** *(string) --* 

              The name of the ``NotificationConfiguration``. Supports RFC 3986's unreserved characters.

              
            

            - **description** *(string) --* 

              The description of the ``NotificationConfiguration``.

              
            

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

              The current status of the ``NotificationConfiguration``.

              
            

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

              The creation time of the ``NotificationConfiguration``.

              
            

            - **aggregationDuration** *(string) --* 

              The aggregation preference of the ``NotificationConfiguration``.

               

              
              * Values: 

                
                * ``LONG`` 

                  
                  * Aggregate notifications for long periods of time (12 hours).
                  

                
                 
                * ``SHORT`` 

                  
                  * Aggregate notifications for short periods of time (5 minutes).
                  

                
                 
                * ``NONE`` 

                  
                  * Don't aggregate notifications.
                  

                
                

              
              

              
            

            - **subtype** *(string) --* 

              The subtype of the notification configuration.

              
        
      
        

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

          A token to resume pagination.

          
    