Synopsis
Calls the AWS Batch SubmitJob API operation.
Syntax
Submit-BATJob-JobName <String>-RetryStrategy_Attempt <Int32>-ContainerOverrides_Command <String[]>-DependsOn <JobDependency[]>-ContainerOverrides_Environment <KeyValuePair[]>-ContainerOverrides_InstanceType <String>-JobDefinition <String>-JobQueue <String>-ContainerOverrides_Memory <Int32>-NodeOverrides_NodePropertyOverride <NodePropertyOverride[]>-NodeOverrides_NumNode <Int32>-Parameter <Hashtable>-ContainerOverrides_ResourceRequirement <ResourceRequirement[]>-ArrayProperties_Size <Int32>-Timeout <JobTimeout>-ContainerOverrides_Vcpus <Int32>-Force <SwitchParameter>
Description
Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.
Parameters
-ArrayProperties_Size <Int32>
The size of the array job.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContainerOverrides_Command <String[]>
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? | False |
-ContainerOverrides_Environment <KeyValuePair[]>
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 AWS Batch service. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContainerOverrides_InstanceType <String>
The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContainerOverrides_Memory <Int32>
The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ContainerOverrides_ResourceRequirement <ResourceRequirement[]>
The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is
GPU. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ContainerOverrides_ResourceRequirements |
-ContainerOverrides_Vcpus <Int32>
The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DependsOn <JobDependency[]>
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? | False |
-Force <SwitchParameter>
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? | False |
-JobDefinition <String>
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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-JobName <String>
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.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
-JobQueue <String>
The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NodeOverrides_NodePropertyOverride <NodePropertyOverride[]>
The node property overrides for the job.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| 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
:orn:). - 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? | False |
| Aliases | NodeOverrides_NumNodes |
-Parameter <Hashtable>
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? | False |
| Aliases | Parameters |
-RetryStrategy_Attempt <Int32>
The number of times to move a job to the
RUNNABLE status. You may 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? | False |
| Aliases | RetryStrategy_Attempts |
-Timeout <JobTimeout>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a String object to this cmdlet for the JobName parameter.
Outputs
This cmdlet returns a Amazon.Batch.Model.SubmitJobResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
