Pass context about job runs into job tasks

You can pass templated variables into a job task as part of the task’s parameters. These variables are replaced with the appropriate values when the job task runs. You can use task parameter values to pass the context about a job run, such as the run ID or the job’s start time.

When a job runs, the task parameter variable surrounded by double curly braces is replaced and appended to an optional string value included as part of the value. For example, to pass a parameter named MyJobId with a value of my-job-6 for any run of job ID 6, add the following task parameter:

{
  "MyJobID": "my-job-{{job_id}}"
}

The contents of the double curly braces are not evaluated as expressions, so you cannot do operations or functions within double-curly braces. Because whitespace is not stripped inside the double curly braces, do not add extra spaces inside the braces. For example, the variable {{  job_id  }} is not evaluated.

The following task parameter variables are supported:

Variable

Description

Example value

{{job_id}}

The unique identifier assigned to a job.

1276862

{{run_id}}

The unique identifier assigned to a task run.

3447843

{{start_date}}

The date a task run started. The format is yyyy-MM-dd in UTC timezone.

2021-02-15

{{start_time}}

The timestamp of the run’s start of execution after the cluster is created and ready. The format is milliseconds since UNIX epoch in UTC timezone, as returned by System.currentTimeMillis().

1551622063030

{{task_retry_count}}

The number of retries that have been attempted to run a task if the first attempt fails. The value is 0 for the first attempt and increments with each retry.

0

{{parent_run_id}}

The unique identifier assigned to the run of a job with multiple tasks.

3447835

{{task_key}}

The unique name assigned to a task that’s part of a job with multiple tasks.

clean_raw_data

You can set these variables with any task when you Create a job, Edit a job, or Run a job with different parameters.

You can also pass parameters between tasks in a job with task values. See Share information between tasks in a Databricks job.