Network.AWS.Batch.SubmitJob

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

Creating a Request

submitJob

Arguments

:: Text

sjJobName

-> Text

sjJobQueue

-> Text

sjJobDefinition

-> SubmitJob

Creates a value of SubmitJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sjContainerOverrides - A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
• sjRetryStrategy - The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
• sjDependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
• sjParameters - Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
• sjArrayProperties - The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide .
• sjTimeout - The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide .
• sjJobName - The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
• sjJobQueue - The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
• sjJobDefinition - The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

data SubmitJob

See: submitJob smart constructor.

Instances

Eq SubmitJob

Methods

(==) :: SubmitJob -> SubmitJob -> Bool

(/=) :: SubmitJob -> SubmitJob -> Bool

Data SubmitJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubmitJob -> c SubmitJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubmitJob

toConstr :: SubmitJob -> Constr

dataTypeOf :: SubmitJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SubmitJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubmitJob)

gmapT :: (forall b. Data b => b -> b) -> SubmitJob -> SubmitJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubmitJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubmitJob -> r

gmapQ :: (forall d. Data d => d -> u) -> SubmitJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubmitJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubmitJob -> m SubmitJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubmitJob -> m SubmitJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubmitJob -> m SubmitJob

Read SubmitJob

Methods

readsPrec :: Int -> ReadS SubmitJob

readList :: ReadS [SubmitJob]

readPrec :: ReadPrec SubmitJob

readListPrec :: ReadPrec [SubmitJob]

Show SubmitJob

Methods

showsPrec :: Int -> SubmitJob -> ShowS

show :: SubmitJob -> String

showList :: [SubmitJob] -> ShowS

Generic SubmitJob

Associated Types

type Rep SubmitJob :: * -> *

Methods

from :: SubmitJob -> Rep SubmitJob x

to :: Rep SubmitJob x -> SubmitJob

Hashable SubmitJob

Methods

hashWithSalt :: Int -> SubmitJob -> Int

hash :: SubmitJob -> Int

ToJSON SubmitJob

Methods

toJSON :: SubmitJob -> Value

toEncoding :: SubmitJob -> Encoding

toJSONList :: [SubmitJob] -> Value

toEncodingList :: [SubmitJob] -> Encoding

NFData SubmitJob

Methods

rnf :: SubmitJob -> ()

AWSRequest SubmitJob

Associated Types

type Rs SubmitJob :: *

Methods

request :: SubmitJob -> Request SubmitJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SubmitJob -> ClientResponse -> m (Response SubmitJob)

ToHeaders SubmitJob

Methods

toHeaders :: SubmitJob -> [Header]

ToPath SubmitJob

Methods

toPath :: SubmitJob -> ByteString

ToQuery SubmitJob

Methods

toQuery :: SubmitJob -> QueryString

type Rep SubmitJob

type Rep SubmitJob = D1 * (MetaData "SubmitJob" "Network.AWS.Batch.SubmitJob" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "SubmitJob'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sjContainerOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ContainerOverrides))) (S1 * (MetaSel (Just Symbol "_sjRetryStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RetryStrategy)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sjDependsOn") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [JobDependency]))) (S1 * (MetaSel (Just Symbol "_sjParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sjArrayProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ArrayProperties))) (S1 * (MetaSel (Just Symbol "_sjTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobTimeout)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sjJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_sjJobQueue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sjJobDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))

type Rs SubmitJob

type Rs SubmitJob = SubmitJobResponse

Request Lenses

sjContainerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides)

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

sjRetryStrategy :: Lens' SubmitJob (Maybe RetryStrategy)

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

sjDependsOn :: Lens' SubmitJob [JobDependency]

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

sjParameters :: Lens' SubmitJob (HashMap Text Text)

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

sjArrayProperties :: Lens' SubmitJob (Maybe ArrayProperties)

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide .

sjTimeout :: Lens' SubmitJob (Maybe JobTimeout)

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide .

sjJobName :: Lens' SubmitJob Text

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

sjJobQueue :: Lens' SubmitJob Text

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

sjJobDefinition :: Lens' SubmitJob Text

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

Destructuring the Response

submitJobResponse

Arguments

:: Int

sjrsResponseStatus

-> Text

sjrsJobName

-> Text

sjrsJobId

-> SubmitJobResponse

Creates a value of SubmitJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sjrsResponseStatus - -- | The response status code.
• sjrsJobName - The name of the job.
• sjrsJobId - The unique identifier for the job.

data SubmitJobResponse

See: submitJobResponse smart constructor.

Instances

Eq SubmitJobResponse

Methods

(==) :: SubmitJobResponse -> SubmitJobResponse -> Bool

(/=) :: SubmitJobResponse -> SubmitJobResponse -> Bool

Data SubmitJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubmitJobResponse -> c SubmitJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubmitJobResponse

toConstr :: SubmitJobResponse -> Constr

dataTypeOf :: SubmitJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SubmitJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubmitJobResponse)

gmapT :: (forall b. Data b => b -> b) -> SubmitJobResponse -> SubmitJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubmitJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubmitJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SubmitJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubmitJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubmitJobResponse -> m SubmitJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubmitJobResponse -> m SubmitJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubmitJobResponse -> m SubmitJobResponse

Read SubmitJobResponse

Methods

readsPrec :: Int -> ReadS SubmitJobResponse

readList :: ReadS [SubmitJobResponse]

readPrec :: ReadPrec SubmitJobResponse

readListPrec :: ReadPrec [SubmitJobResponse]

Show SubmitJobResponse

Methods

showsPrec :: Int -> SubmitJobResponse -> ShowS

show :: SubmitJobResponse -> String

showList :: [SubmitJobResponse] -> ShowS

Generic SubmitJobResponse

Associated Types

type Rep SubmitJobResponse :: * -> *

Methods

from :: SubmitJobResponse -> Rep SubmitJobResponse x

to :: Rep SubmitJobResponse x -> SubmitJobResponse

NFData SubmitJobResponse

Methods

rnf :: SubmitJobResponse -> ()

type Rep SubmitJobResponse

type Rep SubmitJobResponse = D1 * (MetaData "SubmitJobResponse" "Network.AWS.Batch.SubmitJob" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "SubmitJobResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "_sjrsJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

Response Lenses

sjrsResponseStatus :: Lens' SubmitJobResponse Int

• - | The response status code.

sjrsJobName :: Lens' SubmitJobResponse Text

The name of the job.

sjrsJobId :: Lens' SubmitJobResponse Text

The unique identifier for the job.