Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . glue ]



Retrieves an existing job definition.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--job-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--job-name (string)

The name of the job definition to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


Job -> (structure)

The requested job definition.

Name -> (string)

The name you assign to this job definition.

Description -> (string)

Description of the job being defined.

LogUri -> (string)

This field is reserved for future use.

Role -> (string)

The name or ARN of the IAM role associated with this job.

CreatedOn -> (timestamp)

The time and date that this job definition was created.

LastModifiedOn -> (timestamp)

The last point in time when this job definition was modified.

ExecutionProperty -> (structure)

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

MaxConcurrentRuns -> (integer)

The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

Command -> (structure)

The JobCommand that executes this job.

Name -> (string)

The name of the job command: this must be glueetl , for an Apache Spark ETL job, or pythonshell , for a Python shell job.

ScriptLocation -> (string)

Specifies the S3 path to a script that executes a job (required).

DefaultArguments -> (map)

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

key -> (string)

value -> (string)

Connections -> (structure)

The connections used for this job.

Connections -> (list)

A list of connections used by the job.


MaxRetries -> (integer)

The maximum number of times to retry this job after a JobRun fails.

AllocatedCapacity -> (integer)

This field is deprecated, use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page .

Timeout -> (integer)

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

MaxCapacity -> (double)

AWS Glue supports running jobs on a JobCommand.Name ="pythonshell" with allocated processing as low as 0.0625 DPU, which can be specified using MaxCapacity . Glue ETL jobs running in any other way cannot have fractional DPU allocations.

NotificationProperty -> (structure)

Specifies configuration properties of a job notification.

NotifyDelayAfter -> (integer)

After a job run starts, the number of minutes to wait before sending a job run delay notification.

SecurityConfiguration -> (string)

The name of the SecurityConfiguration structure to be used with this job.