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 |
Starts a job run using a job definition.
Synopsis
- data StartJobRun = StartJobRun' {
- allocatedCapacity :: Maybe Int
- arguments :: Maybe (HashMap Text Text)
- executionClass :: Maybe ExecutionClass
- jobRunId :: Maybe Text
- maxCapacity :: Maybe Double
- notificationProperty :: Maybe NotificationProperty
- numberOfWorkers :: Maybe Int
- securityConfiguration :: Maybe Text
- timeout :: Maybe Natural
- workerType :: Maybe WorkerType
- jobName :: Text
- newStartJobRun :: Text -> StartJobRun
- startJobRun_allocatedCapacity :: Lens' StartJobRun (Maybe Int)
- startJobRun_arguments :: Lens' StartJobRun (Maybe (HashMap Text Text))
- startJobRun_executionClass :: Lens' StartJobRun (Maybe ExecutionClass)
- startJobRun_jobRunId :: Lens' StartJobRun (Maybe Text)
- startJobRun_maxCapacity :: Lens' StartJobRun (Maybe Double)
- startJobRun_notificationProperty :: Lens' StartJobRun (Maybe NotificationProperty)
- startJobRun_numberOfWorkers :: Lens' StartJobRun (Maybe Int)
- startJobRun_securityConfiguration :: Lens' StartJobRun (Maybe Text)
- startJobRun_timeout :: Lens' StartJobRun (Maybe Natural)
- startJobRun_workerType :: Lens' StartJobRun (Maybe WorkerType)
- startJobRun_jobName :: Lens' StartJobRun Text
- data StartJobRunResponse = StartJobRunResponse' {
- jobRunId :: Maybe Text
- httpStatus :: Int
- newStartJobRunResponse :: Int -> StartJobRunResponse
- startJobRunResponse_jobRunId :: Lens' StartJobRunResponse (Maybe Text)
- startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int
Creating a Request
data StartJobRun Source #
See: newStartJobRun
smart constructor.
StartJobRun' | |
|
Instances
Create a value of StartJobRun
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:
StartJobRun
, startJobRun_allocatedCapacity
- This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. 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.
StartJobRun
, startJobRun_arguments
- The job arguments specifically for 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.
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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
StartJobRun
, startJobRun_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.
StartJobRun
, startJobRun_jobRunId
- The ID of a previous JobRun
to retry.
StartJobRun
, startJobRun_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.
StartJobRun
, startJobRun_notificationProperty
- Specifies configuration properties of a job run notification.
StartJobRun
, startJobRun_numberOfWorkers
- The number of workers of a defined workerType
that are allocated when
a job runs.
StartJobRun
, startJobRun_securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this
job run.
StartJobRun
, startJobRun_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).
StartJobRun
, startJobRun_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.
StartJobRun
, startJobRun_jobName
- The name of the job definition to use.
Request Lenses
startJobRun_allocatedCapacity :: Lens' StartJobRun (Maybe Int) Source #
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun. 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.
startJobRun_arguments :: Lens' StartJobRun (Maybe (HashMap Text Text)) Source #
The job arguments specifically for 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.
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 key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
startJobRun_executionClass :: Lens' StartJobRun (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.
startJobRun_jobRunId :: Lens' StartJobRun (Maybe Text) Source #
The ID of a previous JobRun
to retry.
startJobRun_maxCapacity :: Lens' StartJobRun (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.
startJobRun_notificationProperty :: Lens' StartJobRun (Maybe NotificationProperty) Source #
Specifies configuration properties of a job run notification.
startJobRun_numberOfWorkers :: Lens' StartJobRun (Maybe Int) Source #
The number of workers of a defined workerType
that are allocated when
a job runs.
startJobRun_securityConfiguration :: Lens' StartJobRun (Maybe Text) Source #
The name of the SecurityConfiguration
structure to be used with this
job run.
startJobRun_timeout :: Lens' StartJobRun (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).
startJobRun_workerType :: Lens' StartJobRun (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.
startJobRun_jobName :: Lens' StartJobRun Text Source #
The name of the job definition to use.
Destructuring the Response
data StartJobRunResponse Source #
See: newStartJobRunResponse
smart constructor.
StartJobRunResponse' | |
|
Instances
newStartJobRunResponse Source #
Create a value of StartJobRunResponse
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:
StartJobRun
, startJobRunResponse_jobRunId
- The ID assigned to this job run.
$sel:httpStatus:StartJobRunResponse'
, startJobRunResponse_httpStatus
- The response's http status code.
Response Lenses
startJobRunResponse_jobRunId :: Lens' StartJobRunResponse (Maybe Text) Source #
The ID assigned to this job run.
startJobRunResponse_httpStatus :: Lens' StartJobRunResponse Int Source #
The response's http status code.