| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CustomerProfiles.GetMatches
Description
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.
Synopsis
- data GetMatches = GetMatches' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- domainName :: Text
- newGetMatches :: Text -> GetMatches
- getMatches_maxResults :: Lens' GetMatches (Maybe Natural)
- getMatches_nextToken :: Lens' GetMatches (Maybe Text)
- getMatches_domainName :: Lens' GetMatches Text
- data GetMatchesResponse = GetMatchesResponse' {}
- newGetMatchesResponse :: Int -> GetMatchesResponse
- getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime)
- getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem])
- getMatchesResponse_nextToken :: Lens' GetMatchesResponse (Maybe Text)
- getMatchesResponse_potentialMatches :: Lens' GetMatchesResponse (Maybe Natural)
- getMatchesResponse_httpStatus :: Lens' GetMatchesResponse Int
Creating a Request
data GetMatches Source #
See: newGetMatches smart constructor.
Constructors
| GetMatches' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GetMatches |
Create a value of GetMatches with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetMatches', getMatches_maxResults - The maximum number of results to return per page.
GetMatches, getMatches_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.
GetMatches, getMatches_domainName - The unique name of the domain.
Request Lenses
getMatches_maxResults :: Lens' GetMatches (Maybe Natural) Source #
The maximum number of results to return per page.
getMatches_nextToken :: Lens' GetMatches (Maybe Text) Source #
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.
getMatches_domainName :: Lens' GetMatches Text Source #
The unique name of the domain.
Destructuring the Response
data GetMatchesResponse Source #
See: newGetMatchesResponse smart constructor.
Constructors
| GetMatchesResponse' | |
Fields
| |
Instances
newGetMatchesResponse Source #
Arguments
| :: Int | |
| -> GetMatchesResponse |
Create a value of GetMatchesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:matchGenerationDate:GetMatchesResponse', getMatchesResponse_matchGenerationDate - The timestamp this version of Match Result generated.
$sel:matches:GetMatchesResponse', getMatchesResponse_matches - The list of matched profiles for this instance.
GetMatches, getMatchesResponse_nextToken - If there are additional results, this is the token for the next set of
results.
$sel:potentialMatches:GetMatchesResponse', getMatchesResponse_potentialMatches - The number of potential matches found.
$sel:httpStatus:GetMatchesResponse', getMatchesResponse_httpStatus - The response's http status code.
Response Lenses
getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime) Source #
The timestamp this version of Match Result generated.
getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem]) Source #
The list of matched profiles for this instance.
getMatchesResponse_nextToken :: Lens' GetMatchesResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
getMatchesResponse_potentialMatches :: Lens' GetMatchesResponse (Maybe Natural) Source #
The number of potential matches found.
getMatchesResponse_httpStatus :: Lens' GetMatchesResponse Int Source #
The response's http status code.