You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Batch::Types::JobDetail

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

An object representing an AWS Batch job.

Instance Attribute Summary collapse

Instance Attribute Details

#attemptsArray<Types::AttemptDetail>

A list of job attempts associated with this job.

Returns:



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#containerTypes::ContainerDetail

An object representing the details of the container that is associated with the job.



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#created_atInteger

The Unix timestamp for when the job was created (when the task entered the PENDING state).

Returns:

  • (Integer)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#depends_onArray<Types::JobDependency>

A list of job names or IDs on which this job depends.

Returns:



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#job_definitionString

The job definition that is used by this job.

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#job_idString

The ID for the job.

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#job_nameString

The name of the job.

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#job_queueString

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

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#retry_strategyTypes::RetryStrategy

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



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#started_atInteger

The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).

Returns:

  • (Integer)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#statusString

The current status for the job.

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end

#stopped_atInteger

The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).

Returns:

  • (Integer)


1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1377

class JobDetail < Struct.new(
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container)
  include Aws::Structure
end