Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Job = Job' {
- allocatedCapacity :: Maybe Int
- codeGenConfigurationNodes :: Maybe (Sensitive (HashMap Text CodeGenConfigurationNode))
- command :: Maybe JobCommand
- connections :: Maybe ConnectionsList
- createdOn :: Maybe POSIX
- defaultArguments :: Maybe (HashMap Text Text)
- description :: Maybe Text
- executionClass :: Maybe ExecutionClass
- executionProperty :: Maybe ExecutionProperty
- glueVersion :: Maybe Text
- lastModifiedOn :: Maybe POSIX
- logUri :: Maybe Text
- maxCapacity :: Maybe Double
- maxRetries :: Maybe Int
- name :: Maybe Text
- nonOverridableArguments :: Maybe (HashMap Text Text)
- notificationProperty :: Maybe NotificationProperty
- numberOfWorkers :: Maybe Int
- role' :: Maybe Text
- securityConfiguration :: Maybe Text
- sourceControlDetails :: Maybe SourceControlDetails
- timeout :: Maybe Natural
- workerType :: Maybe WorkerType
- newJob :: Job
- job_allocatedCapacity :: Lens' Job (Maybe Int)
- job_codeGenConfigurationNodes :: Lens' Job (Maybe (HashMap Text CodeGenConfigurationNode))
- job_command :: Lens' Job (Maybe JobCommand)
- job_connections :: Lens' Job (Maybe ConnectionsList)
- job_createdOn :: Lens' Job (Maybe UTCTime)
- job_defaultArguments :: Lens' Job (Maybe (HashMap Text Text))
- job_description :: Lens' Job (Maybe Text)
- job_executionClass :: Lens' Job (Maybe ExecutionClass)
- job_executionProperty :: Lens' Job (Maybe ExecutionProperty)
- job_glueVersion :: Lens' Job (Maybe Text)
- job_lastModifiedOn :: Lens' Job (Maybe UTCTime)
- job_logUri :: Lens' Job (Maybe Text)
- job_maxCapacity :: Lens' Job (Maybe Double)
- job_maxRetries :: Lens' Job (Maybe Int)
- job_name :: Lens' Job (Maybe Text)
- job_nonOverridableArguments :: Lens' Job (Maybe (HashMap Text Text))
- job_notificationProperty :: Lens' Job (Maybe NotificationProperty)
- job_numberOfWorkers :: Lens' Job (Maybe Int)
- job_role :: Lens' Job (Maybe Text)
- job_securityConfiguration :: Lens' Job (Maybe Text)
- job_sourceControlDetails :: Lens' Job (Maybe SourceControlDetails)
- job_timeout :: Lens' Job (Maybe Natural)
- job_workerType :: Lens' Job (Maybe WorkerType)
Documentation
Specifies a job definition.
See: newJob
smart constructor.
Job' | |
|
Instances
Create a value of Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allocatedCapacity:Job'
, job_allocatedCapacity
- This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of 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.
$sel:codeGenConfigurationNodes:Job'
, job_codeGenConfigurationNodes
- The representation of a directed acyclic graph on which both the Glue
Studio visual component and Glue Studio code generation is based.
$sel:command:Job'
, job_command
- The JobCommand
that runs this job.
Job
, job_connections
- The connections used for this job.
$sel:createdOn:Job'
, job_createdOn
- The time and date that this job definition was created.
$sel:defaultArguments:Job'
, job_defaultArguments
- 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 Glue itself consumes.
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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
$sel:description:Job'
, job_description
- A description of the job.
$sel:executionClass:Job'
, job_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 glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible
execution class is available for Spark jobs.
$sel:executionProperty:Job'
, job_executionProperty
- An ExecutionProperty
specifying the maximum number of concurrent runs
allowed for this job.
$sel:glueVersion:Job'
, job_glueVersion
- Glue version determines the versions of Apache Spark and Python that
Glue supports. The Python version indicates the version supported for
jobs of type Spark.
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.
$sel:lastModifiedOn:Job'
, job_lastModifiedOn
- The last point in time when this job definition was modified.
$sel:logUri:Job'
, job_logUri
- This field is reserved for future use.
$sel:maxCapacity:Job'
, job_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.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends 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 a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a
Maximum capacity
. Instead, you should specify a Worker type
and the
Number of workers
.
$sel:maxRetries:Job'
, job_maxRetries
- The maximum number of times to retry this job after a JobRun fails.
Job
, job_name
- The name you assign to this job definition.
$sel:nonOverridableArguments:Job'
, job_nonOverridableArguments
- Non-overridable arguments for this job, specified as name-value pairs.
$sel:notificationProperty:Job'
, job_notificationProperty
- Specifies configuration properties of a job notification.
$sel:numberOfWorkers:Job'
, job_numberOfWorkers
- The number of workers of a defined workerType
that are allocated when
a job runs.
$sel:role':Job'
, job_role
- The name or Amazon Resource Name (ARN) of the IAM role associated with
this job.
$sel:securityConfiguration:Job'
, job_securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this
job.
$sel:sourceControlDetails:Job'
, job_sourceControlDetails
- The details for a source control configuration for a job, allowing
synchronization of job artifacts to or from a remote repository.
$sel:timeout:Job'
, job_timeout
- 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).
$sel:workerType:Job'
, job_workerType
- The type of predefined worker that is allocated when a job runs. Accepts
a value of Standard, G.1X, G.2X, or G.025X.
- For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. - For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. - For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB 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 streaming jobs.
job_allocatedCapacity :: Lens' Job (Maybe Int) Source #
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of 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.
job_codeGenConfigurationNodes :: Lens' Job (Maybe (HashMap Text CodeGenConfigurationNode)) Source #
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
job_command :: Lens' Job (Maybe JobCommand) Source #
The JobCommand
that runs this job.
job_connections :: Lens' Job (Maybe ConnectionsList) Source #
The connections used for this job.
job_createdOn :: Lens' Job (Maybe UTCTime) Source #
The time and date that this job definition was created.
job_defaultArguments :: Lens' Job (Maybe (HashMap Text Text)) Source #
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 Glue itself consumes.
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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
job_executionClass :: Lens' Job (Maybe ExecutionClass) Source #
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 glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible
execution class is available for Spark jobs.
job_executionProperty :: Lens' Job (Maybe ExecutionProperty) Source #
An ExecutionProperty
specifying the maximum number of concurrent runs
allowed for this job.
job_glueVersion :: Lens' Job (Maybe Text) Source #
Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
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.
job_lastModifiedOn :: Lens' Job (Maybe UTCTime) Source #
The last point in time when this job definition was modified.
job_maxCapacity :: Lens' Job (Maybe Double) Source #
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.
Do not set Max Capacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends 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 a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a
Maximum capacity
. Instead, you should specify a Worker type
and the
Number of workers
.
job_maxRetries :: Lens' Job (Maybe Int) Source #
The maximum number of times to retry this job after a JobRun fails.
job_nonOverridableArguments :: Lens' Job (Maybe (HashMap Text Text)) Source #
Non-overridable arguments for this job, specified as name-value pairs.
job_notificationProperty :: Lens' Job (Maybe NotificationProperty) Source #
Specifies configuration properties of a job notification.
job_numberOfWorkers :: Lens' Job (Maybe Int) Source #
The number of workers of a defined workerType
that are allocated when
a job runs.
job_role :: Lens' Job (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
job_securityConfiguration :: Lens' Job (Maybe Text) Source #
The name of the SecurityConfiguration
structure to be used with this
job.
job_sourceControlDetails :: Lens' Job (Maybe SourceControlDetails) Source #
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
job_timeout :: Lens' Job (Maybe Natural) Source #
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).
job_workerType :: Lens' Job (Maybe WorkerType) Source #
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
- For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. - For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. - For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB 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 streaming jobs.