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

#array_propertiesTypes::ArrayPropertiesDetail

The array properties of the job, if it is an array job.



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#attemptsArray<Types::AttemptDetail>

A list of job attempts associated with this job.

Returns:



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#containerTypes::ContainerDetail

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



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#created_atInteger

The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (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.

Returns:

  • (Integer)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#depends_onArray<Types::JobDependency>

A list of job IDs on which this job depends.

Returns:



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#job_definitionString

The job definition that is used by this job.

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#job_idString

The ID for the job.

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#job_nameString

The name of the job.

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#job_queueString

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

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#node_detailsTypes::NodeDetails

An object representing the details of a node that is associated with a multi-node parallel job.

Returns:



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#node_propertiesTypes::NodeProperties

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



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  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>)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#retry_strategyTypes::RetryStrategy

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



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#started_atInteger

The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

Returns:

  • (Integer)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#statusString

The current status for the job.

If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#stopped_atInteger

The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

Returns:

  • (Integer)


1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end

#timeoutTypes::JobTimeout

The timeout configuration for the job.

Returns:



1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 1808

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,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout)
  include Aws::Structure
end