amazonka-batch-1.6.1: Amazon Batch SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Batch.SubmitJob

Contents

Description

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

Synopsis

Creating a Request

submitJob Source #

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 Source #

See: submitJob smart constructor.

Instances
Eq SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Data SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.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 Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Show SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Generic SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Associated Types

type Rep SubmitJob :: Type -> Type #

Hashable SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

ToJSON SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

AWSRequest SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Associated Types

type Rs SubmitJob :: Type #

ToHeaders SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Methods

toHeaders :: SubmitJob -> [Header] #

ToPath SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

ToQuery SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

NFData SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Methods

rnf :: SubmitJob -> () #

type Rep SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

type Rs SubmitJob Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Request Lenses

sjContainerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides) Source #

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) Source #

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] Source #

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) Source #

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) Source #

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) Source #

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 Source #

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 Source #

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 Source #

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 Source #

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:

data SubmitJobResponse Source #

See: submitJobResponse smart constructor.

Instances
Eq SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Data SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

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 Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Show SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Generic SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Associated Types

type Rep SubmitJobResponse :: Type -> Type #

NFData SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

Methods

rnf :: SubmitJobResponse -> () #

type Rep SubmitJobResponse Source # 
Instance details

Defined in Network.AWS.Batch.SubmitJob

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

Response Lenses

sjrsResponseStatus :: Lens' SubmitJobResponse Int Source #

  • - | The response status code.

sjrsJobId :: Lens' SubmitJobResponse Text Source #

The unique identifier for the job.