[ aws . customer-profiles ]

get-matches

Description

This API is in preview release for Amazon Connect and subject to change.

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.

Warning

Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.

Amazon Connect uses the following profile attributes to identify matches:

• PhoneNumber

• HomePhoneNumber

• BusinessPhoneNumber

• MobilePhoneNumber

• EmailAddress

• PersonalEmailAddress

• BusinessEmailAddress

• FullName

• BusinessName

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-matches
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

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.

--max-results (integer)

The maximum number of results to return per page.

--domain-name (string)

The unique name of the domain.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

If there are additional results, this is the token for the next set of results.

MatchGenerationDate -> (timestamp)

The timestamp this version of Match Result generated.

PotentialMatches -> (integer)

The number of potential matches found.

Matches -> (list)

The list of matched profiles for this instance.

(structure)

The Match group object.

MatchId -> (string)

The unique identifiers for this group of profiles that match.

ProfileIds -> (list)

A list of identifiers for profiles that match.

(string)