Network.AWS.Batch.RegisterJobDefinition

Registers an AWS Batch job definition.

Creating a Request

registerJobDefinition

Arguments

:: Text

rjdJobDefinitionName

-> JobDefinitionType

rjdType

-> RegisterJobDefinition

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

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

• rjdRetryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.
• rjdParameters - Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
• rjdTimeout - The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide .
• rjdContainerProperties - An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container .
• rjdJobDefinitionName - The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
• rjdType - The type of job definition.

data RegisterJobDefinition

See: registerJobDefinition smart constructor.

Instances

Eq RegisterJobDefinition

Methods

(==) :: RegisterJobDefinition -> RegisterJobDefinition -> Bool

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

Data RegisterJobDefinition

Methods

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

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

toConstr :: RegisterJobDefinition -> Constr

dataTypeOf :: RegisterJobDefinition -> DataType

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

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

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

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

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

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

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

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

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

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

Read RegisterJobDefinition

Methods

readsPrec :: Int -> ReadS RegisterJobDefinition

readList :: ReadS [RegisterJobDefinition]

readPrec :: ReadPrec RegisterJobDefinition

readListPrec :: ReadPrec [RegisterJobDefinition]

Show RegisterJobDefinition

Methods

showsPrec :: Int -> RegisterJobDefinition -> ShowS

show :: RegisterJobDefinition -> String

showList :: [RegisterJobDefinition] -> ShowS

Generic RegisterJobDefinition

Associated Types

type Rep RegisterJobDefinition :: * -> *

Methods

from :: RegisterJobDefinition -> Rep RegisterJobDefinition x

to :: Rep RegisterJobDefinition x -> RegisterJobDefinition

Hashable RegisterJobDefinition

Methods

hashWithSalt :: Int -> RegisterJobDefinition -> Int

hash :: RegisterJobDefinition -> Int

ToJSON RegisterJobDefinition

Methods

toJSON :: RegisterJobDefinition -> Value

toEncoding :: RegisterJobDefinition -> Encoding

toJSONList :: [RegisterJobDefinition] -> Value

toEncodingList :: [RegisterJobDefinition] -> Encoding

NFData RegisterJobDefinition

Methods

rnf :: RegisterJobDefinition -> ()

AWSRequest RegisterJobDefinition

Associated Types

type Rs RegisterJobDefinition :: *

Methods

request :: RegisterJobDefinition -> Request RegisterJobDefinition

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

ToHeaders RegisterJobDefinition

Methods

toHeaders :: RegisterJobDefinition -> [Header]

ToPath RegisterJobDefinition

Methods

toPath :: RegisterJobDefinition -> ByteString

ToQuery RegisterJobDefinition

Methods

toQuery :: RegisterJobDefinition -> QueryString

type Rep RegisterJobDefinition

type Rep RegisterJobDefinition = D1 * (MetaData "RegisterJobDefinition" "Network.AWS.Batch.RegisterJobDefinition" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "RegisterJobDefinition'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdRetryStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RetryStrategy))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_rjdTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobTimeout))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdContainerProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ContainerProperties))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdJobDefinitionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rjdType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * JobDefinitionType))))))

type Rs RegisterJobDefinition

type Rs RegisterJobDefinition = RegisterJobDefinitionResponse

Request Lenses

rjdRetryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

rjdParameters :: Lens' RegisterJobDefinition (HashMap Text Text)

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

rjdTimeout :: Lens' RegisterJobDefinition (Maybe JobTimeout)

The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide .

rjdContainerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container .

rjdJobDefinitionName :: Lens' RegisterJobDefinition Text

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

rjdType :: Lens' RegisterJobDefinition JobDefinitionType

The type of job definition.

Destructuring the Response

registerJobDefinitionResponse

Arguments

:: Int

rjdrsResponseStatus

-> Text

rjdrsJobDefinitionName

-> Text

rjdrsJobDefinitionARN

-> Int

rjdrsRevision

-> RegisterJobDefinitionResponse

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

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

• rjdrsResponseStatus - -- | The response status code.
• rjdrsJobDefinitionName - The name of the job definition.
• rjdrsJobDefinitionARN - The Amazon Resource Name (ARN) of the job definition.
• rjdrsRevision - The revision of the job definition.

data RegisterJobDefinitionResponse

See: registerJobDefinitionResponse smart constructor.

Instances

Eq RegisterJobDefinitionResponse

Methods

(==) :: RegisterJobDefinitionResponse -> RegisterJobDefinitionResponse -> Bool

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

Data RegisterJobDefinitionResponse

Methods

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

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

toConstr :: RegisterJobDefinitionResponse -> Constr

dataTypeOf :: RegisterJobDefinitionResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read RegisterJobDefinitionResponse

Methods

readsPrec :: Int -> ReadS RegisterJobDefinitionResponse

readList :: ReadS [RegisterJobDefinitionResponse]

readPrec :: ReadPrec RegisterJobDefinitionResponse

readListPrec :: ReadPrec [RegisterJobDefinitionResponse]

Show RegisterJobDefinitionResponse

Methods

showsPrec :: Int -> RegisterJobDefinitionResponse -> ShowS

show :: RegisterJobDefinitionResponse -> String

showList :: [RegisterJobDefinitionResponse] -> ShowS

Generic RegisterJobDefinitionResponse

Associated Types

type Rep RegisterJobDefinitionResponse :: * -> *

Methods

from :: RegisterJobDefinitionResponse -> Rep RegisterJobDefinitionResponse x

to :: Rep RegisterJobDefinitionResponse x -> RegisterJobDefinitionResponse

NFData RegisterJobDefinitionResponse

Methods

rnf :: RegisterJobDefinitionResponse -> ()

type Rep RegisterJobDefinitionResponse

type Rep RegisterJobDefinitionResponse = D1 * (MetaData "RegisterJobDefinitionResponse" "Network.AWS.Batch.RegisterJobDefinition" "amazonka-batch-1.6.0-Fzr0qfVbg64JgYF5rBSQhW" False) (C1 * (MetaCons "RegisterJobDefinitionResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_rjdrsJobDefinitionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rjdrsJobDefinitionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rjdrsRevision") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

rjdrsResponseStatus :: Lens' RegisterJobDefinitionResponse Int

• - | The response status code.

rjdrsJobDefinitionName :: Lens' RegisterJobDefinitionResponse Text

The name of the job definition.

rjdrsJobDefinitionARN :: Lens' RegisterJobDefinitionResponse Text

The Amazon Resource Name (ARN) of the job definition.

rjdrsRevision :: Lens' RegisterJobDefinitionResponse Int

The revision of the job definition.