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 WorkflowExecutionStartedEventAttributes

Provides details of WorkflowExecutionStarted event.

Hierarchy

  • WorkflowExecutionStartedEventAttributes

Properties

childPolicy continuedExecutionRunId? executionStartToCloseTimeout? input? lambdaRole? parentInitiatedEventId? parentWorkflowExecution? tagList? taskList taskPriority? taskStartToCloseTimeout? workflowType

Properties

childPolicy

childPolicy: undefined | string

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE – The child executions are terminated.

  • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

  • ABANDON – No action is taken. The child executions continue to run.

Optional continuedExecutionRunId

continuedExecutionRunId?: string

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

Optional executionStartToCloseTimeout

executionStartToCloseTimeout?: string

The maximum duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Optional input

input?: string

The input provided to the workflow execution.

Optional lambdaRole

lambdaRole?: string

The IAM role attached to the workflow execution.

Optional parentInitiatedEventId

parentInitiatedEventId?: number

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Optional parentWorkflowExecution

parentWorkflowExecution?: WorkflowExecution

The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

Optional tagList

tagList?: string[]

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

taskList

taskList: undefined | TaskList

The name of the task list for scheduling the decision tasks for this workflow execution.

Optional taskPriority

taskPriority?: string

The priority of the decision tasks in the workflow execution.

Optional taskStartToCloseTimeout

taskStartToCloseTimeout?: string

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowType

workflowType: undefined | WorkflowType

The workflow type of this execution.

Settings

Member Visibility

Theme