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 RegisterJobDefinition operation. Registers an AWS Batch job definition.

Inheritance Hierarchy


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


public class RegisterJobDefinitionRequest : AmazonBatchRequest

The RegisterJobDefinitionRequest type exposes the following members



Public Property ContainerProperties Amazon.Batch.Model.ContainerProperties

Gets and sets the property ContainerProperties.

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

Public Property JobDefinitionName System.String

Gets and sets the property JobDefinitionName.

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

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

Gets and sets the property Parameters.

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-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 that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

Public Property Timeout Amazon.Batch.Model.JobTimeout

Gets and sets the property Timeout.

The timeout configuration for jobs that are submitted with this job definition, 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. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Public Property Type Amazon.Batch.JobDefinitionType

Gets and sets the property Type.

The type of job definition.


This example registers a job definition for a simple container job.

To register a job definition

var response = client.RegisterJobDefinition(new RegisterJobDefinitionRequest 
    Type = "container",
    ContainerProperties = new ContainerProperties {
        Command = new List {
        Image = "busybox",
        Memory = 128,
        Vcpus = 1
    JobDefinitionName = "sleep10"

string jobDefinitionArn = response.JobDefinitionArn;
string jobDefinitionName = response.JobDefinitionName;
integer revision = response.Revision;


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