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 |
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob
override parameters defined in the job definition.
- submitJob :: Text -> Text -> Text -> SubmitJob
- data SubmitJob
- sjContainerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides)
- sjRetryStrategy :: Lens' SubmitJob (Maybe RetryStrategy)
- sjDependsOn :: Lens' SubmitJob [JobDependency]
- sjParameters :: Lens' SubmitJob (HashMap Text Text)
- sjArrayProperties :: Lens' SubmitJob (Maybe ArrayProperties)
- sjTimeout :: Lens' SubmitJob (Maybe JobTimeout)
- sjJobName :: Lens' SubmitJob Text
- sjJobQueue :: Lens' SubmitJob Text
- sjJobDefinition :: Lens' SubmitJob Text
- submitJobResponse :: Int -> Text -> Text -> SubmitJobResponse
- data SubmitJobResponse
- sjrsResponseStatus :: Lens' SubmitJobResponse Int
- sjrsJobName :: Lens' SubmitJobResponse Text
- sjrsJobId :: Lens' SubmitJobResponse Text
Creating a Request
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 acommand
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 anenvironment
override.sjRetryStrategy
- The retry strategy to use for failed jobs from thisSubmitJob
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 aSEQUENTIAL
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 anN_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 aSubmitJob
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 thisSubmitJob
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 aname:revision
or the Amazon Resource Name (ARN) for the job definition.
See: submitJob
smart constructor.
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
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 Source #
See: submitJobResponse
smart constructor.
Response Lenses
sjrsResponseStatus :: Lens' SubmitJobResponse Int Source #
- - | The response status code.
sjrsJobName :: Lens' SubmitJobResponse Text Source #
The name of the job.