job_runs

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

Overview

Name	job_runs
Type	Resource
Id	aws.datazone.job_runs

Fields

The following fields are returned by SELECT queries:

get_job_run

Name	Datatype	Description
id	string	The ID of the job run.
created_at	string (date-time)	The timestamp of when the job run was created.
created_by	string	The user who created the job run.
details	object	The details of the job run.
domain_id	string	The ID of the domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
end_time	string (date-time)	The timestamp of when the job run ended.
error	object	The error generated if the action is not completed successfully.
job_id	string	The ID of the job run.
job_type	string	The type of the job run. (LINEAGE)
run_mode	string	The mode of the job run. (SCHEDULED, ON_DEMAND)
start_time	string (date-time)	The timestamp of when the job run started.
status	string	The status of the job run. (SCHEDULED, IN_PROGRESS, SUCCESS, PARTIALLY_SUCCEEDED, FAILED, ABORTED, TIMED_OUT, CANCELED)

list_job_runs

Name	Datatype	Description
created_at	string (date-time)	The timestamp at which job run was created.
created_by	string	The user who created the job run.
domain_id	string	The domain ID of the job run. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
end_time	string (date-time)	The end time of a job run.
error	object	The error of a job run.
job_id	string	The job ID of a job run.
job_type	string	The job type of a job run. (LINEAGE)
run_id	string	The run ID of a job run.
run_mode	string	The run mode of a job run. (SCHEDULED, ON_DEMAND)
start_time	string (date-time)	The start time of a job run.
status	string	The status of a job run. (SCHEDULED, IN_PROGRESS, SUCCESS, PARTIALLY_SUCCEEDED, FAILED, ABORTED, TIMED_OUT, CANCELED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_job_run	select	domain_identifier, identifier, region		The details of the job run.
list_job_runs	select	domain_identifier, job_identifier, region	status, sortOrder, nextToken, maxResults	Lists job runs.

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_identifier	string	The ID of the domain where you want to list job runs.
identifier	string	The ID of the job run.
job_identifier	string	The ID of the job run.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.
nextToken	string	When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.
sortOrder	string	Specifies the order in which job runs are to be sorted.
status	string	The status of a job run.

SELECT examples

get_job_run

The details of the job run.

SELECT
id,
created_at,
created_by,
details,
domain_id,
end_time,
error,
job_id,
job_type,
run_mode,
start_time,
status
FROM aws.datazone.job_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_job_runs

Lists job runs.

SELECT
created_at,
created_by,
domain_id,
end_time,
error,
job_id,
job_type,
run_id,
run_mode,
start_time,
status
FROM aws.datazone.job_runs
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND job_identifier = '{{ job_identifier }}' -- required
AND region = '{{ region }}' -- required
AND status = '{{ status }}'
AND sortOrder = '{{ sortOrder }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;