Class: Aws::Batch::Types::JobSummary

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::JobSummary

Includes:

Structure

Defined in:

lib/aws-sdk-batch/types.rb

Overview

An object that represents summary details of a job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #array_properties ⇒ Types::ArrayPropertiesSummary

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

• #capacity_usage ⇒ Array<Types::JobCapacityUsageSummary>

  The configured capacity usage information for this job, including the unit of measure and quantity of resources.

• #container ⇒ Types::ContainerSummary

  An object that represents the details of the container that’s associated with the job.

• #created_at ⇒ Integer

  The Unix timestamp (in milliseconds) for when the job was created.

• #job_arn ⇒ String

  The Amazon Resource Name (ARN) of the job.

• #job_definition ⇒ String

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

• #job_id ⇒ String

  The job ID.

• #job_name ⇒ String

  The job name.

• #node_properties ⇒ Types::NodePropertiesSummary

  The node properties for a single node in a job summary list.

• #scheduled_at ⇒ Integer

  The Unix timestamp (in milliseconds) for when the job was scheduled for execution.

• #share_identifier ⇒ String

  The share identifier for the fairshare scheduling queue that this job is associated with.

• #started_at ⇒ Integer

  The Unix timestamp for when the job was started.

• #status ⇒ String

  The current status for the job.

• #status_reason ⇒ String

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

• #stopped_at ⇒ Integer

  The Unix timestamp for when the job was stopped.

Instance Attribute Details

#array_properties ⇒ Types::ArrayPropertiesSummary

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

Returns:

• (Types::ArrayPropertiesSummary)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_usage ⇒ Array<Types::JobCapacityUsageSummary>

The configured capacity usage information for this job, including the unit of measure and quantity of resources.

Returns:

• (Array<Types::JobCapacityUsageSummary>)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#container ⇒ Types::ContainerSummary

An object that represents the details of the container that’s associated with the job.

Returns:

• (Types::ContainerSummary)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Integer

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 (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.

[1]: docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

The Amazon Resource Name (ARN) of the job.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#job_definition ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The job name.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#node_properties ⇒ Types::NodePropertiesSummary

The node properties for a single node in a job summary list.

<note markdown=“1”> This isn’t applicable to jobs that are running on Fargate resources.

</note>

Returns:

• (Types::NodePropertiesSummary)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_at ⇒ Integer

The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see [Service job status] in the *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/service-job-status.html

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#share_identifier ⇒ String

The share identifier for the fairshare scheduling queue that this job is associated with.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Integer

The Unix timestamp for when the job was started. More specifically, it’s when the job transitioned from the ‘STARTING` state to the `RUNNING` state.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status for the job.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end

#stopped_at ⇒ Integer

The Unix timestamp 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`.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 6738

class JobSummary < Struct.new(
  :job_arn,
  :job_id,
  :job_name,
  :capacity_usage,
  :created_at,
  :scheduled_at,
  :share_identifier,
  :status,
  :status_reason,
  :started_at,
  :stopped_at,
  :container,
  :array_properties,
  :node_properties,
  :job_definition)
  SENSITIVE = []
  include Aws::Structure
end