You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Contains information about a workflow execution.

Instance Attribute Summary collapse

Instance Attribute Details

#cancel_requestedBoolean

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

Returns:

  • (Boolean)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#close_statusString

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)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#close_timestampTime

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

Returns:

  • (Time)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#executionTypes::WorkflowExecution

The workflow execution this information is about.



6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#execution_statusString

The current status of the execution.

Returns:

  • (String)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#parentTypes::WorkflowExecution

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



6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#start_timestampTime

The time when the execution was started.

Returns:

  • (Time)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#tag_listArray<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>)


6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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

#workflow_typeTypes::WorkflowType

The type of the workflow execution.

Returns:



6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 6456

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