:doc:`CustomerProfiles <../../customer-profiles>` / Client / list_rule_based_matches

***********************
list_rule_based_matches
***********************



.. py:method:: CustomerProfiles.Client.list_rule_based_matches(**kwargs)

  

  Returns a set of ``MatchIds`` that belong to the given domain.

  

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


  **Request Syntax**
  ::

    response = client.list_rule_based_matches(
        NextToken='string',
        MaxResults=123,
        DomainName='string'
    )
    
  :type NextToken: string
  :param NextToken: 

    The pagination token from the previous ``ListRuleBasedMatches`` API call.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of ``MatchIds`` returned per page.

    

  
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

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

        
        

        - *(string) --* 
    
      

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

        The pagination token from the previous ``ListRuleBasedMatches`` API call.

        
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  