job_runs

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

Overview

Name	job_runs
Type	Resource
Id	aws.emr_containers.job_runs

Fields

The following fields are returned by SELECT queries:

describe_job_run

Name	Datatype	Description
id	string	The ID of the job run. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the job run. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN of job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/virtualclusters/[0-9a-zA-Z]+/jobruns/[0-9a-zA-Z]+$</code>)
client_token	string	The client token used to start a job run. (pattern: <code>.\S.</code>)
configuration_overrides	object	The configuration settings that are used to override default configuration.
created_at	string (date-time)	The date and time when the job run was created.
created_by	string	The user who created the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+$</code>)
execution_role_arn	string	The execution role ARN of the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$</code>)
failure_reason	string	The reasons why the job run has failed. (INTERNAL_ERROR, USER_ERROR, VALIDATION_ERROR, CLUSTER_UNAVAILABLE)
finished_at	string (date-time)	The date and time when the job run has finished.
job_driver	object	Parameters of job driver for the job run.
release_label	string	The release version of Amazon EMR. (pattern: <code>[.-_/A-Za-z0-9]+</code>)
retry_policy_configuration	object	The configuration of the retry policy that the job runs on.
retry_policy_execution	object	The current status of the retry policy executed on the job.
state	string	The state of the job run. (PENDING, SUBMITTED, RUNNING, FAILED, CANCELLED, CANCEL_PENDING, COMPLETED)
state_details	string	Additional details of the job run state. (pattern: <code>.\S.</code>)
tags	object	The assigned tags of the job run.
virtual_cluster_id	string	The ID of the job run's virtual cluster. (pattern: <code>[0-9a-z]+</code>)

list_job_runs

Name	Datatype	Description
id	string	The ID of the job run. (pattern: <code>[0-9a-z]+</code>)
name	string	The name of the job run. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
arn	string	The ARN of job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):/virtualclusters/[0-9a-zA-Z]+/jobruns/[0-9a-zA-Z]+$</code>)
client_token	string	The client token used to start a job run. (pattern: <code>.\S.</code>)
configuration_overrides	object	The configuration settings that are used to override default configuration.
created_at	string (date-time)	The date and time when the job run was created.
created_by	string	The user who created the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\d{12})?:[\w/+=,.@-]+$</code>)
execution_role_arn	string	The execution role ARN of the job run. (pattern: <code>^arn:(aws[a-zA-Z0-9-]*):iam::(\d{12})?:(role((\u002F)|(\u002F[\u0021-\u007F]+\u002F))[\w+=,.@-]+)$</code>)
failure_reason	string	The reasons why the job run has failed. (INTERNAL_ERROR, USER_ERROR, VALIDATION_ERROR, CLUSTER_UNAVAILABLE)
finished_at	string (date-time)	The date and time when the job run has finished.
job_driver	object	Parameters of job driver for the job run.
release_label	string	The release version of Amazon EMR. (pattern: <code>[.-_/A-Za-z0-9]+</code>)
retry_policy_configuration	object	The configuration of the retry policy that the job runs on.
retry_policy_execution	object	The current status of the retry policy executed on the job.
state	string	The state of the job run. (PENDING, SUBMITTED, RUNNING, FAILED, CANCELLED, CANCEL_PENDING, COMPLETED)
state_details	string	Additional details of the job run state. (pattern: <code>.\S.</code>)
tags	object	The assigned tags of the job run.
virtual_cluster_id	string	The ID of the job run's virtual cluster. (pattern: <code>[0-9a-z]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_job_run	select	job_run_id, virtual_cluster_id, region		Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
list_job_runs	select	virtual_cluster_id, region	createdBefore, createdAfter, name, states, maxResults, nextToken	Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

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_run_id	string	The ID of the job run request.
region	string	AWS region (default: us-east-1)
virtual_cluster_id	string	The ID of the virtual cluster for which to list the job run.
createdAfter	string (date-time)	The date and time after which the job runs were submitted.
createdBefore	string (date-time)	The date and time before which the job runs were submitted.
maxResults	integer	The maximum number of job runs that can be listed.
name	string	The name of the job run.
nextToken	string	The token for the next set of job runs to return.
states	array	The states of the job run.

SELECT examples

describe_job_run

Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

SELECT
id,
name,
arn,
client_token,
configuration_overrides,
created_at,
created_by,
execution_role_arn,
failure_reason,
finished_at,
job_driver,
release_label,
retry_policy_configuration,
retry_policy_execution,
state,
state_details,
tags,
virtual_cluster_id
FROM aws.emr_containers.job_runs
WHERE job_run_id = '{{ job_run_id }}' -- required
AND virtual_cluster_id = '{{ virtual_cluster_id }}' -- required
AND region = '{{ region }}' -- required
;

list_job_runs

Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

SELECT
id,
name,
arn,
client_token,
configuration_overrides,
created_at,
created_by,
execution_role_arn,
failure_reason,
finished_at,
job_driver,
release_label,
retry_policy_configuration,
retry_policy_execution,
state,
state_details,
tags,
virtual_cluster_id
FROM aws.emr_containers.job_runs
WHERE virtual_cluster_id = '{{ virtual_cluster_id }}' -- required
AND region = '{{ region }}' -- required
AND createdBefore = '{{ createdBefore }}'
AND createdAfter = '{{ createdAfter }}'
AND name = '{{ name }}'
AND states = '{{ states }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;