matching_jobs

Creates, updates, deletes, gets or lists a matching_jobs resource.

Overview

Name	matching_jobs
Type	Resource
Id	aws.entityresolution.matching_jobs

Fields

The following fields are returned by SELECT queries:

get_matching_job

Name	Datatype	Description
end_time	string (date-time)	The time at which the job has finished.
error_details	object	An object containing an error message, if there was an error.
job_id	string	The unique identifier of the matching job. (pattern: <code>[a-f0-9]{32}</code>)
metrics	object	Metrics associated with the execution, specifically total records processed, unique IDs generated, and records the execution skipped.
output_source_config	array	A list of OutputSource objects.
start_time	string (date-time)	The time at which the job was started.
status	string	The current status of the job. (RUNNING, SUCCEEDED, FAILED, QUEUED)

list_matching_jobs

Name	Datatype	Description
end_time	string (date-time)	The time at which the job has finished.
job_id	string	The ID of the job. (pattern: <code>[a-f0-9]{32}</code>)
start_time	string (date-time)	The time at which the job was started.
status	string	The current status of the job. (RUNNING, SUCCEEDED, FAILED, QUEUED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_matching_job	select	workflow_name, job_id, region		Returns the status, metrics, and errors (if there are any) that are associated with a job.
list_matching_jobs	select	workflow_name, region	nextToken, maxResults	Lists all jobs for a given workflow.

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
job_id	string	The ID of the job.
region	string	AWS region (default: us-east-1)
workflow_name	string	The name of the workflow to be retrieved.
maxResults	integer	The maximum number of objects returned per page.
nextToken	string	The pagination token from the previous API call.

SELECT examples

get_matching_job

Returns the status, metrics, and errors (if there are any) that are associated with a job.

SELECT
end_time,
error_details,
job_id,
metrics,
output_source_config,
start_time,
status
FROM aws.entityresolution.matching_jobs
WHERE workflow_name = '{{ workflow_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_matching_jobs

Lists all jobs for a given workflow.

SELECT
end_time,
job_id,
start_time,
status
FROM aws.entityresolution.matching_jobs
WHERE workflow_name = '{{ workflow_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;