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.
Important
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.
Request Syntax
POST /domains/DomainName/identity-resolution-jobs/auto-merging-preview HTTP/1.1
Content-type: application/json
{
"ConflictResolution": {
"ConflictResolvingModel": "string",
"SourceName": "string"
},
"Consolidation": {
"MatchingAttributesList": [
[ "string" ]
]
},
"MinAllowedConfidenceScoreForMerging": number
}URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The unique name of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: Yes
Request Body
The request accepts the following data in JSON format.
- ConflictResolution
-
How the auto-merging process should resolve conflicts between different profiles.
Type: ConflictResolution object
Required: Yes
- Consolidation
-
A list of matching attributes that represent matching criteria.
Type: Consolidation object
Required: Yes
- MinAllowedConfidenceScoreForMerging
-
Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
Type: Double
Valid Range: Minimum value of 0.0. Maximum value of 1.0.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DomainName": "string",
"NumberOfMatchesInSample": number,
"NumberOfProfilesInSample": number,
"NumberOfProfilesWillBeMerged": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DomainName
-
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$ - NumberOfMatchesInSample
-
The number of match groups in the domain that have been reviewed in this preview dry run.
Type: Long
- NumberOfProfilesInSample
-
The number of profiles found in this preview dry run.
Type: Long
- NumberOfProfilesWillBeMerged
-
The number of profiles that would be merged if this wasn't a preview dry run.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- InternalServerException
-
An internal service error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 404
- ThrottlingException
-
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
