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.Types.IdentityResolutionJob

Description

 
Synopsis

Documentation

data IdentityResolutionJob Source #

Information about the Identity Resolution Job.

See: newIdentityResolutionJob smart constructor.

Constructors

IdentityResolutionJob' 

Fields

  • 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 job was completed.

  • jobId :: Maybe Text

    The unique identifier of the Identity Resolution Job.

  • jobStartTime :: Maybe POSIX

    The timestamp of when the job was started or will be started.

  • jobStats :: Maybe JobStats

    Statistics about an Identity Resolution Job.

  • 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.

Instances

Instances details
FromJSON IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

Generic IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

Associated Types

type Rep IdentityResolutionJob :: Type -> Type #

Read IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

Show IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

NFData IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

Methods

rnf :: IdentityResolutionJob -> () #

Eq IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

Hashable IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

type Rep IdentityResolutionJob Source # 
Instance details

Defined in Amazonka.CustomerProfiles.Types.IdentityResolutionJob

newIdentityResolutionJob :: IdentityResolutionJob Source #

Create a value of IdentityResolutionJob 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:domainName:IdentityResolutionJob', identityResolutionJob_domainName - The unique name of the domain.

$sel:exportingLocation:IdentityResolutionJob', identityResolutionJob_exportingLocation - The S3 location where the Identity Resolution Job writes result files.

$sel:jobEndTime:IdentityResolutionJob', identityResolutionJob_jobEndTime - The timestamp of when the job was completed.

$sel:jobId:IdentityResolutionJob', identityResolutionJob_jobId - The unique identifier of the Identity Resolution Job.

$sel:jobStartTime:IdentityResolutionJob', identityResolutionJob_jobStartTime - The timestamp of when the job was started or will be started.

$sel:jobStats:IdentityResolutionJob', identityResolutionJob_jobStats - Statistics about an Identity Resolution Job.

$sel:message:IdentityResolutionJob', identityResolutionJob_message - The error messages that are generated when the Identity Resolution Job runs.

$sel:status:IdentityResolutionJob', identityResolutionJob_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.

identityResolutionJob_exportingLocation :: Lens' IdentityResolutionJob (Maybe ExportingLocation) Source #

The S3 location where the Identity Resolution Job writes result files.

identityResolutionJob_jobEndTime :: Lens' IdentityResolutionJob (Maybe UTCTime) Source #

The timestamp of when the job was completed.

identityResolutionJob_jobId :: Lens' IdentityResolutionJob (Maybe Text) Source #

The unique identifier of the Identity Resolution Job.

identityResolutionJob_jobStartTime :: Lens' IdentityResolutionJob (Maybe UTCTime) Source #

The timestamp of when the job was started or will be started.

identityResolutionJob_jobStats :: Lens' IdentityResolutionJob (Maybe JobStats) Source #

Statistics about an Identity Resolution Job.

identityResolutionJob_message :: Lens' IdentityResolutionJob (Maybe Text) Source #

The error messages that are generated when the Identity Resolution Job runs.

identityResolutionJob_status :: Lens' IdentityResolutionJob (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.