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

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

Overview

An object that represents summary details of a job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#array_properties ⇒ Types::ArrayPropertiesSummary

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



7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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:



7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#container ⇒ Types::ContainerSummary

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



7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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.

Returns:

  • (Integer)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#is_cancelled ⇒ Boolean

Indicates whether a cancellation request has been accepted for the job. This field is only present when the value is true.

Returns:

  • (Boolean)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#is_terminated ⇒ Boolean

Indicates whether a termination request has been accepted for the job. This field is only present when the value is true.

Returns:

  • (Boolean)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

The Amazon Resource Name (ARN) of the job.

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#job_definition ⇒ String

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

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The job ID.

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The job name.

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#node_properties ⇒ Types::NodePropertiesSummary

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

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



7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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.

Returns:

  • (Integer)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#share_identifier ⇒ String

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

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status for the job.

Returns:

  • (String)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  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)


7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 7564

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,
  :is_cancelled,
  :is_terminated)
  SENSITIVE = []
  include Aws::Structure
end