Skip to content

IdentityResolutionJob

Source code in docs_src/capo_customer_profiles/types/identity_resolution_job.py
class IdentityResolutionJob(TypedDict, closed=True):
    domain_name: NotRequired["capo_customer_profiles.types.name.name"]
    """<p>The unique name of the domain.</p>"""
    job_id: NotRequired["capo_customer_profiles.types.uuid.uuid"]
    """<p>The unique identifier of the Identity Resolution Job.</p>"""
    status: NotRequired[
        "capo_customer_profiles.types.identity_resolution_job_status.IdentityResolutionJobStatus"
    ]
    """<p>The status of the Identity Resolution Job.</p> <ul> <li> <p> <code>PENDING</code>: 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 <code>PENDING</code> state are deleted.</p> </li> <li> <p> <code>PREPROCESSING</code>: The Identity Resolution Job is loading your data.</p> </li> <li> <p> <code>FIND_MATCHING</code>: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.</p> </li> <li> <p> <code>MERGING</code>: The Identity Resolution Job is merging duplicate profiles.</p> </li> <li> <p> <code>COMPLETED</code>: The Identity Resolution Job completed successfully.</p> </li> <li> <p> <code>PARTIAL_SUCCESS</code>: 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.</p> </li> <li> <p> <code>FAILED</code>: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.</p> </li> </ul>"""
    job_start_time: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the job was started or will be started.</p>"""
    job_end_time: NotRequired["capo_customer_profiles.types.timestamp.timestamp"]
    """<p>The timestamp of when the job was completed.</p>"""
    job_stats: NotRequired["capo_customer_profiles.types.job_stats.JobStats"]
    """<p>Statistics about an Identity Resolution Job.</p>"""
    exporting_location: NotRequired[
        "capo_customer_profiles.types.exporting_location.ExportingLocation"
    ]
    """<p>The S3 location where the Identity Resolution Job writes result files.</p>"""
    message: NotRequired["capo_customer_profiles.types.string_to2048.stringTo2048"]
    """<p>The error messages that are generated when the Identity Resolution Job runs.</p>"""

domain_name instance-attribute

domain_name: NotRequired[name]

The unique name of the domain.

exporting_location instance-attribute

exporting_location: NotRequired[ExportingLocation]

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

job_end_time instance-attribute

job_end_time: NotRequired[timestamp]

The timestamp of when the job was completed.

job_id instance-attribute

job_id: NotRequired[uuid]

The unique identifier of the Identity Resolution Job.

job_start_time instance-attribute

job_start_time: NotRequired[timestamp]

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

job_stats instance-attribute

job_stats: NotRequired[JobStats]

Statistics about an Identity Resolution Job.

message instance-attribute

message: NotRequired[stringTo2048]

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

status instance-attribute

status: NotRequired[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.