AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SubmitJob operation. Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.SubmitJobRequest

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

C#
public class SubmitJobRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The SubmitJobRequest type exposes the following members

Constructors

NameDescription
Public Method SubmitJobRequest()

Properties

NameTypeDescription
Public Property ArrayProperties Amazon.Batch.Model.ArrayProperties

Gets and sets the property 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 AWS Batch User Guide.

Public Property ContainerOverrides Amazon.Batch.Model.ContainerOverrides

Gets and sets the property ContainerOverrides.

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.

Public Property DependsOn System.Collections.Generic.List<Amazon.Batch.Model.JobDependency>

Gets and sets the property 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 so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

Public Property JobDefinition System.String

Gets and sets the property JobDefinition.

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.

Public Property JobName System.String

Gets and sets the property JobName.

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.

Public Property JobQueue System.String

Gets and sets the property JobQueue.

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

Public Property Parameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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.

Public Property RetryStrategy Amazon.Batch.Model.RetryStrategy

Gets and sets the property 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.

Public Property Timeout Amazon.Batch.Model.JobTimeout

Gets and sets the property Timeout.

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.

Examples

This example submits a simple container job called example to the HighPriority job queue.

To submit a job to a queue


var response = client.SubmitJob(new SubmitJobRequest 
{
    JobDefinition = "sleep60",
    JobName = "example",
    JobQueue = "HighPriority"
});

string jobId = response.JobId;
string jobName = response.JobName;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms