GetIdentityResolutionJob
Returns information about an Identity Resolution Job in a specific domain.
Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.
Request Syntax
GET /domains/DomainName/identity-resolution-jobs/JobId HTTP/1.1
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
- JobId
-
The unique identifier of the Identity Resolution Job.
Pattern:
[a-f0-9]{32}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AutoMerging": {
"ConflictResolution": {
"ConflictResolvingModel": "string",
"SourceName": "string"
},
"Consolidation": {
"MatchingAttributesList": [
[ "string" ]
]
},
"Enabled": boolean,
"MinAllowedConfidenceScoreForMerging": number
},
"DomainName": "string",
"ExportingLocation": {
"S3Exporting": {
"S3BucketName": "string",
"S3KeyName": "string"
}
},
"JobEndTime": number,
"JobExpirationTime": number,
"JobId": "string",
"JobStartTime": number,
"JobStats": {
"NumberOfMatchesFound": number,
"NumberOfMergesDone": number,
"NumberOfProfilesReviewed": number
},
"LastUpdatedAt": number,
"Message": "string",
"Status": "string"
}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.
- AutoMerging
-
Configuration settings for how to perform the auto-merging of profiles.
Type: AutoMerging object
- DomainName
-
The unique name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$ - ExportingLocation
-
The S3 location where the Identity Resolution Job writes result files.
Type: ExportingLocation object
- JobEndTime
-
The timestamp of when the Identity Resolution Job was completed.
Type: Timestamp
- JobExpirationTime
-
The timestamp of when the Identity Resolution Job will expire.
Type: Timestamp
- JobId
-
The unique identifier of the Identity Resolution Job.
Type: String
Pattern:
[a-f0-9]{32} - JobStartTime
-
The timestamp of when the Identity Resolution Job was started or will be started.
Type: Timestamp
- JobStats
-
Statistics about the Identity Resolution Job.
Type: JobStats object
- LastUpdatedAt
-
The timestamp of when the Identity Resolution Job was most recently edited.
Type: Timestamp
- Message
-
The error messages that are generated when the Identity Resolution Job runs.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
.* - Status
-
The status of the Identity Resolution Job.
-
PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in thePENDINGstate are deleted. -
PREPROCESSING: The Identity Resolution Job is loading your data. -
FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group. -
MERGING: The Identity Resolution Job is merging duplicate profiles. -
COMPLETED: The Identity Resolution Job completed successfully. -
PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem. -
FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
Type: String
Valid Values:
PENDING | PREPROCESSING | FIND_MATCHING | MERGING | COMPLETED | PARTIAL_SUCCESS | FAILED -
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:
