job_runs

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

Overview

Name	job_runs
Type	Resource
Id	aws.databrew.job_runs

Fields

The following fields are returned by SELECT queries:

describe_job_run

Name	Datatype	Description
attempt	integer	The number of times that DataBrew has attempted to run the job.
completed_on	string (date-time)	The date and time when the job completed processing.
data_catalog_outputs	array	One or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs	array	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
dataset_name	string	The name of the dataset for the job to process.
error_message	string	A message indicating an error (if any) that was encountered when the job ran.
execution_time	integer	The amount of time, in seconds, during which the job run consumed resources.
job_name	string	The name of the job being processed during this run.
job_sample	object	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
log_group_name	string	The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
log_subscription	string	The current status of Amazon CloudWatch logging for the job run. (ENABLE, DISABLE)
outputs	array	One or more output artifacts from a job run.
profile_configuration	object	Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.
recipe_reference	object	Represents the name and version of a DataBrew recipe.
run_id	string	The unique identifier of the job run.
started_by	string	The Amazon Resource Name (ARN) of the user who started the job run.
started_on	string (date-time)	The date and time when the job run began.
state	string	The current state of the job run entity itself. (STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT)
validation_configurations	array	List of validation configurations that are applied to the profile job.

list_job_runs

Name	Datatype	Description
attempt	integer	The number of times that DataBrew has attempted to run the job.
completed_on	string (date-time)	The date and time when the job completed processing.
data_catalog_outputs	array	One or more artifacts that represent the Glue Data Catalog output from running the job.
database_outputs	array	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
dataset_name	string	The name of the dataset for the job to process.
error_message	string	A message indicating an error (if any) that was encountered when the job ran.
execution_time	integer	The amount of time, in seconds, during which a job run consumed resources.
job_name	string	The name of the job being processed during this run.
job_sample	object	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
log_group_name	string	The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.
log_subscription	string	The current status of Amazon CloudWatch logging for the job run. (ENABLE, DISABLE)
outputs	array	One or more output artifacts from a job run.
recipe_reference	object	Represents the name and version of a DataBrew recipe.
run_id	string	The unique identifier of the job run.
started_by	string	The Amazon Resource Name (ARN) of the user who initiated the job run.
started_on	string (date-time)	The date and time when the job run began.
state	string	The current state of the job run entity itself. (STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT)
validation_configurations	array	List of validation configurations that are applied to the profile job run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_job_run	select	name, run_id, region		Represents one run of a DataBrew job.
list_job_runs	select	name, region	maxResults, nextToken	Lists all of the previous runs of a particular DataBrew job.

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
name	string	The name of the job.
region	string	AWS region (default: us-east-1)
run_id	string	The unique identifier of the job run.
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	The token returned by a previous call to retrieve the next set of results.

SELECT examples

describe_job_run

Represents one run of a DataBrew job.

SELECT
attempt,
completed_on,
data_catalog_outputs,
database_outputs,
dataset_name,
error_message,
execution_time,
job_name,
job_sample,
log_group_name,
log_subscription,
outputs,
profile_configuration,
recipe_reference,
run_id,
started_by,
started_on,
state,
validation_configurations
FROM aws.databrew.job_runs
WHERE name = '{{ name }}' -- required
AND run_id = '{{ run_id }}' -- required
AND region = '{{ region }}' -- required
;

list_job_runs

Lists all of the previous runs of a particular DataBrew job.

SELECT
attempt,
completed_on,
data_catalog_outputs,
database_outputs,
dataset_name,
error_message,
execution_time,
job_name,
job_sample,
log_group_name,
log_subscription,
outputs,
recipe_reference,
run_id,
started_by,
started_on,
state,
validation_configurations
FROM aws.databrew.job_runs
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;