Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CustomerProfiles.GetMatches

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

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.

Synopsis

data GetMatches = GetMatches' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- domainName :: Text
}
newGetMatches :: Text -> GetMatches
getMatches_nextToken :: Lens' GetMatches (Maybe Text)
getMatches_maxResults :: Lens' GetMatches (Maybe Natural)
getMatches_domainName :: Lens' GetMatches Text
data GetMatchesResponse = GetMatchesResponse' {
- matches :: Maybe [MatchItem]
- matchGenerationDate :: Maybe POSIX
- nextToken :: Maybe Text
- potentialMatches :: Maybe Natural
- httpStatus :: Int
}
newGetMatchesResponse :: Int -> GetMatchesResponse
getMatchesResponse_matches :: Lens' GetMatchesResponse (Maybe [MatchItem])
getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime)
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 nextToken :: Maybe Text 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 :: Maybe Natural The maximum number of results to return per page. domainName :: Text The unique name of the domain.

Instances

Instances details

Eq GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods (==) :: GetMatches -> GetMatches -> Bool # (/=) :: GetMatches -> GetMatches -> Bool #
Read GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods readsPrec :: Int -> ReadS GetMatches # readList :: ReadS [GetMatches] # readPrec :: ReadPrec GetMatches # readListPrec :: ReadPrec [GetMatches] #
Show GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods showsPrec :: Int -> GetMatches -> ShowS # show :: GetMatches -> String # showList :: [GetMatches] -> ShowS #
Generic GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Associated Types type Rep GetMatches :: Type -> Type # Methods from :: GetMatches -> Rep GetMatches x # to :: Rep GetMatches x -> GetMatches #
NFData GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods rnf :: GetMatches -> () #
Hashable GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods hashWithSalt :: Int -> GetMatches -> Int # hash :: GetMatches -> Int #
AWSRequest GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Associated Types type AWSResponse GetMatches # Methods request :: GetMatches -> Request GetMatches # response :: MonadResource m => Logger -> Service -> Proxy GetMatches -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMatches))) #
ToHeaders GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods toHeaders :: GetMatches -> [Header] #
ToPath GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods toPath :: GetMatches -> ByteString #
ToQuery GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods toQuery :: GetMatches -> QueryString #
type Rep GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches type Rep GetMatches = D1 ('MetaData "GetMatches" "Amazonka.CustomerProfiles.GetMatches" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "GetMatches'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetMatches Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches type AWSResponse GetMatches = GetMatchesResponse

newGetMatches Source #

Arguments

:: Text	`$sel:domainName:GetMatches'`
-> 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:nextToken: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.

$sel:maxResults:GetMatches', getMatches_maxResults - The maximum number of results to return per page.

$sel:domainName:GetMatches', getMatches_domainName - The unique name of the domain.

Request Lenses

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_maxResults :: Lens' GetMatches (Maybe Natural) Source #

The maximum number of results to return per page.

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

matches :: Maybe [MatchItem]
The list of matched profiles for this instance.
matchGenerationDate :: Maybe POSIX
The timestamp this version of Match Result generated.
nextToken :: Maybe Text
If there are additional results, this is the token for the next set of results.
potentialMatches :: Maybe Natural
The number of potential matches found.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods (==) :: GetMatchesResponse -> GetMatchesResponse -> Bool # (/=) :: GetMatchesResponse -> GetMatchesResponse -> Bool #
Read GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods readsPrec :: Int -> ReadS GetMatchesResponse # readList :: ReadS [GetMatchesResponse] # readPrec :: ReadPrec GetMatchesResponse # readListPrec :: ReadPrec [GetMatchesResponse] #
Show GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods showsPrec :: Int -> GetMatchesResponse -> ShowS # show :: GetMatchesResponse -> String # showList :: [GetMatchesResponse] -> ShowS #
Generic GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Associated Types type Rep GetMatchesResponse :: Type -> Type # Methods from :: GetMatchesResponse -> Rep GetMatchesResponse x # to :: Rep GetMatchesResponse x -> GetMatchesResponse #
NFData GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches Methods rnf :: GetMatchesResponse -> () #
type Rep GetMatchesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetMatches type Rep GetMatchesResponse = D1 ('MetaData "GetMatchesResponse" "Amazonka.CustomerProfiles.GetMatches" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "GetMatchesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "matches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MatchItem])) :: S1 ('MetaSel ('Just "matchGenerationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "potentialMatches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetMatchesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetMatchesResponse'`
-> 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:matches:GetMatchesResponse', getMatchesResponse_matches - The list of matched profiles for this instance.

$sel:matchGenerationDate:GetMatchesResponse', getMatchesResponse_matchGenerationDate - The timestamp this version of Match Result generated.

$sel:nextToken: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_matches :: Lens' GetMatchesResponse (Maybe [MatchItem]) Source #

The list of matched profiles for this instance.

getMatchesResponse_matchGenerationDate :: Lens' GetMatchesResponse (Maybe UTCTime) Source #

The timestamp this version of Match Result generated.

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.