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.

An object that represents an Batch job.

Inheritance Hierarchy

System.Object
  Amazon.Batch.Model.JobDetail

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

Syntax

C#
public class JobDetail

The JobDetail type exposes the following members

Constructors

NameDescription
Public Method JobDetail()

Properties

NameTypeDescription
Public Property ArrayProperties Amazon.Batch.Model.ArrayPropertiesDetail

Gets and sets the property ArrayProperties.

The array properties of the job, if it's an array job.

Public Property Attempts System.Collections.Generic.List<Amazon.Batch.Model.AttemptDetail>

Gets and sets the property Attempts.

A list of job attempts that are associated with this job.

Public Property Container Amazon.Batch.Model.ContainerDetail

Gets and sets the property Container.

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

Public Property CreatedAt System.Int64

Gets and sets the property CreatedAt.

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

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

Gets and sets the property DependsOn.

A list of job IDs that this job depends on.

Public Property EcsProperties Amazon.Batch.Model.EcsPropertiesDetail

Gets and sets the property EcsProperties.

An object with properties that are specific to Amazon ECS-based jobs.

Public Property EksAttempts System.Collections.Generic.List<Amazon.Batch.Model.EksAttemptDetail>

Gets and sets the property EksAttempts.

A list of job attempts that are associated with this job.

Public Property EksProperties Amazon.Batch.Model.EksPropertiesDetail

Gets and sets the property EksProperties.

An object with various properties that are specific to Amazon EKS based jobs.

Public Property IsCancelled System.Boolean

Gets and sets the property IsCancelled.

Indicates whether the job is canceled.

Public Property IsTerminated System.Boolean

Gets and sets the property IsTerminated.

Indicates whether the job is terminated.

Public Property JobArn System.String

Gets and sets the property JobArn.

The Amazon Resource Name (ARN) of the job.

Public Property JobDefinition System.String

Gets and sets the property JobDefinition.

The Amazon Resource Name (ARN) of the job definition that this job uses.

Public Property JobId System.String

Gets and sets the property JobId.

The job ID.

Public Property JobName System.String

Gets and sets the property JobName.

The job name.

Public Property JobQueue System.String

Gets and sets the property JobQueue.

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

Public Property NodeDetails Amazon.Batch.Model.NodeDetails

Gets and sets the property NodeDetails.

An object that represents the details of a node that's associated with a multi-node parallel job.

Public Property NodeProperties Amazon.Batch.Model.NodeProperties

Gets and sets the property NodeProperties.

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

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

Gets and sets the property Parameters.

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

Public Property PlatformCapabilities System.Collections.Generic.List<System.String>

Gets and sets the property PlatformCapabilities.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Public Property PropagateTags System.Boolean

Gets and sets the property 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 when the tasks are created. 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.

Public Property RetryStrategy Amazon.Batch.Model.RetryStrategy

Gets and sets the property RetryStrategy.

The retry strategy to use for this job if an attempt fails.

Public Property SchedulingPriority System.Int32

Gets and sets the property SchedulingPriority.

The scheduling policy of the job definition. 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.

Public Property ShareIdentifier System.String

Gets and sets the property ShareIdentifier.

The share identifier for the job.

Public Property StartedAt System.Int64

Gets and sets the property StartedAt.

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

Public Property Status Amazon.Batch.JobStatus

Gets and sets the property Status.

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

Public Property StatusReason System.String

Gets and sets the property StatusReason.

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

Public Property StoppedAt System.Int64

Gets and sets the property StoppedAt.

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

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

Gets and sets the property Tags.

The tags that are applied to the job.

Public Property Timeout Amazon.Batch.Model.JobTimeout

Gets and sets the property Timeout.

The timeout configuration for the job.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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