Class: Aws::Deadline::Types::BatchGetStepItem

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

Overview

The details of a step returned in a batch get operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The date and time the resource was created.

Returns:

  • (Time) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_by ⇒ String

The user or system that created this resource.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#dependency_counts ⇒ Types::DependencyCounts

The number of dependencies for the step.

Returns:



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#ended_at ⇒ Time

The date and time the resource ended running.

Returns:

  • (Time) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#farm_id ⇒ String

The farm ID of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#job_id ⇒ String

The job ID of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#lifecycle_status ⇒ String

The life cycle status of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#lifecycle_status_message ⇒ String

A message that communicates the status of the life cycle.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#name ⇒ String

The name of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#parameter_space ⇒ Types::ParameterSpace

The parameter space for the step.

Returns:



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#queue_id ⇒ String

The queue ID of the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#required_capabilities ⇒ Types::StepRequiredCapabilities

The required capabilities for the step.

Returns:



1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#started_at ⇒ Time

The date and time the resource started running.

Returns:

  • (Time) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#step_id ⇒ String

The step ID.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#target_task_run_status ⇒ String

The task status to start with on the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#task_failure_retry_count ⇒ Integer

The number of times that tasks failed and were retried.

Returns:

  • (Integer) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#task_run_status ⇒ String

The task run status for the step.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#task_run_status_counts ⇒ Hash<String,Integer>

The number of tasks for each run status for the step.

Returns:

  • (Hash<String,Integer>) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the resource was updated.

Returns:

  • (Time) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_by ⇒ String

The user or system that updated this resource.

Returns:

  • (String) 


1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 1615

class BatchGetStepItem < Struct.new(
  :farm_id,
  :queue_id,
  :job_id,
  :step_id,
  :name,
  :lifecycle_status,
  :lifecycle_status_message,
  :task_run_status,
  :task_run_status_counts,
  :task_failure_retry_count,
  :target_task_run_status,
  :created_at,
  :created_by,
  :updated_at,
  :updated_by,
  :started_at,
  :ended_at,
  :dependency_counts,
  :required_capabilities,
  :parameter_space,
  :description)
  SENSITIVE = [:description]
  include Aws::Structure
end