AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about a workflow execution.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#cancel_requestedBoolean

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

Returns:

  • (Boolean)

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

#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.

    Possible values:

    • COMPLETED
    • FAILED
    • CANCELED
    • TERMINATED
    • CONTINUED_AS_NEW
    • TIMED_OUT

Returns:

  • (String)

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

#close_timestampTime

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

Returns:

  • (Time)

    The time when the workflow execution was closed.

#executionTypes::WorkflowExecution

The workflow execution this information is about.

Returns:

#execution_statusString

The current status of the execution.

Possible values:

  • OPEN
  • CLOSED

Returns:

  • (String)

    The current status of the execution.

#parentTypes::WorkflowExecution

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

Returns:

  • (Types::WorkflowExecution)

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

#start_timestampTime

The time when the execution was started.

Returns:

  • (Time)

    The time when the execution was started.

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

    The list of tags associated with the workflow execution.

#workflow_typeTypes::WorkflowType

The type of the workflow execution.

Returns: