amazonka-customer-profiles-2.0: Amazon Connect Customer Profiles SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CustomerProfiles.GetAutoMergingPreview

Description

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.

Synopsis

Creating a Request

data GetAutoMergingPreview Source #

See: newGetAutoMergingPreview smart constructor.

Constructors

GetAutoMergingPreview' 

Fields

Instances

Instances details
ToJSON GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

ToHeaders GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

ToPath GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

ToQuery GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

AWSRequest GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type AWSResponse GetAutoMergingPreview #

Generic GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type Rep GetAutoMergingPreview :: Type -> Type #

Read GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Show GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

NFData GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Methods

rnf :: GetAutoMergingPreview -> () #

Eq GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Hashable GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type AWSResponse GetAutoMergingPreview Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type Rep GetAutoMergingPreview Source # 
Instance details

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 Source #

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) Source #

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

getAutoMergingPreview_consolidation :: Lens' GetAutoMergingPreview Consolidation Source #

A list of matching attributes that represent matching criteria.

getAutoMergingPreview_conflictResolution :: Lens' GetAutoMergingPreview ConflictResolution Source #

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

Destructuring the Response

data GetAutoMergingPreviewResponse Source #

See: newGetAutoMergingPreviewResponse smart constructor.

Constructors

GetAutoMergingPreviewResponse' 

Fields

Instances

Instances details
Generic GetAutoMergingPreviewResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Associated Types

type Rep GetAutoMergingPreviewResponse :: Type -> Type #

Read GetAutoMergingPreviewResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Show GetAutoMergingPreviewResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

NFData GetAutoMergingPreviewResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

Eq GetAutoMergingPreviewResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.GetAutoMergingPreview

type Rep GetAutoMergingPreviewResponse Source # 
Instance details

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 Source #

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) Source #

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

getAutoMergingPreviewResponse_numberOfProfilesWillBeMerged :: Lens' GetAutoMergingPreviewResponse (Maybe Integer) Source #

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