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

Amazonka.CustomerProfiles.GetIdentityResolutionJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data GetIdentityResolutionJob Source #

See: newGetIdentityResolutionJob smart constructor.

Constructors

GetIdentityResolutionJob'
Fields domainName :: Text The unique name of the domain. jobId :: Text The unique identifier of the Identity Resolution Job.

Instances

Instances details

ToHeaders GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods toHeaders :: GetIdentityResolutionJob -> [Header] #
ToPath GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods toPath :: GetIdentityResolutionJob -> ByteString #
ToQuery GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods toQuery :: GetIdentityResolutionJob -> QueryString #
AWSRequest GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Associated Types type AWSResponse GetIdentityResolutionJob # Methods request :: (Service -> Service) -> GetIdentityResolutionJob -> Request GetIdentityResolutionJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIdentityResolutionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIdentityResolutionJob))) #
Generic GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Associated Types type Rep GetIdentityResolutionJob :: Type -> Type # Methods from :: GetIdentityResolutionJob -> Rep GetIdentityResolutionJob x # to :: Rep GetIdentityResolutionJob x -> GetIdentityResolutionJob #
Read GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods readsPrec :: Int -> ReadS GetIdentityResolutionJob # readList :: ReadS [GetIdentityResolutionJob] # readPrec :: ReadPrec GetIdentityResolutionJob # readListPrec :: ReadPrec [GetIdentityResolutionJob] #
Show GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods showsPrec :: Int -> GetIdentityResolutionJob -> ShowS # show :: GetIdentityResolutionJob -> String # showList :: [GetIdentityResolutionJob] -> ShowS #
NFData GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods rnf :: GetIdentityResolutionJob -> () #
Eq GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods (==) :: GetIdentityResolutionJob -> GetIdentityResolutionJob -> Bool # (/=) :: GetIdentityResolutionJob -> GetIdentityResolutionJob -> Bool #
Hashable GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods hashWithSalt :: Int -> GetIdentityResolutionJob -> Int # hash :: GetIdentityResolutionJob -> Int #
type AWSResponse GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob type AWSResponse GetIdentityResolutionJob = GetIdentityResolutionJobResponse
type Rep GetIdentityResolutionJob Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob type Rep GetIdentityResolutionJob = D1 ('MetaData "GetIdentityResolutionJob" "Amazonka.CustomerProfiles.GetIdentityResolutionJob" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetIdentityResolutionJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetIdentityResolutionJob Source #

Arguments

:: Text	`GetIdentityResolutionJob`
-> Text	`GetIdentityResolutionJob`
-> GetIdentityResolutionJob

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.

Constructors

GetIdentityResolutionJobResponse'

Fields

autoMerging :: Maybe AutoMerging
Configuration settings for how to perform the auto-merging of profiles.
domainName :: Maybe Text
The unique name of the domain.
exportingLocation :: Maybe ExportingLocation
The S3 location where the Identity Resolution Job writes result files.
jobEndTime :: Maybe POSIX
The timestamp of when the Identity Resolution Job was completed.
jobExpirationTime :: Maybe POSIX
The timestamp of when the Identity Resolution Job will expire.
jobId :: Maybe Text
The unique identifier of the Identity Resolution Job.
jobStartTime :: Maybe POSIX
The timestamp of when the Identity Resolution Job was started or will be started.
jobStats :: Maybe JobStats
Statistics about the Identity Resolution Job.
lastUpdatedAt :: Maybe POSIX
The timestamp of when the Identity Resolution Job was most recently edited.
message :: Maybe Text
The error messages that are generated when the Identity Resolution Job runs.
status :: Maybe IdentityResolutionJobStatus
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 the PENDING 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Associated Types type Rep GetIdentityResolutionJobResponse :: Type -> Type # Methods from :: GetIdentityResolutionJobResponse -> Rep GetIdentityResolutionJobResponse x # to :: Rep GetIdentityResolutionJobResponse x -> GetIdentityResolutionJobResponse #
Read GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods readsPrec :: Int -> ReadS GetIdentityResolutionJobResponse # readList :: ReadS [GetIdentityResolutionJobResponse] # readPrec :: ReadPrec GetIdentityResolutionJobResponse # readListPrec :: ReadPrec [GetIdentityResolutionJobResponse] #
Show GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods showsPrec :: Int -> GetIdentityResolutionJobResponse -> ShowS # show :: GetIdentityResolutionJobResponse -> String # showList :: [GetIdentityResolutionJobResponse] -> ShowS #
NFData GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods rnf :: GetIdentityResolutionJobResponse -> () #
Eq GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob Methods (==) :: GetIdentityResolutionJobResponse -> GetIdentityResolutionJobResponse -> Bool # (/=) :: GetIdentityResolutionJobResponse -> GetIdentityResolutionJobResponse -> Bool #
type Rep GetIdentityResolutionJobResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetIdentityResolutionJob type Rep GetIdentityResolutionJobResponse = D1 ('MetaData "GetIdentityResolutionJobResponse" "Amazonka.CustomerProfiles.GetIdentityResolutionJob" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetIdentityResolutionJobResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoMerging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoMerging)) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "exportingLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportingLocation)))) :: (S1 ('MetaSel ('Just "jobEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "jobExpirationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "jobStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "jobStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStats)) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityResolutionJobStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetIdentityResolutionJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetIdentityResolutionJobResponse'`
-> GetIdentityResolutionJobResponse

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 the PENDING 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 the PENDING 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.