Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Registers an AWS Batch job definition.
- registerJobDefinition :: Text -> JobDefinitionType -> RegisterJobDefinition
- data RegisterJobDefinition
- rjdRetryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)
- rjdParameters :: Lens' RegisterJobDefinition (HashMap Text Text)
- rjdTimeout :: Lens' RegisterJobDefinition (Maybe JobTimeout)
- rjdContainerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)
- rjdJobDefinitionName :: Lens' RegisterJobDefinition Text
- rjdType :: Lens' RegisterJobDefinition JobDefinitionType
- registerJobDefinitionResponse :: Int -> Text -> Text -> Int -> RegisterJobDefinitionResponse
- data RegisterJobDefinitionResponse
- rjdrsResponseStatus :: Lens' RegisterJobDefinitionResponse Int
- rjdrsJobDefinitionName :: Lens' RegisterJobDefinitionResponse Text
- rjdrsJobDefinitionARN :: Lens' RegisterJobDefinitionResponse Text
- rjdrsRevision :: Lens' RegisterJobDefinitionResponse Int
Creating a Request
registerJobDefinition Source #
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 aSubmitJob
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 aSubmitJob
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 aSubmitJob
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 thetype
parameter iscontainer
.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 Source #
See: registerJobDefinition
smart constructor.
Request Lenses
rjdRetryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy) Source #
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) 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.
rjdTimeout :: Lens' RegisterJobDefinition (Maybe JobTimeout) Source #
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) Source #
An object with various properties specific for container-based jobs. This parameter is required if the type
parameter is container
.
rjdJobDefinitionName :: 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.
rjdType :: Lens' RegisterJobDefinition JobDefinitionType Source #
The type of job definition.
Destructuring the Response
registerJobDefinitionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Int | |
-> 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 Source #
See: registerJobDefinitionResponse
smart constructor.
Response Lenses
rjdrsResponseStatus :: Lens' RegisterJobDefinitionResponse Int Source #
- - | The response status code.
rjdrsJobDefinitionName :: Lens' RegisterJobDefinitionResponse Text Source #
The name of the job definition.
rjdrsJobDefinitionARN :: Lens' RegisterJobDefinitionResponse Text Source #
The Amazon Resource Name (ARN) of the job definition.
rjdrsRevision :: Lens' RegisterJobDefinitionResponse Int Source #
The revision of the job definition.