Amazonka.CustomerProfiles.GetAutoMergingPreview

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

You can't view which profiles are matched and would be merged.

We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.

Creating a Request

data GetAutoMergingPreview

See: newGetAutoMergingPreview smart constructor.

Constructors

GetAutoMergingPreview'

Fields

• minAllowedConfidenceScoreForMerging :: Maybe Double

  Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

• domainName :: Text

  The unique name of the domain.

• consolidation :: Consolidation

  A list of matching attributes that represent matching criteria.

• conflictResolution :: ConflictResolution

  How the auto-merging process should resolve conflicts between different profiles.

Instances

ToJSON GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

toJSON :: GetAutoMergingPreview -> Value

toEncoding :: GetAutoMergingPreview -> Encoding

toJSONList :: [GetAutoMergingPreview] -> Value

toEncodingList :: [GetAutoMergingPreview] -> Encoding

ToHeaders GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

toHeaders :: GetAutoMergingPreview -> [Header]

ToPath GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

toPath :: GetAutoMergingPreview -> ByteString

ToQuery GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

toQuery :: GetAutoMergingPreview -> QueryString

AWSRequest GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type AWSResponse GetAutoMergingPreview

Methods

request :: (Service -> Service) -> GetAutoMergingPreview -> Request GetAutoMergingPreview

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAutoMergingPreview -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAutoMergingPreview)))

Generic GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type Rep GetAutoMergingPreview :: Type -> Type

Methods

from :: GetAutoMergingPreview -> Rep GetAutoMergingPreview x

to :: Rep GetAutoMergingPreview x -> GetAutoMergingPreview

Read GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

readsPrec :: Int -> ReadS GetAutoMergingPreview

readList :: ReadS [GetAutoMergingPreview]

readPrec :: ReadPrec GetAutoMergingPreview

readListPrec :: ReadPrec [GetAutoMergingPreview]

Show GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

showsPrec :: Int -> GetAutoMergingPreview -> ShowS

show :: GetAutoMergingPreview -> String

showList :: [GetAutoMergingPreview] -> ShowS

NFData GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

rnf :: GetAutoMergingPreview -> ()

Eq GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

(==) :: GetAutoMergingPreview -> GetAutoMergingPreview -> Bool

(/=) :: GetAutoMergingPreview -> GetAutoMergingPreview -> Bool

Hashable GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

hashWithSalt :: Int -> GetAutoMergingPreview -> Int

hash :: GetAutoMergingPreview -> Int

type AWSResponse GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type AWSResponse GetAutoMergingPreview = GetAutoMergingPreviewResponse

type Rep GetAutoMergingPreview

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type Rep GetAutoMergingPreview = D1 ('MetaData "GetAutoMergingPreview" "Amazonka.CustomerProfiles.GetAutoMergingPreview" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetAutoMergingPreview'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "minAllowedConfidenceScoreForMerging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "consolidation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Consolidation) :*: S1 ('MetaSel ('Just "conflictResolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConflictResolution))))

newGetAutoMergingPreview

Arguments

:: Text

GetAutoMergingPreview

-> Consolidation

GetAutoMergingPreview

-> ConflictResolution

GetAutoMergingPreview

-> GetAutoMergingPreview

Create a value of GetAutoMergingPreview 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:

GetAutoMergingPreview, getAutoMergingPreview_minAllowedConfidenceScoreForMerging - Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

GetAutoMergingPreview, getAutoMergingPreview_domainName - The unique name of the domain.

GetAutoMergingPreview, getAutoMergingPreview_consolidation - A list of matching attributes that represent matching criteria.

GetAutoMergingPreview, getAutoMergingPreview_conflictResolution - How the auto-merging process should resolve conflicts between different profiles.

Request Lenses

getAutoMergingPreview_minAllowedConfidenceScoreForMerging :: Lens' GetAutoMergingPreview (Maybe Double)

Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

getAutoMergingPreview_domainName :: Lens' GetAutoMergingPreview Text

The unique name of the domain.

getAutoMergingPreview_consolidation :: Lens' GetAutoMergingPreview Consolidation

A list of matching attributes that represent matching criteria.

getAutoMergingPreview_conflictResolution :: Lens' GetAutoMergingPreview ConflictResolution

How the auto-merging process should resolve conflicts between different profiles.

Destructuring the Response

data GetAutoMergingPreviewResponse

See: newGetAutoMergingPreviewResponse smart constructor.

Constructors

GetAutoMergingPreviewResponse'

Fields

• numberOfMatchesInSample :: Maybe Integer

  The number of match groups in the domain that have been reviewed in this preview dry run.

• numberOfProfilesInSample :: Maybe Integer

  The number of profiles found in this preview dry run.

• numberOfProfilesWillBeMerged :: Maybe Integer

  The number of profiles that would be merged if this wasn't a preview dry run.

• httpStatus :: Int

  The response's http status code.

• domainName :: Text

  The unique name of the domain.

Instances

Generic GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type Rep GetAutoMergingPreviewResponse :: Type -> Type

Methods

from :: GetAutoMergingPreviewResponse -> Rep GetAutoMergingPreviewResponse x

to :: Rep GetAutoMergingPreviewResponse x -> GetAutoMergingPreviewResponse

Read GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

readsPrec :: Int -> ReadS GetAutoMergingPreviewResponse

readList :: ReadS [GetAutoMergingPreviewResponse]

readPrec :: ReadPrec GetAutoMergingPreviewResponse

readListPrec :: ReadPrec [GetAutoMergingPreviewResponse]

Show GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

showsPrec :: Int -> GetAutoMergingPreviewResponse -> ShowS

show :: GetAutoMergingPreviewResponse -> String

showList :: [GetAutoMergingPreviewResponse] -> ShowS

NFData GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

rnf :: GetAutoMergingPreviewResponse -> ()

Eq GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

(==) :: GetAutoMergingPreviewResponse -> GetAutoMergingPreviewResponse -> Bool

(/=) :: GetAutoMergingPreviewResponse -> GetAutoMergingPreviewResponse -> Bool

type Rep GetAutoMergingPreviewResponse

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type Rep GetAutoMergingPreviewResponse = D1 ('MetaData "GetAutoMergingPreviewResponse" "Amazonka.CustomerProfiles.GetAutoMergingPreview" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetAutoMergingPreviewResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "numberOfMatchesInSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "numberOfProfilesInSample") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "numberOfProfilesWillBeMerged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetAutoMergingPreviewResponse

Arguments

:: Int

$sel:httpStatus:GetAutoMergingPreviewResponse'

-> Text

GetAutoMergingPreview

-> GetAutoMergingPreviewResponse

Create a value of GetAutoMergingPreviewResponse 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:numberOfMatchesInSample:GetAutoMergingPreviewResponse', getAutoMergingPreviewResponse_numberOfMatchesInSample - The number of match groups in the domain that have been reviewed in this preview dry run.

$sel:numberOfProfilesInSample:GetAutoMergingPreviewResponse', getAutoMergingPreviewResponse_numberOfProfilesInSample - The number of profiles found in this preview dry run.

$sel:numberOfProfilesWillBeMerged:GetAutoMergingPreviewResponse', getAutoMergingPreviewResponse_numberOfProfilesWillBeMerged - The number of profiles that would be merged if this wasn't a preview dry run.

$sel:httpStatus:GetAutoMergingPreviewResponse', getAutoMergingPreviewResponse_httpStatus - The response's http status code.

GetAutoMergingPreview, getAutoMergingPreviewResponse_domainName - The unique name of the domain.

Response Lenses

getAutoMergingPreviewResponse_numberOfMatchesInSample :: Lens' GetAutoMergingPreviewResponse (Maybe Integer)

The number of match groups in the domain that have been reviewed in this preview dry run.

getAutoMergingPreviewResponse_numberOfProfilesInSample :: Lens' GetAutoMergingPreviewResponse (Maybe Integer)

The number of profiles found in this preview dry run.

getAutoMergingPreviewResponse_numberOfProfilesWillBeMerged :: Lens' GetAutoMergingPreviewResponse (Maybe Integer)

The number of profiles that would be merged if this wasn't a preview dry run.

getAutoMergingPreviewResponse_httpStatus :: Lens' GetAutoMergingPreviewResponse Int

The response's http status code.

getAutoMergingPreviewResponse_domainName :: Lens' GetAutoMergingPreviewResponse Text

The unique name of the domain.