CustomerProfiles / Client / list_rule_based_matches

list_rule_based_matches#

CustomerProfiles.Client.list_rule_based_matches(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • NextToken (string) – The pagination token from the previous ListRuleBasedMatches API call.

  • MaxResults (integer) – The maximum number of MatchIds returned per page.

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

Return type:

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