Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data GetIdentityResolutionJob = GetIdentityResolutionJob' {
- domainName :: Text
- jobId :: Text
- newGetIdentityResolutionJob :: Text -> Text -> GetIdentityResolutionJob
- getIdentityResolutionJob_domainName :: Lens' GetIdentityResolutionJob Text
- getIdentityResolutionJob_jobId :: Lens' GetIdentityResolutionJob Text
- data GetIdentityResolutionJobResponse = GetIdentityResolutionJobResponse' {
- autoMerging :: Maybe AutoMerging
- domainName :: Maybe Text
- exportingLocation :: Maybe ExportingLocation
- jobEndTime :: Maybe POSIX
- jobExpirationTime :: Maybe POSIX
- jobId :: Maybe Text
- jobStartTime :: Maybe POSIX
- jobStats :: Maybe JobStats
- lastUpdatedAt :: Maybe POSIX
- message :: Maybe Text
- status :: Maybe IdentityResolutionJobStatus
- httpStatus :: Int
- newGetIdentityResolutionJobResponse :: Int -> GetIdentityResolutionJobResponse
- getIdentityResolutionJobResponse_autoMerging :: Lens' GetIdentityResolutionJobResponse (Maybe AutoMerging)
- getIdentityResolutionJobResponse_domainName :: Lens' GetIdentityResolutionJobResponse (Maybe Text)
- getIdentityResolutionJobResponse_exportingLocation :: Lens' GetIdentityResolutionJobResponse (Maybe ExportingLocation)
- getIdentityResolutionJobResponse_jobEndTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime)
- getIdentityResolutionJobResponse_jobExpirationTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime)
- getIdentityResolutionJobResponse_jobId :: Lens' GetIdentityResolutionJobResponse (Maybe Text)
- getIdentityResolutionJobResponse_jobStartTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime)
- getIdentityResolutionJobResponse_jobStats :: Lens' GetIdentityResolutionJobResponse (Maybe JobStats)
- getIdentityResolutionJobResponse_lastUpdatedAt :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime)
- getIdentityResolutionJobResponse_message :: Lens' GetIdentityResolutionJobResponse (Maybe Text)
- getIdentityResolutionJobResponse_status :: Lens' GetIdentityResolutionJobResponse (Maybe IdentityResolutionJobStatus)
- getIdentityResolutionJobResponse_httpStatus :: Lens' GetIdentityResolutionJobResponse Int
Creating a Request
data GetIdentityResolutionJob Source #
See: newGetIdentityResolutionJob
smart constructor.
GetIdentityResolutionJob' | |
|
Instances
newGetIdentityResolutionJob Source #
Create a value of GetIdentityResolutionJob
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:
GetIdentityResolutionJob
, getIdentityResolutionJob_domainName
- The unique name of the domain.
GetIdentityResolutionJob
, getIdentityResolutionJob_jobId
- The unique identifier of the Identity Resolution Job.
Request Lenses
getIdentityResolutionJob_domainName :: Lens' GetIdentityResolutionJob Text Source #
The unique name of the domain.
getIdentityResolutionJob_jobId :: Lens' GetIdentityResolutionJob Text Source #
The unique identifier of the Identity Resolution Job.
Destructuring the Response
data GetIdentityResolutionJobResponse Source #
See: newGetIdentityResolutionJobResponse
smart constructor.
GetIdentityResolutionJobResponse' | |
|
Instances
newGetIdentityResolutionJobResponse Source #
Create a value of GetIdentityResolutionJobResponse
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:
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_autoMerging
- Configuration settings for how to perform the auto-merging of profiles.
GetIdentityResolutionJob
, getIdentityResolutionJobResponse_domainName
- The unique name of the domain.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_exportingLocation
- The S3 location where the Identity Resolution Job writes result files.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobEndTime
- The timestamp of when the Identity Resolution Job was completed.
$sel:jobExpirationTime:GetIdentityResolutionJobResponse'
, getIdentityResolutionJobResponse_jobExpirationTime
- The timestamp of when the Identity Resolution Job will expire.
GetIdentityResolutionJob
, getIdentityResolutionJobResponse_jobId
- The unique identifier of the Identity Resolution Job.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobStartTime
- The timestamp of when the Identity Resolution Job was started or will be
started.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_jobStats
- Statistics about the Identity Resolution Job.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_lastUpdatedAt
- The timestamp of when the Identity Resolution Job was most recently
edited.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_message
- The error messages that are generated when the Identity Resolution Job
runs.
GetIdentityResolutionJobResponse
, getIdentityResolutionJobResponse_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 thePENDING
state 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.
$sel:httpStatus:GetIdentityResolutionJobResponse'
, getIdentityResolutionJobResponse_httpStatus
- The response's http status code.
Response Lenses
getIdentityResolutionJobResponse_autoMerging :: Lens' GetIdentityResolutionJobResponse (Maybe AutoMerging) Source #
Configuration settings for how to perform the auto-merging of profiles.
getIdentityResolutionJobResponse_domainName :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #
The unique name of the domain.
getIdentityResolutionJobResponse_exportingLocation :: Lens' GetIdentityResolutionJobResponse (Maybe ExportingLocation) Source #
The S3 location where the Identity Resolution Job writes result files.
getIdentityResolutionJobResponse_jobEndTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #
The timestamp of when the Identity Resolution Job was completed.
getIdentityResolutionJobResponse_jobExpirationTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #
The timestamp of when the Identity Resolution Job will expire.
getIdentityResolutionJobResponse_jobId :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #
The unique identifier of the Identity Resolution Job.
getIdentityResolutionJobResponse_jobStartTime :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #
The timestamp of when the Identity Resolution Job was started or will be started.
getIdentityResolutionJobResponse_jobStats :: Lens' GetIdentityResolutionJobResponse (Maybe JobStats) Source #
Statistics about the Identity Resolution Job.
getIdentityResolutionJobResponse_lastUpdatedAt :: Lens' GetIdentityResolutionJobResponse (Maybe UTCTime) Source #
The timestamp of when the Identity Resolution Job was most recently edited.
getIdentityResolutionJobResponse_message :: Lens' GetIdentityResolutionJobResponse (Maybe Text) Source #
The error messages that are generated when the Identity Resolution Job runs.
getIdentityResolutionJobResponse_status :: Lens' GetIdentityResolutionJobResponse (Maybe IdentityResolutionJobStatus) Source #
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 thePENDING
state 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.
getIdentityResolutionJobResponse_httpStatus :: Lens' GetIdentityResolutionJobResponse Int Source #
The response's http status code.