Skip to content

Get Matches

customerprofiles_get_matches R Documentation

Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true

Description

Before calling this API, use create_domain or update_domain to enable identity resolution: set Matching to true.

GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the get_matches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

Usage

customerprofiles_get_matches(NextToken, MaxResults, DomainName)

Arguments

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

MaxResults

The maximum number of results to return per page.

DomainName

[required] The unique name of the domain.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  MatchGenerationDate = as.POSIXct(
    "2015-01-01"
  ),
  PotentialMatches = 123,
  Matches = list(
    list(
      MatchId = "string",
      ProfileIds = list(
        "string"
      ),
      ConfidenceScore = 123.0
    )
  )
)

Request syntax

svc$get_matches(
  NextToken = "string",
  MaxResults = 123,
  DomainName = "string"
)