:doc:`CustomerProfiles <../../customer-profiles>` / Paginator / ListRuleBasedMatches

********************
ListRuleBasedMatches
********************



.. py:class:: CustomerProfiles.Paginator.ListRuleBasedMatches

  ::

    
    paginator = client.get_paginator('list_rule_based_matches')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CustomerProfiles.Client.list_rule_based_matches`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRuleBasedMatches>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DomainName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DomainName: string
    :param DomainName: **[REQUIRED]** 

      The unique name of the domain.

      

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

      
      ::

        {
            'MatchIds': [
                'string',
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **MatchIds** *(list) --* 

          The list of ``MatchIds`` for the given domain.

          
          

          - *(string) --* 
      
    