batch/aws.sdk.kotlin.services.batch.model/JobDetail/Builder

Builder

class Builder

Properties

arrayProperties

var arrayProperties: ArrayPropertiesDetail?

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

attempts

var attempts: List<AttemptDetail>?

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

container

var container: ContainerDetail?

An object that represents the details for the container that's associated with the job.

createdAt

var createdAt: Long?

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.

dependsOn

var dependsOn: List<JobDependency>?

A list of job IDs that this job depends on.

eksAttempts

var eksAttempts: List<EksAttemptDetail>?

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

eksProperties

var eksProperties: EksPropertiesDetail?

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

isCancelled

var isCancelled: Boolean?

Indicates whether the job is canceled.

isTerminated

var isTerminated: Boolean?

Indicates whether the job is terminated.

jobArn

var jobArn: String?

The Amazon Resource Name (ARN) of the job.

jobDefinition

var jobDefinition: String?

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

jobId

var jobId: String?

The job ID.

jobName

var jobName: String?

The job name.

jobQueue

var jobQueue: String?

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

nodeDetails

var nodeDetails: NodeDetails?

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

nodeProperties

var nodeProperties: NodeProperties?

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

parameters

var parameters: Map<String, String>?

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

platformCapabilities

var platformCapabilities: List<PlatformCapability>?

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

propagateTags

var propagateTags: Boolean?

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.

retryStrategy

var retryStrategy: RetryStrategy?

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

schedulingPriority

var schedulingPriority: Int?

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.

shareIdentifier

var shareIdentifier: String?

The share identifier for the job.

startedAt

var startedAt: Long?

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.

status

var status: JobStatus?

The current status for the job.

statusReason

var statusReason: String?

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

stoppedAt

var stoppedAt: Long?

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.