paws.customer.engagement (version 0.8.0)

customerprofiles_get_similar_profiles: Returns a set of profiles that belong to the same matching group using the matchId or profileId

Description

Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.

See https://www.paws-r-sdk.com/docs/customerprofiles_get_similar_profiles/ for full documentation.

Usage

customerprofiles_get_similar_profiles(
  NextToken = NULL,
  MaxResults = NULL,
  DomainName,
  MatchType,
  SearchKey,
  SearchValue
)

Arguments

NextToken

The pagination token from the previous get_similar_profiles API call.

MaxResults

The maximum number of objects returned per page.

DomainName

[required] The unique name of the domain.

MatchType

[required] Specify the type of matching to get similar profiles for.

SearchKey

[required] The string indicating the search key to be used.

SearchValue

[required] The string based on SearchKey to be searched for similar profiles.