Class: Aws::Deadline::Types::GetJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::Deadline::Types::GetJobResponse

Defined in:

gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb

Overview

Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:parameters, :description]

Instance Attribute Summary

• #attachments ⇒ Types::Attachments

  The attachments for the job.

• #created_at ⇒ Time

  The date and time the resource was created.

• #created_by ⇒ String

  The user or system that created this resource.

• #description ⇒ String

  The description of the job.

• #ended_at ⇒ Time

  The date and time the resource ended running.

• #job_id ⇒ String

  The job ID.

• #lifecycle_status ⇒ String

  The life cycle status for the job.

• #lifecycle_status_message ⇒ String

  A message that communicates the status of the life cycle for the job.

• #max_failed_tasks_count ⇒ Integer

  The number of task failures before the job stops running and is marked as FAILED.

• #max_retries_per_task ⇒ Integer

  The maximum number of retries per failed tasks.

• #max_worker_count ⇒ Integer

  The maximum number of worker hosts that can concurrently process a job.

• #name ⇒ String

  The name of the job.

• #parameters ⇒ Hash<String,Types::JobParameter>

  The parameters for the job.

• #priority ⇒ Integer

  The job priority.

• #source_job_id ⇒ String

  The job ID for the source job.

• #started_at ⇒ Time

  The date and time the resource started running.

• #storage_profile_id ⇒ String

  The storage profile ID associated with the job.

• #target_task_run_status ⇒ String

  The task status with which the job started.

• #task_failure_retry_count ⇒ Integer

  The total number of times tasks from the job failed and were retried.

• #task_run_status ⇒ String

  The task run status for the job.

• #task_run_status_counts ⇒ Hash<String,Integer>

  The number of tasks running on the job.

• #updated_at ⇒ Time

  The date and time the resource was updated.

• #updated_by ⇒ String

  The user or system that updated this resource.

Instance Attribute Details

#attachments ⇒ Types::Attachments

The attachments for the job.

Returns:

• (Types::Attachments)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the resource was created.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#created_by ⇒ String

The user or system that created this resource.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the job.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#ended_at ⇒ Time

The date and time the resource ended running.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#job_id ⇒ String

The job ID.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#lifecycle_status ⇒ String

The life cycle status for the job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#lifecycle_status_message ⇒ String

A message that communicates the status of the life cycle for the job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#max_failed_tasks_count ⇒ Integer

The number of task failures before the job stops running and is marked as FAILED.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#max_retries_per_task ⇒ Integer

The maximum number of retries per failed tasks.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#max_worker_count ⇒ Integer

The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#parameters ⇒ Hash<String,Types::JobParameter>

The parameters for the job.

Returns:

• (Hash<String,Types::JobParameter>)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#priority ⇒ Integer

The job priority.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#source_job_id ⇒ String

The job ID for the source job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#started_at ⇒ Time

The date and time the resource started running.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#storage_profile_id ⇒ String

The storage profile ID associated with the job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#target_task_run_status ⇒ String

The task status with which the job started.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#task_failure_retry_count ⇒ Integer

The total number of times tasks from the job failed and were retried.

Returns:

• (Integer)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#task_run_status ⇒ String

The task run status for the job.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#task_run_status_counts ⇒ Hash<String,Integer>

The number of tasks running on the job.

Returns:

• (Hash<String,Integer>)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the resource was updated.

Returns:

• (Time)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end

#updated_by ⇒ String

The user or system that updated this resource.

Returns:

• (String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 3560

class GetJobResponse < Struct.new(
  :job_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :priority,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :task_run_status,
  :target_task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :storage_profile_id,
  :max_failed_tasks_count,
  :max_retries_per_task,
  :parameters,
  :attachments,
  :description,
  :max_worker_count,
  :source_job_id)
  SENSITIVE = [:parameters, :description]
  include Aws::Structure
end