amazonka-glue-2.0: Amazon Glue SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glue.Types.Job

Description

 
Synopsis

Documentation

data Job Source #

Specifies a job definition.

See: newJob smart constructor.

Constructors

Job' 

Fields

  • allocatedCapacity :: Maybe Int

    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.

  • codeGenConfigurationNodes :: Maybe (Sensitive (HashMap Text CodeGenConfigurationNode))

    The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.

  • command :: Maybe JobCommand

    The JobCommand that runs this job.

  • connections :: Maybe ConnectionsList

    The connections used for this job.

  • createdOn :: Maybe POSIX

    The time and date that this job definition was created.

  • defaultArguments :: Maybe (HashMap Text Text)

    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.

  • description :: Maybe Text

    A description of the job.

  • executionClass :: Maybe 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.

  • executionProperty :: Maybe ExecutionProperty

    An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

  • glueVersion :: Maybe Text

    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.

  • lastModifiedOn :: Maybe POSIX

    The last point in time when this job definition was modified.

  • logUri :: Maybe Text

    This field is reserved for future use.

  • maxCapacity :: Maybe Double

    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.

  • maxRetries :: Maybe Int

    The maximum number of times to retry this job after a JobRun fails.

  • name :: Maybe Text

    The name you assign to this job definition.

  • nonOverridableArguments :: Maybe (HashMap Text Text)

    Non-overridable arguments for this job, specified as name-value pairs.

  • notificationProperty :: Maybe NotificationProperty

    Specifies configuration properties of a job notification.

  • numberOfWorkers :: Maybe Int

    The number of workers of a defined workerType that are allocated when a job runs.

  • role' :: Maybe Text

    The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

  • securityConfiguration :: Maybe Text

    The name of the SecurityConfiguration structure to be used with this job.

  • sourceControlDetails :: Maybe SourceControlDetails

    The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.

  • timeout :: Maybe Natural

    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).

  • workerType :: Maybe 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.

Instances

Instances details
FromJSON Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Generic Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Associated Types

type Rep Job :: Type -> Type #

Methods

from :: Job -> Rep Job x #

to :: Rep Job x -> Job #

Show Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Methods

showsPrec :: Int -> Job -> ShowS #

show :: Job -> String #

showList :: [Job] -> ShowS #

NFData Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Methods

rnf :: Job -> () #

Eq Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Methods

(==) :: Job -> Job -> Bool #

(/=) :: Job -> Job -> Bool #

Hashable Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

Methods

hashWithSalt :: Int -> Job -> Int #

hash :: Job -> Int #

type Rep Job Source # 
Instance details

Defined in Amazonka.Glue.Types.Job

type Rep Job = D1 ('MetaData "Job" "Amazonka.Glue.Types.Job" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "allocatedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "codeGenConfigurationNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text CodeGenConfigurationNode))))) :*: (S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobCommand)) :*: (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionsList)) :*: S1 ('MetaSel ('Just "createdOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "defaultArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionClass)))) :*: (S1 ('MetaSel ('Just "executionProperty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionProperty)) :*: (S1 ('MetaSel ('Just "glueVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "logUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "maxRetries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nonOverridableArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "notificationProperty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationProperty))))) :*: ((S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "role'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sourceControlDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceControlDetails)) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType))))))))

newJob :: Job Source #

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_description :: Lens' Job (Maybe Text) Source #

A description of the job.

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_logUri :: Lens' Job (Maybe Text) Source #

This field is reserved for future use.

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_name :: Lens' Job (Maybe Text) Source #

The name you assign to this job definition.

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.