Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glue.StartJobRun

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a job run using a job definition.

Synopsis

data StartJobRun = StartJobRun' {
- numberOfWorkers :: Maybe Int
- notificationProperty :: Maybe NotificationProperty
- arguments :: Maybe (HashMap Text Text)
- workerType :: Maybe WorkerType
- securityConfiguration :: Maybe Text
- allocatedCapacity :: Maybe Int
- maxCapacity :: Maybe Double
- timeout :: Maybe Natural
- jobRunId :: Maybe Text
- jobName :: Text
}
newStartJobRun :: Text -> StartJobRun
startJobRun_numberOfWorkers :: Lens' StartJobRun (Maybe Int)
startJobRun_notificationProperty :: Lens' StartJobRun (Maybe NotificationProperty)
startJobRun_arguments :: Lens' StartJobRun (Maybe (HashMap Text Text))
startJobRun_workerType :: Lens' StartJobRun (Maybe WorkerType)
startJobRun_securityConfiguration :: Lens' StartJobRun (Maybe Text)
startJobRun_allocatedCapacity :: Lens' StartJobRun (Maybe Int)
startJobRun_maxCapacity :: Lens' StartJobRun (Maybe Double)
startJobRun_timeout :: Lens' StartJobRun (Maybe Natural)
startJobRun_jobRunId :: Lens' StartJobRun (Maybe Text)
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.

Constructors

StartJobRun'

Fields

numberOfWorkers :: Maybe Int
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
notificationProperty :: Maybe NotificationProperty
Specifies configuration properties of a job run notification.
arguments :: Maybe (HashMap Text Text)
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.
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.
workerType :: Maybe WorkerType
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
- 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.
securityConfiguration :: Maybe Text
The name of the SecurityConfiguration structure to be used with this job run.
allocatedCapacity :: Maybe Int
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate 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.
maxCapacity :: Maybe Double
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 from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
timeout :: Maybe Natural
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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.
jobRunId :: Maybe Text
The ID of a previous JobRun to retry.
jobName :: Text
The name of the job definition to use.

Instances

Instances details

Eq StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods (==) :: StartJobRun -> StartJobRun -> Bool # (/=) :: StartJobRun -> StartJobRun -> Bool #
Read StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods readsPrec :: Int -> ReadS StartJobRun # readList :: ReadS [StartJobRun] # readPrec :: ReadPrec StartJobRun # readListPrec :: ReadPrec [StartJobRun] #
Show StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods showsPrec :: Int -> StartJobRun -> ShowS # show :: StartJobRun -> String # showList :: [StartJobRun] -> ShowS #
Generic StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Associated Types type Rep StartJobRun :: Type -> Type # Methods from :: StartJobRun -> Rep StartJobRun x # to :: Rep StartJobRun x -> StartJobRun #
NFData StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods rnf :: StartJobRun -> () #
Hashable StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods hashWithSalt :: Int -> StartJobRun -> Int # hash :: StartJobRun -> Int #
ToJSON StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods toJSON :: StartJobRun -> Value # toEncoding :: StartJobRun -> Encoding # toJSONList :: [StartJobRun] -> Value # toEncodingList :: [StartJobRun] -> Encoding #
AWSRequest StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Associated Types type AWSResponse StartJobRun # Methods request :: StartJobRun -> Request StartJobRun # response :: MonadResource m => Logger -> Service -> Proxy StartJobRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartJobRun))) #
ToHeaders StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods toHeaders :: StartJobRun -> [Header] #
ToPath StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods toPath :: StartJobRun -> ByteString #
ToQuery StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods toQuery :: StartJobRun -> QueryString #
type Rep StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun type Rep StartJobRun = D1 ('MetaData "StartJobRun" "Amazonka.Glue.StartJobRun" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "StartJobRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numberOfWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "notificationProperty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationProperty))) :: (S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "workerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerType)) :: S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "allocatedCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "maxCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "jobRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartJobRun Source #
Instance details Defined in Amazonka.Glue.StartJobRun type AWSResponse StartJobRun = StartJobRunResponse

newStartJobRun Source #

Arguments

:: Text	`$sel:jobName:StartJobRun'`
-> StartJobRun

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:

$sel:numberOfWorkers:StartJobRun', startJobRun_numberOfWorkers - The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

$sel:notificationProperty:StartJobRun', startJobRun_notificationProperty - Specifies configuration properties of a job run notification.

$sel:arguments: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.

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:workerType:StartJobRun', startJobRun_workerType - The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

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.

$sel:securityConfiguration:StartJobRun', startJobRun_securityConfiguration - The name of the SecurityConfiguration structure to be used with this job run.

$sel:allocatedCapacity:StartJobRun', startJobRun_allocatedCapacity - This field is deprecated. Use MaxCapacity instead.

The number of Glue data processing units (DPUs) to allocate 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:maxCapacity: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 from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

$sel:timeout: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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

$sel:jobRunId:StartJobRun', startJobRun_jobRunId - The ID of a previous JobRun to retry.

$sel:jobName:StartJobRun', startJobRun_jobName - The name of the job definition to use.

Request Lenses

startJobRun_numberOfWorkers :: Lens' StartJobRun (Maybe Int) Source #

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

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

startJobRun_notificationProperty :: Lens' StartJobRun (Maybe NotificationProperty) Source #

Specifies configuration properties of a job run notification.

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.

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_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, or G.2X.

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.

startJobRun_securityConfiguration :: Lens' StartJobRun (Maybe Text) Source #

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

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

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 from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

startJobRun_jobRunId :: Lens' StartJobRun (Maybe Text) Source #

The ID of a previous JobRun to retry.

startJobRun_jobName :: Lens' StartJobRun Text Source #

The name of the job definition to use.

Destructuring the Response

data StartJobRunResponse Source #

See: newStartJobRunResponse smart constructor.

Constructors

StartJobRunResponse'
Fields jobRunId :: Maybe Text The ID assigned to this job run. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods (==) :: StartJobRunResponse -> StartJobRunResponse -> Bool # (/=) :: StartJobRunResponse -> StartJobRunResponse -> Bool #
Read StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods readsPrec :: Int -> ReadS StartJobRunResponse # readList :: ReadS [StartJobRunResponse] # readPrec :: ReadPrec StartJobRunResponse # readListPrec :: ReadPrec [StartJobRunResponse] #
Show StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods showsPrec :: Int -> StartJobRunResponse -> ShowS # show :: StartJobRunResponse -> String # showList :: [StartJobRunResponse] -> ShowS #
Generic StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun Associated Types type Rep StartJobRunResponse :: Type -> Type # Methods from :: StartJobRunResponse -> Rep StartJobRunResponse x # to :: Rep StartJobRunResponse x -> StartJobRunResponse #
NFData StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun Methods rnf :: StartJobRunResponse -> () #
type Rep StartJobRunResponse Source #
Instance details Defined in Amazonka.Glue.StartJobRun type Rep StartJobRunResponse = D1 ('MetaData "StartJobRunResponse" "Amazonka.Glue.StartJobRun" "libZSservicesZSamazonka-glueZSamazonka-glue" 'False) (C1 ('MetaCons "StartJobRunResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartJobRunResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartJobRunResponse'`
-> StartJobRunResponse

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:

$sel:jobRunId: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.