CreateJobCommand

Use a bare-bones client and the command you need to make an API call.

CreateJobCommandInput

[CreateJobCommandInput](@aws-sdk/client-glue!CreateJobCommandInput:Interface)

Command

The <code>JobCommand</code> that runs this job.

Name

The name you assign to this job definition. It must be unique in your account.

Role

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

AllocatedCapacity

CodeGenConfigurationNodes

The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

Connections

The connections used for this job.

DefaultArguments

The default arguments for every run of this job, specified as name-value pairs. You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes. Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job. For information about how to specify and consume your own Job arguments, see the <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling Glue APIs in Python</a> topic in the developer guide. For information about the arguments you can provide to this field when configuring Spark jobs, see the <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special Parameters Used by Glue</a> topic in the developer guide. For information about the arguments you can provide to this field when configuring Ray jobs, see <a href="https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html">Using job parameters in Ray jobs</a> in the developer guide.

Description

Description of the job being defined.

ExecutionClass

Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. Only jobs with Glue version 3.0 and above and command type <code>glueetl</code> will be allowed to set <code>ExecutionClass</code> to <code>FLEX</code>. The flexible execution class is available for Spark jobs.

ExecutionProperty

An <code>ExecutionProperty</code> specifying the maximum number of concurrent runs allowed for this job.

GlueVersion

In Spark jobs, <code>GlueVersion</code> determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark. Ray jobs should set <code>GlueVersion</code> to <code>4.0</code> or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the <code>Runtime</code> parameter of the Job command. For more information about the available Glue versions and corresponding Spark and Python versions, see <a href="https://docs.aws.amazon.com/glue/latest/dg/add-job.html">Glue version</a> in the developer guide. Jobs that are created without specifying a Glue version default to Glue 0.9.

JobMode

A mode that describes how a job was created. Valid values are: <ul> <li> <code>SCRIPT</code> - The job was created using the Glue Studio script editor. </li> <li> <code>VISUAL</code> - The job was created using the Glue Studio visual editor. </li> <li> <code>NOTEBOOK</code> - The job was created using an interactive sessions notebook. </li> </ul> When the <code>JobMode</code> field is missing or null, <code>SCRIPT</code> is assigned as the default value.

JobRunQueuingEnabled

Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. If this field does not match the value set in the job run, then the value from the job run field will be used.

LogUri

This field is reserved for future use.

MaintenanceWindow

This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs. Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.

MaxCapacity

For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. 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 <a href="https://aws.amazon.com/glue/pricing/"> Glue pricing page</a>. For Glue version 2.0+ jobs, you cannot specify a <code>Maximum capacity</code>. Instead, you should specify a <code>Worker type</code> and the <code>Number of workers</code>. Do not set <code>MaxCapacity</code> if using <code>WorkerType</code> and <code>NumberOfWorkers</code>. The value that can be allocated for <code>MaxCapacity</code> depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job: <ul> <li> When you specify a Python shell job (<code>JobCommand.Name</code>="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. </li> <li> When you specify an Apache Spark ETL job (<code>JobCommand.Name</code>="glueetl") or Apache Spark streaming ETL job (<code>JobCommand.Name</code>="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. </li> </ul>

MaxRetries

The maximum number of times to retry this job if it fails.

NonOverridableArguments

Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.

NotificationProperty

Specifies configuration properties of a job notification.

NumberOfWorkers

The number of workers of a defined <code>workerType</code> that are allocated when a job runs.

SecurityConfiguration

The name of the <code>SecurityConfiguration</code> structure to be used with this job.

SourceControlDetails

The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.

Timeout

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs. Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

WorkerType

The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. <ul> <li> For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. </li> <li> For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. </li> <li> For the <code>G.4X</code> worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). </li> <li> For the <code>G.8X</code> worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the <code>G.4X</code> worker type. </li> <li> For the <code>G.025X</code> worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 or later streaming jobs. </li> <li> For the <code>Z.2X</code> worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler. </li> </ul>

The input for [CreateJobCommand](@aws-sdk/client-glue!CreateJobCommand:Class).

$metadata

The unique name that was provided for this job definition.

CreateJobCommandOutput

The output of [CreateJobCommand](@aws-sdk/client-glue!CreateJobCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

Message

name

AlreadyExistsException

A resource to be created or added already exists.

ConcurrentModificationException

Two processes are trying to modify a resource simultaneously.

IdempotentParameterMismatchException

The same unique identifier was associated with two different records.

InternalServiceException

An internal service error occurred.

FromFederationSource

Indicates whether or not the exception relates to a federated source.

InvalidInputException

OperationTimeoutException

ResourceNumberLimitExceededException

A resource numerical limit was exceeded.

GlueServiceException

Base exception class for all service exceptions from Glue service.