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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers an Batch job definition.

Synopsis

data RegisterJobDefinition = RegisterJobDefinition' {
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- platformCapabilities :: Maybe [PlatformCapability]
- parameters :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- containerProperties :: Maybe ContainerProperties
- nodeProperties :: Maybe NodeProperties
- tags :: Maybe (HashMap Text Text)
- jobDefinitionName :: Text
- type' :: JobDefinitionType
}
newRegisterJobDefinition :: Text -> JobDefinitionType -> RegisterJobDefinition
registerJobDefinition_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool)
registerJobDefinition_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)
registerJobDefinition_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability])
registerJobDefinition_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
registerJobDefinition_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout)
registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)
registerJobDefinition_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties)
registerJobDefinition_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
registerJobDefinition_jobDefinitionName :: Lens' RegisterJobDefinition Text
registerJobDefinition_type :: Lens' RegisterJobDefinition JobDefinitionType
data RegisterJobDefinitionResponse = RegisterJobDefinitionResponse' {
- httpStatus :: Int
- jobDefinitionName :: Text
- jobDefinitionArn :: Text
- revision :: Int
}
newRegisterJobDefinitionResponse :: Int -> Text -> Text -> Int -> RegisterJobDefinitionResponse
registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int
registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text
registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text
registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int

Creating a Request

data RegisterJobDefinition Source #

Contains the parameters for RegisterJobDefinition.

See: newRegisterJobDefinition smart constructor.

Constructors

RegisterJobDefinition'

Fields

propagateTags :: Maybe Bool
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
retryStrategy :: Maybe RetryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
platformCapabilities :: Maybe [PlatformCapability]
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.
parameters :: Maybe (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.
timeout :: Maybe JobTimeout
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
containerProperties :: Maybe ContainerProperties
An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.
nodeProperties :: Maybe NodeProperties
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
tags :: Maybe (HashMap Text Text)
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
jobDefinitionName :: Text
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
type' :: JobDefinitionType
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode isn't supported.

Instances

Instances details

Eq RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods (==) :: RegisterJobDefinition -> RegisterJobDefinition -> Bool # (/=) :: RegisterJobDefinition -> RegisterJobDefinition -> Bool #
Read RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods readsPrec :: Int -> ReadS RegisterJobDefinition # readList :: ReadS [RegisterJobDefinition] # readPrec :: ReadPrec RegisterJobDefinition # readListPrec :: ReadPrec [RegisterJobDefinition] #
Show RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods showsPrec :: Int -> RegisterJobDefinition -> ShowS # show :: RegisterJobDefinition -> String # showList :: [RegisterJobDefinition] -> ShowS #
Generic RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Associated Types type Rep RegisterJobDefinition :: Type -> Type # Methods from :: RegisterJobDefinition -> Rep RegisterJobDefinition x # to :: Rep RegisterJobDefinition x -> RegisterJobDefinition #
NFData RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods rnf :: RegisterJobDefinition -> () #
Hashable RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods hashWithSalt :: Int -> RegisterJobDefinition -> Int # hash :: RegisterJobDefinition -> Int #
ToJSON RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods toJSON :: RegisterJobDefinition -> Value # toEncoding :: RegisterJobDefinition -> Encoding # toJSONList :: [RegisterJobDefinition] -> Value # toEncodingList :: [RegisterJobDefinition] -> Encoding #
AWSRequest RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Associated Types type AWSResponse RegisterJobDefinition # Methods request :: RegisterJobDefinition -> Request RegisterJobDefinition # response :: MonadResource m => Logger -> Service -> Proxy RegisterJobDefinition -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterJobDefinition))) #
ToHeaders RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods toHeaders :: RegisterJobDefinition -> [Header] #
ToPath RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods toPath :: RegisterJobDefinition -> ByteString #
ToQuery RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition Methods toQuery :: RegisterJobDefinition -> QueryString #
type Rep RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition type Rep RegisterJobDefinition = D1 ('MetaData "RegisterJobDefinition" "Amazonka.Batch.RegisterJobDefinition" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "RegisterJobDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy))) :: (S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability])) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout))))) :: ((S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties)) :: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobDefinitionType))))))
type AWSResponse RegisterJobDefinition Source #
Instance details Defined in Amazonka.Batch.RegisterJobDefinition type AWSResponse RegisterJobDefinition = RegisterJobDefinitionResponse

newRegisterJobDefinition Source #

Arguments

:: Text	`$sel:jobDefinitionName:RegisterJobDefinition'`
-> JobDefinitionType	`$sel:type':RegisterJobDefinition'`
-> RegisterJobDefinition

Create a value of RegisterJobDefinition 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:propagateTags:RegisterJobDefinition', registerJobDefinition_propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

$sel:retryStrategy:RegisterJobDefinition', registerJobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

$sel:platformCapabilities:RegisterJobDefinition', registerJobDefinition_platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

$sel:parameters:RegisterJobDefinition', registerJobDefinition_parameters - 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.

$sel:timeout:RegisterJobDefinition', registerJobDefinition_timeout - The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

$sel:containerProperties:RegisterJobDefinition', registerJobDefinition_containerProperties - An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

$sel:nodeProperties:RegisterJobDefinition', registerJobDefinition_nodeProperties - An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

$sel:tags:RegisterJobDefinition', registerJobDefinition_tags - The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

$sel:jobDefinitionName:RegisterJobDefinition', registerJobDefinition_jobDefinitionName - The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

$sel:type':RegisterJobDefinition', registerJobDefinition_type - The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Request Lenses

registerJobDefinition_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool) Source #

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

registerJobDefinition_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy) Source #

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

registerJobDefinition_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability]) Source #

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

registerJobDefinition_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #

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.

registerJobDefinition_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout) Source #

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties) Source #

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

registerJobDefinition_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties) Source #

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

registerJobDefinition_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

registerJobDefinition_jobDefinitionName :: Lens' RegisterJobDefinition Text Source #

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

registerJobDefinition_type :: Lens' RegisterJobDefinition JobDefinitionType Source #

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

If the job is run on Fargate resources, then multinode isn't supported.

Destructuring the Response

data RegisterJobDefinitionResponse Source #

See: newRegisterJobDefinitionResponse smart constructor.

Constructors

RegisterJobDefinitionResponse'
Fields httpStatus :: Int The response's http status code. jobDefinitionName :: Text The name of the job definition. jobDefinitionArn :: Text The Amazon Resource Name (ARN) of the job definition. revision :: Int The revision of the job definition.

Instances

Instances details

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

newRegisterJobDefinitionResponse Source #

Arguments

:: Int	`$sel:httpStatus:RegisterJobDefinitionResponse'`
-> Text	`$sel:jobDefinitionName:RegisterJobDefinition'`
-> Text	`$sel:jobDefinitionArn:RegisterJobDefinitionResponse'`
-> Int	`$sel:revision:RegisterJobDefinitionResponse'`
-> RegisterJobDefinitionResponse

Create a value of RegisterJobDefinitionResponse 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:httpStatus:RegisterJobDefinitionResponse', registerJobDefinitionResponse_httpStatus - The response's http status code.

$sel:jobDefinitionName:RegisterJobDefinition', registerJobDefinitionResponse_jobDefinitionName - The name of the job definition.

$sel:jobDefinitionArn:RegisterJobDefinitionResponse', registerJobDefinitionResponse_jobDefinitionArn - The Amazon Resource Name (ARN) of the job definition.

$sel:revision:RegisterJobDefinitionResponse', registerJobDefinitionResponse_revision - The revision of the job definition.

Response Lenses

registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int Source #

The response's http status code.

registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text Source #

The name of the job definition.

registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text Source #

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

registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int Source #

The revision of the job definition.