/AWS1/CL_GLUJOBUPDATE¶
Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_jobmode TYPE /AWS1/GLUJOBMODE /AWS1/GLUJOBMODE¶
A mode that describes how a job was created. Valid values are:
SCRIPT- The job was created using the Glue Studio script editor.
VISUAL- The job was created using the Glue Studio visual editor.
NOTEBOOK- The job was created using an interactive sessions notebook.When the
JobModefield is missing or null,SCRIPTis assigned as the default value.
iv_jobrunqueuingenabled TYPE /AWS1/GLUNULLABLEBOOLEAN /AWS1/GLUNULLABLEBOOLEAN¶
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.
iv_description TYPE /AWS1/GLUDESCRIPTIONSTRING /AWS1/GLUDESCRIPTIONSTRING¶
Description of the job being defined.
iv_loguri TYPE /AWS1/GLUURISTRING /AWS1/GLUURISTRING¶
This field is reserved for future use.
iv_role TYPE /AWS1/GLUROLESTRING /AWS1/GLUROLESTRING¶
The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
io_executionproperty TYPE REF TO /AWS1/CL_GLUEXECUTIONPROPERTY /AWS1/CL_GLUEXECUTIONPROPERTY¶
An
ExecutionPropertyspecifying the maximum number of concurrent runs allowed for this job.
io_command TYPE REF TO /AWS1/CL_GLUJOBCOMMAND /AWS1/CL_GLUJOBCOMMAND¶
The
JobCommandthat runs this job (required).
it_defaultarguments TYPE /AWS1/CL_GLUGENERICMAP_W=>TT_GENERICMAP TT_GENERICMAP¶
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 Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
it_nonoverridablearguments TYPE /AWS1/CL_GLUGENERICMAP_W=>TT_GENERICMAP TT_GENERICMAP¶
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
io_connections TYPE REF TO /AWS1/CL_GLUCONNECTIONSLIST /AWS1/CL_GLUCONNECTIONSLIST¶
The connections used for this job.
iv_maxretries TYPE /AWS1/GLUMAXRETRIES /AWS1/GLUMAXRETRIES¶
The maximum number of times to retry this job if it fails.
iv_allocatedcapacity TYPE /AWS1/GLUINTEGERVALUE /AWS1/GLUINTEGERVALUE¶
This field is deprecated. Use
MaxCapacityinstead.The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; 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 Glue pricing page.
iv_timeout TYPE /AWS1/GLUTIMEOUT /AWS1/GLUTIMEOUT¶
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters
TIMEOUTstatus.Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
iv_maxcapacity TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity. Instead, you should specify aWorker typeand theNumber of workers.Do not set
MaxCapacityif usingWorkerTypeandNumberOfWorkers.The value that can be allocated for
MaxCapacitydepends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (
JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.When you specify an Apache Spark ETL job (
JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
iv_workertype TYPE /AWS1/GLUWORKERTYPE /AWS1/GLUWORKERTYPE¶
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. For more information, see Defining job properties for Spark jobs
iv_numberofworkers TYPE /AWS1/GLUNULLABLEINTEGER /AWS1/GLUNULLABLEINTEGER¶
The number of workers of a defined
workerTypethat are allocated when a job runs.
iv_securityconfiguration TYPE /AWS1/GLUNAMESTRING /AWS1/GLUNAMESTRING¶
The name of the
SecurityConfigurationstructure to be used with this job.
io_notificationproperty TYPE REF TO /AWS1/CL_GLUNOTIFPROPERTY /AWS1/CL_GLUNOTIFPROPERTY¶
Specifies the configuration properties of a job notification.
iv_glueversion TYPE /AWS1/GLUGLUEVERSIONSTRING /AWS1/GLUGLUEVERSIONSTRING¶
In Spark jobs,
GlueVersiondetermines 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
GlueVersionto4.0or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntimeparameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
it_codegenconfigurationnodes TYPE /AWS1/CL_GLUCODEGENCONFNODE=>TT_CODEGENCONFIGURATIONNODES TT_CODEGENCONFIGURATIONNODES¶
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
iv_executionclass TYPE /AWS1/GLUEXECUTIONCLASS /AWS1/GLUEXECUTIONCLASS¶
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
glueetlwill be allowed to setExecutionClasstoFLEX. The flexible execution class is available for Spark jobs.
io_sourcecontroldetails TYPE REF TO /AWS1/CL_GLUSOURCECONTROLDETS /AWS1/CL_GLUSOURCECONTROLDETS¶
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
iv_maintenancewindow TYPE /AWS1/GLUMAINTENANCEWINDOW /AWS1/GLUMAINTENANCEWINDOW¶
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.
Queryable Attributes¶
JobMode¶
A mode that describes how a job was created. Valid values are:
SCRIPT- The job was created using the Glue Studio script editor.
VISUAL- The job was created using the Glue Studio visual editor.
NOTEBOOK- The job was created using an interactive sessions notebook.When the
JobModefield is missing or null,SCRIPTis assigned as the default value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBMODE() |
Getter for JOBMODE, with configurable default |
ASK_JOBMODE() |
Getter for JOBMODE w/ exceptions if field has no value |
HAS_JOBMODE() |
Determine if JOBMODE has a 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBRUNQUEUINGENABLED() |
Getter for JOBRUNQUEUINGENABLED, with configurable default |
ASK_JOBRUNQUEUINGENABLED() |
Getter for JOBRUNQUEUINGENABLED w/ exceptions if field has n |
HAS_JOBRUNQUEUINGENABLED() |
Determine if JOBRUNQUEUINGENABLED has a value |
Description¶
Description of the job being defined.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
LogUri¶
This field is reserved for future use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGURI() |
Getter for LOGURI, with configurable default |
ASK_LOGURI() |
Getter for LOGURI w/ exceptions if field has no value |
HAS_LOGURI() |
Determine if LOGURI has a value |
Role¶
The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLE() |
Getter for ROLE, with configurable default |
ASK_ROLE() |
Getter for ROLE w/ exceptions if field has no value |
HAS_ROLE() |
Determine if ROLE has a value |
ExecutionProperty¶
An
ExecutionPropertyspecifying the maximum number of concurrent runs allowed for this job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONPROPERTY() |
Getter for EXECUTIONPROPERTY |
Command¶
The
JobCommandthat runs this job (required).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMMAND() |
Getter for COMMAND |
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 Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTARGUMENTS() |
Getter for DEFAULTARGUMENTS, with configurable default |
ASK_DEFAULTARGUMENTS() |
Getter for DEFAULTARGUMENTS w/ exceptions if field has no va |
HAS_DEFAULTARGUMENTS() |
Determine if DEFAULTARGUMENTS has a value |
NonOverridableArguments¶
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NONOVERRIDABLEARGUMENTS() |
Getter for NONOVERRIDABLEARGUMENTS, with configurable defaul |
ASK_NONOVERRIDABLEARGUMENTS() |
Getter for NONOVERRIDABLEARGUMENTS w/ exceptions if field ha |
HAS_NONOVERRIDABLEARGUMENTS() |
Determine if NONOVERRIDABLEARGUMENTS has a value |
Connections¶
The connections used for this job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTIONS() |
Getter for CONNECTIONS |
MaxRetries¶
The maximum number of times to retry this job if it fails.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXRETRIES() |
Getter for MAXRETRIES |
AllocatedCapacity¶
This field is deprecated. Use
MaxCapacityinstead.The number of Glue data processing units (DPUs) to allocate to this job. You can allocate a minimum of 2 DPUs; 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 Glue pricing page.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALLOCATEDCAPACITY() |
Getter for ALLOCATEDCAPACITY |
Timeout¶
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters
TIMEOUTstatus.Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMEOUT() |
Getter for TIMEOUT, with configurable default |
ASK_TIMEOUT() |
Getter for TIMEOUT w/ exceptions if field has no value |
HAS_TIMEOUT() |
Determine if TIMEOUT has a value |
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 Glue pricing page.
For Glue version 2.0+ jobs, you cannot specify a
Maximum capacity. Instead, you should specify aWorker typeand theNumber of workers.Do not set
MaxCapacityif usingWorkerTypeandNumberOfWorkers.The value that can be allocated for
MaxCapacitydepends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
When you specify a Python shell job (
JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.When you specify an Apache Spark ETL job (
JobCommand.Name="glueetl") or Apache Spark streaming ETL job (JobCommand.Name="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXCAPACITY() |
Getter for MAXCAPACITY, with configurable default |
ASK_MAXCAPACITY() |
Getter for MAXCAPACITY w/ exceptions if field has no value |
STR_MAXCAPACITY() |
String format for MAXCAPACITY, with configurable default |
HAS_MAXCAPACITY() |
Determine if MAXCAPACITY has a value |
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. For more information, see Defining job properties for Spark jobs
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKERTYPE() |
Getter for WORKERTYPE, with configurable default |
ASK_WORKERTYPE() |
Getter for WORKERTYPE w/ exceptions if field has no value |
HAS_WORKERTYPE() |
Determine if WORKERTYPE has a value |
NumberOfWorkers¶
The number of workers of a defined
workerTypethat are allocated when a job runs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBEROFWORKERS() |
Getter for NUMBEROFWORKERS, with configurable default |
ASK_NUMBEROFWORKERS() |
Getter for NUMBEROFWORKERS w/ exceptions if field has no val |
HAS_NUMBEROFWORKERS() |
Determine if NUMBEROFWORKERS has a value |
SecurityConfiguration¶
The name of the
SecurityConfigurationstructure to be used with this job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECURITYCONFIGURATION() |
Getter for SECURITYCONFIGURATION, with configurable default |
ASK_SECURITYCONFIGURATION() |
Getter for SECURITYCONFIGURATION w/ exceptions if field has |
HAS_SECURITYCONFIGURATION() |
Determine if SECURITYCONFIGURATION has a value |
NotificationProperty¶
Specifies the configuration properties of a job notification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTIFICATIONPROPERTY() |
Getter for NOTIFICATIONPROPERTY |
GlueVersion¶
In Spark jobs,
GlueVersiondetermines 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
GlueVersionto4.0or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by theRuntimeparameter of the Job command.For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GLUEVERSION() |
Getter for GLUEVERSION, with configurable default |
ASK_GLUEVERSION() |
Getter for GLUEVERSION w/ exceptions if field has no value |
HAS_GLUEVERSION() |
Determine if GLUEVERSION has a value |
CodeGenConfigurationNodes¶
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CODEGENCONFNODES() |
Getter for CODEGENCONFIGURATIONNODES, with configurable defa |
ASK_CODEGENCONFNODES() |
Getter for CODEGENCONFIGURATIONNODES w/ exceptions if field |
HAS_CODEGENCONFNODES() |
Determine if CODEGENCONFIGURATIONNODES has a value |
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
glueetlwill be allowed to setExecutionClasstoFLEX. The flexible execution class is available for Spark jobs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONCLASS() |
Getter for EXECUTIONCLASS, with configurable default |
ASK_EXECUTIONCLASS() |
Getter for EXECUTIONCLASS w/ exceptions if field has no valu |
HAS_EXECUTIONCLASS() |
Determine if EXECUTIONCLASS has a value |
SourceControlDetails¶
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOURCECONTROLDETAILS() |
Getter for SOURCECONTROLDETAILS |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAINTENANCEWINDOW() |
Getter for MAINTENANCEWINDOW, with configurable default |
ASK_MAINTENANCEWINDOW() |
Getter for MAINTENANCEWINDOW w/ exceptions if field has no v |
HAS_MAINTENANCEWINDOW() |
Determine if MAINTENANCEWINDOW has a value |