Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface WorkflowExecutionInfo

Contains information about a workflow execution.


  • WorkflowExecutionInfo


cancelRequested?: boolean

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

closeStatus?: 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.

closeTimestamp?: Date

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

execution: undefined | WorkflowExecution

The workflow execution this information is about.

executionStatus: undefined | string

The current status of the execution.

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

startTimestamp: undefined | Date

The time when the execution was started.

tagList?: 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.

workflowType: undefined | WorkflowType

The type of the workflow execution.