:doc:`CodeStarNotifications <../../codestar-notifications>` / Paginator / ListNotificationRules

*********************
ListNotificationRules
*********************



.. py:class:: CodeStarNotifications.Paginator.ListNotificationRules

  ::

    
    paginator = client.get_paginator('list_notification_rules')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeStarNotifications.Client.list_notification_rules`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListNotificationRules>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'EVENT_TYPE_ID'|'CREATED_BY'|'RESOURCE'|'TARGET_ADDRESS',
                  'Value': 'string'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      The filters to use to return information by service or resource type. For valid values, see  ListNotificationRulesFilter.

       

      .. note::

        

        A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

        

      

    
      - *(dict) --* 

        Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the attribute you want to use to filter the returned notification rules.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by *RESOURCE* in Name, you might specify the ARN of a pipeline in CodePipeline for the value.

          

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

      
      ::

        {
            'NotificationRules': [
                {
                    'Id': 'string',
                    'Arn': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **NotificationRules** *(list) --* 

          The list of notification rules for the Amazon Web Services account, by Amazon Resource Name (ARN) and ID.

          
          

          - *(dict) --* 

            Information about a specified notification rule.

            
            

            - **Id** *(string) --* 

              The unique ID of the notification rule.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the notification rule.

              
        
      
    