CustomerProfiles / Client / list_identity_resolution_jobs

list_identity_resolution_jobs

CustomerProfiles.Client.list_identity_resolution_jobs(**kwargs)

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_resolution_jobs(
    DomainName='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• MaxResults (integer) – The maximum number of results to return per page.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityResolutionJobsList': [
        {
            'DomainName': 'string',
            'JobId': 'string',
            'Status': 'PENDING'|'PREPROCESSING'|'FIND_MATCHING'|'MERGING'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED',
            'JobStartTime': datetime(2015, 1, 1),
            'JobEndTime': datetime(2015, 1, 1),
            'JobStats': {
                'NumberOfProfilesReviewed': 123,
                'NumberOfMatchesFound': 123,
                'NumberOfMergesDone': 123
            },
            'ExportingLocation': {
                'S3Exporting': {
                    'S3BucketName': 'string',
                    'S3KeyName': 'string'
                }
            },
            'Message': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IdentityResolutionJobsList (list) –

    A list of Identity Resolution Jobs.

    • (dict) –

      Information about the Identity Resolution Job.

      • DomainName (string) –

        The unique name of the domain.

      • JobId (string) –

        The unique identifier of the Identity Resolution Job.

      • Status (string) –

        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.

      • JobStartTime (datetime) –

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

      • JobEndTime (datetime) –

        The timestamp of when the job was completed.

      • JobStats (dict) –

        Statistics about an Identity Resolution Job.

        • NumberOfProfilesReviewed (integer) –

          The number of profiles reviewed.

        • NumberOfMatchesFound (integer) –

          The number of matches found.

        • NumberOfMergesDone (integer) –

          The number of merges completed.

      • ExportingLocation (dict) –

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

        • S3Exporting (dict) –

          Information about the S3 location where Identity Resolution Jobs write result files.

          • S3BucketName (string) –

            The name of the S3 bucket name where Identity Resolution Jobs write result files.

          • S3KeyName (string) –

            The S3 key name of the location where Identity Resolution Jobs write result files.

      • Message (string) –

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

  • NextToken (string) –

    If there are additional results, this is the token for the next set of results.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException