-ArrayProperties_Size <
Int32>
The size of the array job.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The command to send to the container that overrides the default command from the Docker image or the job definition.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.Environment variables must not start with AWS_BATCH
; this naming convention is reserved for variables that are set by the Batch service.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ContainerOverrides_InstanceType <
String>
The instance type to use for a multi-node parallel job.This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ContainerOverrides_Memory <
Int32>
This parameter is deprecated, use
resourceRequirements
to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the
memory
parameter set in the job definition, but doesn't override any memory requirement specified in the
resourceRequirements
structure in the job definition. To override memory requirements that are specified in the
resourceRequirements
structure in the job definition,
resourceRequirements
must be specified in the
SubmitJob
request, with
type
set to
MEMORY
and
value
set to the new value. For more information, see
Can't override job definition resource requirements in the
Batch User Guide.This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU
, MEMORY
, and VCPU
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ContainerOverrides_ResourceRequirements |
-ContainerOverrides_Vcpus <
Int32>
This parameter is deprecated, use
resourceRequirements
to override the
vcpus
parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it overrides the
vcpus
parameter set in the job definition, but doesn't override any vCPU requirement specified in the
resourceRequirements
structure in the job definition. To override vCPU requirements that are specified in the
resourceRequirements
structure in the job definition,
resourceRequirements
must be specified in the
SubmitJob
request, with
type
set to
VCPU
and
value
set to the new value. For more information, see
Can't override job definition resource requirements in the
Batch User Guide.This parameter is deprecated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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 (_).
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The node property overrides for the job.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NodeOverrides_NodePropertyOverrides |
-NodeOverrides_NumNode <
Int32>
The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:
- There must be at least one node range in your job definition that has an open upper boundary (such as
:
or n:
). - The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.
- The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | NodeOverrides_NumNodes |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Parameters |
Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PropagateTags |
-RetryStrategy_Attempt <
Int32>
The number of times to move a job to the RUNNABLE
status. You can specify between 1 and 10 attempts. If the value of attempts
is greater than one, the job is retried on failure the same number of attempts as the value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RetryStrategy_Attempts |
Array of up to 5 objects that specify conditions under which the job should be retried or failed. If this parameter is specified, then the attempts
parameter must also be specified.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SchedulingPriorityOverride <
Int32>
The scheduling priority for the job. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job definition.The minimum supported value is 0 and the maximum supported value is 9999.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Batch.Model.SubmitJobResponse). Specifying the name of a property of type Amazon.Batch.Model.SubmitJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The share identifier for the job. If the job queue does not 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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |