:doc:`WAF <../../waf>` / Paginator / ListRateBasedRules

******************
ListRateBasedRules
******************



.. py:class:: WAF.Paginator.ListRateBasedRules

  ::

    
    paginator = client.get_paginator('list_rate_based_rules')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WAF.Client.list_rate_based_rules`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/ListRateBasedRules>`_    


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

      
      ::

        {
            'Rules': [
                {
                    'RuleId': 'string',
                    'Name': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Rules** *(list) --* 

          An array of  RuleSummary objects.

          
          

          - *(dict) --* 

            .. note::

              

              This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

               

              **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

              

             

            Contains the identifier and the friendly name or description of the ``Rule``.

            
            

            - **RuleId** *(string) --* 

              A unique identifier for a ``Rule``. You use ``RuleId`` to get more information about a ``Rule`` (see  GetRule), update a ``Rule`` (see  UpdateRule), insert a ``Rule`` into a ``WebACL`` or delete one from a ``WebACL`` (see  UpdateWebACL), or delete a ``Rule`` from AWS WAF (see  DeleteRule).

               

              ``RuleId`` is returned by  CreateRule and by  ListRules.

              
            

            - **Name** *(string) --* 

              A friendly name or description of the  Rule. You can't change the name of a ``Rule`` after you create it.

              
        
      
        

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

          A token to resume pagination.

          
    