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 JobRun = JobRun' {
- allocatedCapacity :: Maybe Int
- arguments :: Maybe (HashMap Text Text)
- attempt :: Maybe Int
- completedOn :: Maybe POSIX
- dPUSeconds :: Maybe Double
- errorMessage :: Maybe Text
- executionClass :: Maybe ExecutionClass
- executionTime :: Maybe Int
- glueVersion :: Maybe Text
- id :: Maybe Text
- jobName :: Maybe Text
- jobRunState :: Maybe JobRunState
- lastModifiedOn :: Maybe POSIX
- logGroupName :: Maybe Text
- maxCapacity :: Maybe Double
- notificationProperty :: Maybe NotificationProperty
- numberOfWorkers :: Maybe Int
- predecessorRuns :: Maybe [Predecessor]
- previousRunId :: Maybe Text
- securityConfiguration :: Maybe Text
- startedOn :: Maybe POSIX
- timeout :: Maybe Natural
- triggerName :: Maybe Text
- workerType :: Maybe WorkerType
- newJobRun :: JobRun
- jobRun_allocatedCapacity :: Lens' JobRun (Maybe Int)
- jobRun_arguments :: Lens' JobRun (Maybe (HashMap Text Text))
- jobRun_attempt :: Lens' JobRun (Maybe Int)
- jobRun_completedOn :: Lens' JobRun (Maybe UTCTime)
- jobRun_dPUSeconds :: Lens' JobRun (Maybe Double)
- jobRun_errorMessage :: Lens' JobRun (Maybe Text)
- jobRun_executionClass :: Lens' JobRun (Maybe ExecutionClass)
- jobRun_executionTime :: Lens' JobRun (Maybe Int)
- jobRun_glueVersion :: Lens' JobRun (Maybe Text)
- jobRun_id :: Lens' JobRun (Maybe Text)
- jobRun_jobName :: Lens' JobRun (Maybe Text)
- jobRun_jobRunState :: Lens' JobRun (Maybe JobRunState)
- jobRun_lastModifiedOn :: Lens' JobRun (Maybe UTCTime)
- jobRun_logGroupName :: Lens' JobRun (Maybe Text)
- jobRun_maxCapacity :: Lens' JobRun (Maybe Double)
- jobRun_notificationProperty :: Lens' JobRun (Maybe NotificationProperty)
- jobRun_numberOfWorkers :: Lens' JobRun (Maybe Int)
- jobRun_predecessorRuns :: Lens' JobRun (Maybe [Predecessor])
- jobRun_previousRunId :: Lens' JobRun (Maybe Text)
- jobRun_securityConfiguration :: Lens' JobRun (Maybe Text)
- jobRun_startedOn :: Lens' JobRun (Maybe UTCTime)
- jobRun_timeout :: Lens' JobRun (Maybe Natural)
- jobRun_triggerName :: Lens' JobRun (Maybe Text)
- jobRun_workerType :: Lens' JobRun (Maybe WorkerType)
Documentation
Contains information about a job run.
See: newJobRun
smart constructor.
JobRun' | |
|
Instances
Create a value of JobRun
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:JobRun'
, jobRun_allocatedCapacity
- This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. 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 Glue pricing page.
$sel:arguments:JobRun'
, jobRun_arguments
- The job arguments associated with this run. For this job run, they
replace the default arguments set in the job definition itself.
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:attempt:JobRun'
, jobRun_attempt
- The number of the attempt to run this job.
$sel:completedOn:JobRun'
, jobRun_completedOn
- The date and time that this job run completed.
$sel:dPUSeconds:JobRun'
, jobRun_dPUSeconds
- This field populates only for Auto Scaling job runs, and represents the
total time each executor ran during the lifecycle of a job run in
seconds, multiplied by a DPU factor (1 for G.1X
, 2 for G.2X
, or 0.25
for G.025X
workers). This value may be different than the
executionEngineRuntime
* MaxCapacity
as in the case of Auto Scaling
jobs, as the number of executors running at a given time may be less
than the MaxCapacity
. Therefore, it is possible that the value of
DPUSeconds
is less than executionEngineRuntime
* MaxCapacity
.
$sel:errorMessage:JobRun'
, jobRun_errorMessage
- An error message associated with this job run.
$sel:executionClass:JobRun'
, jobRun_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:executionTime:JobRun'
, jobRun_executionTime
- The amount of time (in seconds) that the job run consumed resources.
$sel:glueVersion:JobRun'
, jobRun_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:id:JobRun'
, jobRun_id
- The ID of this job run.
JobRun
, jobRun_jobName
- The name of the job definition being used in this run.
$sel:jobRunState:JobRun'
, jobRun_jobRunState
- The current state of the job run. For more information about the
statuses of jobs that have terminated abnormally, see
Glue Job Run Statuses.
$sel:lastModifiedOn:JobRun'
, jobRun_lastModifiedOn
- The last time that this job run was modified.
$sel:logGroupName:JobRun'
, jobRun_logGroupName
- The name of the log group for secure logging that can be server-side
encrypted in Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption is NONE
. If
you add a role name and SecurityConfiguration
name (in other words,
/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then
that security configuration is used to encrypt the log group.
$sel:maxCapacity:JobRun'
, jobRun_maxCapacity
- 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 or an Apache Spark 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"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
$sel:notificationProperty:JobRun'
, jobRun_notificationProperty
- Specifies configuration properties of a job run notification.
$sel:numberOfWorkers:JobRun'
, jobRun_numberOfWorkers
- The number of workers of a defined workerType
that are allocated when
a job runs.
$sel:predecessorRuns:JobRun'
, jobRun_predecessorRuns
- A list of predecessors to this job run.
$sel:previousRunId:JobRun'
, jobRun_previousRunId
- The ID of the previous run of this job. For example, the JobRunId
specified in the StartJobRun
action.
$sel:securityConfiguration:JobRun'
, jobRun_securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this
job run.
$sel:startedOn:JobRun'
, jobRun_startedOn
- The date and time at which this job run was started.
$sel:timeout:JobRun'
, jobRun_timeout
- The JobRun
timeout in minutes. This is the maximum time that a job run
can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
$sel:triggerName:JobRun'
, jobRun_triggerName
- The name of the trigger that started this job run.
$sel:workerType:JobRun'
, jobRun_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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. - For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. - 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.
jobRun_allocatedCapacity :: Lens' JobRun (Maybe Int) Source #
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to this JobRun. 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 Glue pricing page.
jobRun_arguments :: Lens' JobRun (Maybe (HashMap Text Text)) Source #
The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
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.
jobRun_completedOn :: Lens' JobRun (Maybe UTCTime) Source #
The date and time that this job run completed.
jobRun_dPUSeconds :: Lens' JobRun (Maybe Double) Source #
This field populates only for Auto Scaling job runs, and represents the
total time each executor ran during the lifecycle of a job run in
seconds, multiplied by a DPU factor (1 for G.1X
, 2 for G.2X
, or 0.25
for G.025X
workers). This value may be different than the
executionEngineRuntime
* MaxCapacity
as in the case of Auto Scaling
jobs, as the number of executors running at a given time may be less
than the MaxCapacity
. Therefore, it is possible that the value of
DPUSeconds
is less than executionEngineRuntime
* MaxCapacity
.
jobRun_errorMessage :: Lens' JobRun (Maybe Text) Source #
An error message associated with this job run.
jobRun_executionClass :: Lens' JobRun (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.
jobRun_executionTime :: Lens' JobRun (Maybe Int) Source #
The amount of time (in seconds) that the job run consumed resources.
jobRun_glueVersion :: Lens' JobRun (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.
jobRun_jobName :: Lens' JobRun (Maybe Text) Source #
The name of the job definition being used in this run.
jobRun_jobRunState :: Lens' JobRun (Maybe JobRunState) Source #
The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
jobRun_lastModifiedOn :: Lens' JobRun (Maybe UTCTime) Source #
The last time that this job run was modified.
jobRun_logGroupName :: Lens' JobRun (Maybe Text) Source #
The name of the log group for secure logging that can be server-side
encrypted in Amazon CloudWatch using KMS. This name can be
/aws-glue/jobs/
, in which case the default encryption is NONE
. If
you add a role name and SecurityConfiguration
name (in other words,
/aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/
), then
that security configuration is used to encrypt the log group.
jobRun_maxCapacity :: Lens' JobRun (Maybe Double) Source #
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 or an Apache Spark 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"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
jobRun_notificationProperty :: Lens' JobRun (Maybe NotificationProperty) Source #
Specifies configuration properties of a job run notification.
jobRun_numberOfWorkers :: Lens' JobRun (Maybe Int) Source #
The number of workers of a defined workerType
that are allocated when
a job runs.
jobRun_predecessorRuns :: Lens' JobRun (Maybe [Predecessor]) Source #
A list of predecessors to this job run.
jobRun_previousRunId :: Lens' JobRun (Maybe Text) Source #
The ID of the previous run of this job. For example, the JobRunId
specified in the StartJobRun
action.
jobRun_securityConfiguration :: Lens' JobRun (Maybe Text) Source #
The name of the SecurityConfiguration
structure to be used with this
job run.
jobRun_startedOn :: Lens' JobRun (Maybe UTCTime) Source #
The date and time at which this job run was started.
jobRun_timeout :: Lens' JobRun (Maybe Natural) Source #
The JobRun
timeout in minutes. This is the maximum time that a job run
can consume resources before it is terminated and enters TIMEOUT
status. This value overrides the timeout value set in the parent job.
Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
jobRun_triggerName :: Lens' JobRun (Maybe Text) Source #
The name of the trigger that started this job run.
jobRun_workerType :: Lens' JobRun (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 provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. - For the
G.2X
worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. - 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.