Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Submits an Batch job from a job definition. Parameters that are
specified during SubmitJob override parameters defined in the job
definition. vCPU and memory requirements that are specified in the
resourceRequirements
objects in the job definition are the exception.
They can't be overridden this way using the memory
and vcpus
parameters. Rather, you must specify updates to job definition
parameters in a resourceRequirements
object that's included in the
containerOverrides
parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.
Synopsis
- data SubmitJob = SubmitJob' {
- arrayProperties :: Maybe ArrayProperties
- containerOverrides :: Maybe ContainerOverrides
- dependsOn :: Maybe [JobDependency]
- eksPropertiesOverride :: Maybe EksPropertiesOverride
- nodeOverrides :: Maybe NodeOverrides
- parameters :: Maybe (HashMap Text Text)
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- schedulingPriorityOverride :: Maybe Int
- shareIdentifier :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- jobName :: Text
- jobQueue :: Text
- jobDefinition :: Text
- newSubmitJob :: Text -> Text -> Text -> SubmitJob
- submitJob_arrayProperties :: Lens' SubmitJob (Maybe ArrayProperties)
- submitJob_containerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides)
- submitJob_dependsOn :: Lens' SubmitJob (Maybe [JobDependency])
- submitJob_eksPropertiesOverride :: Lens' SubmitJob (Maybe EksPropertiesOverride)
- submitJob_nodeOverrides :: Lens' SubmitJob (Maybe NodeOverrides)
- submitJob_parameters :: Lens' SubmitJob (Maybe (HashMap Text Text))
- submitJob_propagateTags :: Lens' SubmitJob (Maybe Bool)
- submitJob_retryStrategy :: Lens' SubmitJob (Maybe RetryStrategy)
- submitJob_schedulingPriorityOverride :: Lens' SubmitJob (Maybe Int)
- submitJob_shareIdentifier :: Lens' SubmitJob (Maybe Text)
- submitJob_tags :: Lens' SubmitJob (Maybe (HashMap Text Text))
- submitJob_timeout :: Lens' SubmitJob (Maybe JobTimeout)
- submitJob_jobName :: Lens' SubmitJob Text
- submitJob_jobQueue :: Lens' SubmitJob Text
- submitJob_jobDefinition :: Lens' SubmitJob Text
- data SubmitJobResponse = SubmitJobResponse' {}
- newSubmitJobResponse :: Int -> Text -> Text -> SubmitJobResponse
- submitJobResponse_jobArn :: Lens' SubmitJobResponse (Maybe Text)
- submitJobResponse_httpStatus :: Lens' SubmitJobResponse Int
- submitJobResponse_jobName :: Lens' SubmitJobResponse Text
- submitJobResponse_jobId :: Lens' SubmitJobResponse Text
Creating a Request
Contains the parameters for SubmitJob
.
See: newSubmitJob
smart constructor.
SubmitJob' | |
|
Instances
Create a value of SubmitJob
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:
SubmitJob
, submitJob_arrayProperties
- 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 Batch User Guide.
SubmitJob
, submitJob_containerOverrides
- An object with various properties that override the defaults for the job
definition 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, which is specified in the job
definition or the Docker image, with a command
override. You can also
override existing environment variables on a container or add new
environment variables to it with an environment
override.
SubmitJob
, submitJob_dependsOn
- 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. In that case,
each index child of this job must wait for the corresponding index child
of each dependency to complete before it can begin.
$sel:eksPropertiesOverride:SubmitJob'
, submitJob_eksPropertiesOverride
- An object that can only be specified for jobs that are run on Amazon EKS
resources with various properties that override defaults for the job
definition.
$sel:nodeOverrides:SubmitJob'
, submitJob_nodeOverrides
- A list of node overrides in JSON format that specify the node range to
target and the container overrides for that node range.
This parameter isn't applicable to jobs that are running on Fargate
resources; use containerOverrides
instead.
SubmitJob
, submitJob_parameters
- 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.
SubmitJob
, submitJob_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
aren't 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.
When specified, this overrides the tag propagation setting in the job
definition.
SubmitJob
, submitJob_retryStrategy
- 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.
$sel:schedulingPriorityOverride:SubmitJob'
, submitJob_schedulingPriorityOverride
- The scheduling priority for the job. This only affects jobs in job
queues with a fair share policy. Jobs with a higher scheduling priority
are scheduled before jobs with a lower scheduling priority. This
overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
SubmitJob
, submitJob_shareIdentifier
- The share identifier for the job. If the job queue doesn't have a
scheduling policy, then this parameter must not be specified. If the job
queue has a scheduling policy, then this parameter must be specified.
SubmitJob
, submitJob_tags
- The tags that you apply to the job request 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 Amazon Web Services General Reference.
SubmitJob
, submitJob_timeout
- The timeout configuration for this SubmitJob operation. You can specify
a timeout duration after which Batch terminates your jobs if they
haven't finished. If a job is terminated due to a timeout, it isn't
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.
SubmitJob
, submitJob_jobName
- The name of the job. It can be up to 128 letters long. The first
character must be alphanumeric, can contain uppercase and lowercase
letters, numbers, hyphens (-), and underscores (_).
SubmitJob
, submitJob_jobQueue
- The job queue where the job is submitted. You can specify either the
name or the Amazon Resource Name (ARN) of the queue.
SubmitJob
, submitJob_jobDefinition
- The job definition used by this job. This value can be one of name
,
name:revision
, or the Amazon Resource Name (ARN) for the job
definition. If name
is specified without a revision then the latest
active revision is used.
Request Lenses
submitJob_arrayProperties :: 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 Batch User Guide.
submitJob_containerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides) Source #
An object with various properties that override the defaults for the job
definition 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, which is specified in the job
definition or the Docker image, with a command
override. You can also
override existing environment variables on a container or add new
environment variables to it with an environment
override.
submitJob_dependsOn :: Lens' SubmitJob (Maybe [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. In that case,
each index child of this job must wait for the corresponding index child
of each dependency to complete before it can begin.
submitJob_eksPropertiesOverride :: Lens' SubmitJob (Maybe EksPropertiesOverride) Source #
An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that override defaults for the job definition.
submitJob_nodeOverrides :: Lens' SubmitJob (Maybe NodeOverrides) Source #
A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
This parameter isn't applicable to jobs that are running on Fargate
resources; use containerOverrides
instead.
submitJob_parameters :: Lens' SubmitJob (Maybe (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.
submitJob_propagateTags :: Lens' SubmitJob (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
aren't 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.
When specified, this overrides the tag propagation setting in the job
definition.
submitJob_retryStrategy :: 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.
submitJob_schedulingPriorityOverride :: Lens' SubmitJob (Maybe Int) Source #
The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.
The minimum supported value is 0 and the maximum supported value is 9999.
submitJob_shareIdentifier :: Lens' SubmitJob (Maybe Text) Source #
The share identifier for the job. If the job queue doesn't have a scheduling policy, then this parameter must not be specified. If the job queue has a scheduling policy, then this parameter must be specified.
submitJob_tags :: Lens' SubmitJob (Maybe (HashMap Text Text)) Source #
The tags that you apply to the job request 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 Amazon Web Services General Reference.
submitJob_timeout :: Lens' SubmitJob (Maybe JobTimeout) Source #
The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't 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.
submitJob_jobName :: Lens' SubmitJob Text Source #
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
submitJob_jobQueue :: Lens' SubmitJob Text Source #
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
submitJob_jobDefinition :: Lens' SubmitJob Text Source #
The job definition used by this job. This value can be one of name
,
name:revision
, or the Amazon Resource Name (ARN) for the job
definition. If name
is specified without a revision then the latest
active revision is used.
Destructuring the Response
data SubmitJobResponse Source #
See: newSubmitJobResponse
smart constructor.
Instances
:: Int | |
-> Text | |
-> Text | |
-> SubmitJobResponse |
Create a value of SubmitJobResponse
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:
SubmitJobResponse
, submitJobResponse_jobArn
- The Amazon Resource Name (ARN) for the job.
$sel:httpStatus:SubmitJobResponse'
, submitJobResponse_httpStatus
- The response's http status code.
SubmitJob
, submitJobResponse_jobName
- The name of the job.
SubmitJobResponse
, submitJobResponse_jobId
- The unique identifier for the job.
Response Lenses
submitJobResponse_jobArn :: Lens' SubmitJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the job.
submitJobResponse_httpStatus :: Lens' SubmitJobResponse Int Source #
The response's http status code.
submitJobResponse_jobName :: Lens' SubmitJobResponse Text Source #
The name of the job.
submitJobResponse_jobId :: Lens' SubmitJobResponse Text Source #
The unique identifier for the job.