identity_resolution_jobs

Creates, updates, deletes, gets or lists an identity_resolution_jobs resource.

Overview

Name	identity_resolution_jobs
Type	Resource
Id	aws.customer_profiles.identity_resolution_jobs

Fields

The following fields are returned by SELECT queries:

get_identity_resolution_job

Name	Datatype	Description
auto_merging	object	Configuration settings for how to perform the auto-merging of profiles.
domain_name	string	The unique name of the domain. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
exporting_location	object	The S3 location where the Identity Resolution Job writes result files.
job_end_time	string (date-time)	The timestamp of when the Identity Resolution Job was completed.
job_expiration_time	string (date-time)	The timestamp of when the Identity Resolution Job will expire.
job_id	string	The unique identifier of the Identity Resolution Job. (pattern: <code>[a-f0-9]{32}</code>)
job_start_time	string (date-time)	The timestamp of when the Identity Resolution Job was started or will be started.
job_stats	object	Statistics about the Identity Resolution Job.
last_updated_at	string (date-time)	The timestamp of when the Identity Resolution Job was most recently edited.
message	string	The error messages that are generated when the Identity Resolution Job runs. (pattern: <code>.*</code>)
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. (PENDING, PREPROCESSING, FIND_MATCHING, MERGING, COMPLETED, PARTIAL_SUCCESS, FAILED)

list_identity_resolution_jobs

Name	Datatype	Description
identity_resolution_jobs_list	array	A list of Identity Resolution Jobs.
next_token	string	If there are additional results, this is the token for the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_identity_resolution_job	select	domain_name, job_id, region		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.
list_identity_resolution_jobs	select	domain_name, region	next-token, max-results	Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The unique name of the domain.
job_id	string	The unique identifier of the Identity Resolution Job.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return per page.
next-token	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.

SELECT examples

get_identity_resolution_job

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.

SELECT
auto_merging,
domain_name,
exporting_location,
job_end_time,
job_expiration_time,
job_id,
job_start_time,
job_stats,
last_updated_at,
message,
status
FROM aws.customer_profiles.identity_resolution_jobs
WHERE domain_name = '{{ domain_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_identity_resolution_jobs

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

SELECT
identity_resolution_jobs_list,
next_token
FROM aws.customer_profiles.identity_resolution_jobs
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;