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 |
Creates a new job definition.
Synopsis
- data CreateJob = CreateJob' {
- allocatedCapacity :: Maybe Int
- codeGenConfigurationNodes :: Maybe (Sensitive (HashMap Text CodeGenConfigurationNode))
- connections :: Maybe ConnectionsList
- defaultArguments :: Maybe (HashMap Text Text)
- description :: Maybe Text
- executionClass :: Maybe ExecutionClass
- executionProperty :: Maybe ExecutionProperty
- glueVersion :: Maybe Text
- logUri :: Maybe Text
- maxCapacity :: Maybe Double
- maxRetries :: Maybe Int
- nonOverridableArguments :: Maybe (HashMap Text Text)
- notificationProperty :: Maybe NotificationProperty
- numberOfWorkers :: Maybe Int
- securityConfiguration :: Maybe Text
- sourceControlDetails :: Maybe SourceControlDetails
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe Natural
- workerType :: Maybe WorkerType
- name :: Text
- role' :: Text
- command :: JobCommand
- newCreateJob :: Text -> Text -> JobCommand -> CreateJob
- createJob_allocatedCapacity :: Lens' CreateJob (Maybe Int)
- createJob_codeGenConfigurationNodes :: Lens' CreateJob (Maybe (HashMap Text CodeGenConfigurationNode))
- createJob_connections :: Lens' CreateJob (Maybe ConnectionsList)
- createJob_defaultArguments :: Lens' CreateJob (Maybe (HashMap Text Text))
- createJob_description :: Lens' CreateJob (Maybe Text)
- createJob_executionClass :: Lens' CreateJob (Maybe ExecutionClass)
- createJob_executionProperty :: Lens' CreateJob (Maybe ExecutionProperty)
- createJob_glueVersion :: Lens' CreateJob (Maybe Text)
- createJob_logUri :: Lens' CreateJob (Maybe Text)
- createJob_maxCapacity :: Lens' CreateJob (Maybe Double)
- createJob_maxRetries :: Lens' CreateJob (Maybe Int)
- createJob_nonOverridableArguments :: Lens' CreateJob (Maybe (HashMap Text Text))
- createJob_notificationProperty :: Lens' CreateJob (Maybe NotificationProperty)
- createJob_numberOfWorkers :: Lens' CreateJob (Maybe Int)
- createJob_securityConfiguration :: Lens' CreateJob (Maybe Text)
- createJob_sourceControlDetails :: Lens' CreateJob (Maybe SourceControlDetails)
- createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text))
- createJob_timeout :: Lens' CreateJob (Maybe Natural)
- createJob_workerType :: Lens' CreateJob (Maybe WorkerType)
- createJob_name :: Lens' CreateJob Text
- createJob_role :: Lens' CreateJob Text
- createJob_command :: Lens' CreateJob JobCommand
- data CreateJobResponse = CreateJobResponse' {
- name :: Maybe Text
- httpStatus :: Int
- newCreateJobResponse :: Int -> CreateJobResponse
- createJobResponse_name :: Lens' CreateJobResponse (Maybe Text)
- createJobResponse_httpStatus :: Lens' CreateJobResponse Int
Creating a Request
See: newCreateJob
smart constructor.
CreateJob' | |
|
Instances
Create a value of CreateJob
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:
CreateJob
, createJob_allocatedCapacity
- This parameter is deprecated. Use MaxCapacity
instead.
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.
CreateJob
, createJob_codeGenConfigurationNodes
- The representation of a directed acyclic graph on which both the Glue
Studio visual component and Glue Studio code generation is based.
CreateJob
, createJob_connections
- The connections used for this job.
CreateJob
, createJob_defaultArguments
- The default arguments for this job.
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.
CreateJob
, createJob_description
- Description of the job being defined.
CreateJob
, createJob_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.
CreateJob
, createJob_executionProperty
- An ExecutionProperty
specifying the maximum number of concurrent runs
allowed for this job.
CreateJob
, createJob_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.
CreateJob
, createJob_logUri
- This field is reserved for future use.
CreateJob
, createJob_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 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") 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
.
CreateJob
, createJob_maxRetries
- The maximum number of times to retry this job if it fails.
CreateJob
, createJob_nonOverridableArguments
- Non-overridable arguments for this job, specified as name-value pairs.
CreateJob
, createJob_notificationProperty
- Specifies configuration properties of a job notification.
CreateJob
, createJob_numberOfWorkers
- The number of workers of a defined workerType
that are allocated when
a job runs.
CreateJob
, createJob_securityConfiguration
- The name of the SecurityConfiguration
structure to be used with this
job.
CreateJob
, createJob_sourceControlDetails
- The details for a source control configuration for a job, allowing
synchronization of job artifacts to or from a remote repository.
$sel:tags:CreateJob'
, createJob_tags
- The tags to use with this job. You may use tags to limit access to the
job. For more information about tags in Glue, see
Amazon Web Services Tags in Glue
in the developer guide.
CreateJob
, createJob_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).
CreateJob
, createJob_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.
CreateJob
, createJob_name
- The name you assign to this job definition. It must be unique in your
account.
CreateJob
, createJob_role
- The name or Amazon Resource Name (ARN) of the IAM role associated with
this job.
CreateJob
, createJob_command
- The JobCommand
that runs this job.
Request Lenses
createJob_allocatedCapacity :: Lens' CreateJob (Maybe Int) Source #
This parameter is deprecated. Use MaxCapacity
instead.
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.
createJob_codeGenConfigurationNodes :: Lens' CreateJob (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.
createJob_connections :: Lens' CreateJob (Maybe ConnectionsList) Source #
The connections used for this job.
createJob_defaultArguments :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #
The default arguments for this job.
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.
createJob_executionClass :: Lens' CreateJob (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.
createJob_executionProperty :: Lens' CreateJob (Maybe ExecutionProperty) Source #
An ExecutionProperty
specifying the maximum number of concurrent runs
allowed for this job.
createJob_glueVersion :: Lens' CreateJob (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.
createJob_maxCapacity :: Lens' CreateJob (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 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") 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
.
createJob_maxRetries :: Lens' CreateJob (Maybe Int) Source #
The maximum number of times to retry this job if it fails.
createJob_nonOverridableArguments :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #
Non-overridable arguments for this job, specified as name-value pairs.
createJob_notificationProperty :: Lens' CreateJob (Maybe NotificationProperty) Source #
Specifies configuration properties of a job notification.
createJob_numberOfWorkers :: Lens' CreateJob (Maybe Int) Source #
The number of workers of a defined workerType
that are allocated when
a job runs.
createJob_securityConfiguration :: Lens' CreateJob (Maybe Text) Source #
The name of the SecurityConfiguration
structure to be used with this
job.
createJob_sourceControlDetails :: Lens' CreateJob (Maybe SourceControlDetails) Source #
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #
The tags to use with this job. You may use tags to limit access to the job. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
createJob_timeout :: Lens' CreateJob (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).
createJob_workerType :: Lens' CreateJob (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.
createJob_name :: Lens' CreateJob Text Source #
The name you assign to this job definition. It must be unique in your account.
createJob_role :: Lens' CreateJob Text Source #
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
createJob_command :: Lens' CreateJob JobCommand Source #
The JobCommand
that runs this job.
Destructuring the Response
data CreateJobResponse Source #
See: newCreateJobResponse
smart constructor.
CreateJobResponse' | |
|
Instances
Create a value of CreateJobResponse
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:
CreateJob
, createJobResponse_name
- The unique name that was provided for this job definition.
$sel:httpStatus:CreateJobResponse'
, createJobResponse_httpStatus
- The response's http status code.
Response Lenses
createJobResponse_name :: Lens' CreateJobResponse (Maybe Text) Source #
The unique name that was provided for this job definition.
createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #
The response's http status code.