Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetMatchesCommand

Before calling this API, use CreateDomain or UpdateDomain 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 GetMatches 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.

example

Use a bare-bones client and the command you need to make an API call.

import { CustomerProfilesClient, GetMatchesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import
// const { CustomerProfilesClient, GetMatchesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import
const client = new CustomerProfilesClient(config);
const command = new GetMatchesCommand(input);
const response = await client.send(command);
see

GetMatchesCommandInput for command's input shape.

see

GetMatchesCommandOutput for command's response shape.

see

config for CustomerProfilesClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: GetMatchesCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<GetMatchesCommandInput, GetMatchesCommandOutput>

Methods

Static getEndpointParameterInstructions