Class: Aws::SWF::Types::WorkflowExecutionInfo

Inherits:

Struct

• Object
• Struct
• Aws::SWF::Types::WorkflowExecutionInfo

Defined in:

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

Overview

Contains information about a workflow execution.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cancel_requested ⇒ Boolean

  Set to true if a cancellation is requested for this workflow execution.

• #close_status ⇒ String

  If the execution status is closed then this specifies how the execution was closed:.

• #close_timestamp ⇒ Time

  The time when the workflow execution was closed.

• #execution ⇒ Types::WorkflowExecution

  The workflow execution this information is about.

• #execution_status ⇒ String

  The current status of the execution.

• #parent ⇒ Types::WorkflowExecution

  If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

• #start_timestamp ⇒ Time

  The time when the execution was started.

• #tag_list ⇒ Array<String>

  The list of tags associated with the workflow execution.

• #workflow_type ⇒ Types::WorkflowType

  The type of the workflow execution.

Instance Attribute Details

#cancel_requested ⇒ Boolean

Set to true if a cancellation is requested for this workflow execution.

Returns:

• (Boolean)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#close_status ⇒ String

If the execution status is closed then this specifies how the execution was closed:

• COMPLETED – the execution was successfully completed.

• CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

• TERMINATED – the execution was force terminated.

• FAILED – the execution failed to complete.

• TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

• CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

Returns:

• (String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#close_timestamp ⇒ Time

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

Returns:

• (Time)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#execution ⇒ Types::WorkflowExecution

The workflow execution this information is about.

Returns:

• (Types::WorkflowExecution)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#execution_status ⇒ String

The current status of the execution.

Returns:

• (String)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#parent ⇒ Types::WorkflowExecution

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

Returns:

• (Types::WorkflowExecution)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#start_timestamp ⇒ Time

The time when the execution was started.

Returns:

• (Time)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<String>

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_type ⇒ Types::WorkflowType

The type of the workflow execution.

Returns:

• (Types::WorkflowType)

# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6086

class WorkflowExecutionInfo < Struct.new(
  :execution,
  :workflow_type,
  :start_timestamp,
  :close_timestamp,
  :execution_status,
  :close_status,
  :parent,
  :tag_list,
  :cancel_requested)
  SENSITIVE = []
  include Aws::Structure
end