Menu
Amazon Simple Workflow Service
API Reference (API Version 2012-01-25)

Decision

Specifies a decision made by the decider. A decision can be one of these types:

  • CancelTimer: cancels a previously started timer and records a TimerCanceled event in the history.

  • CancelWorkflowExecution: closes the workflow execution and records a WorkflowExecutionCanceled event in the history.

  • CompleteWorkflowExecution: closes the workflow execution and records a WorkflowExecutionCompleted event in the history .

  • ContinueAsNewWorkflowExecution: closes the workflow execution and starts a new workflow execution of the same type using the same workflow id and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.

  • FailWorkflowExecution: closes the workflow execution and records a WorkflowExecutionFailed event in the history.

  • RecordMarker: records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.

  • RequestCancelActivityTask: attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it will be canceled. If the activity task was already assigned to a worker, then the worker will be informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.

  • RequestCancelExternalWorkflowExecution: requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.

  • ScheduleActivityTask: schedules an activity task.

  • SignalExternalWorkflowExecution: requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.

  • StartChildWorkflowExecution: requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.

  • StartTimer: starts a timer for this workflow execution and records a TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.

Access Control

If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Decision Failure

Decisions can fail for several reasons

  • The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and will therefore fail.

  • A limit on your account was reached.

  • The decision lacks sufficient permissions.

One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

  • ScheduleActivityTaskFailed: a ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision is not registered, is in a deprecated state, or the decision is not properly configured.

  • RequestCancelActivityTaskFailed: a RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.

  • StartTimerFailed: a StartTimer decision failed. This could happen if there is another open timer with the same timerId.

  • CancelTimerFailed: a CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.

  • StartChildWorkflowExecutionFailed: a StartChildWorkflowExecution decision failed. This could happen if the workflow type specified is not registered, is deprecated, or the decision is not properly configured.

  • SignalExternalWorkflowExecutionFailed: a SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

  • RequestCancelExternalWorkflowExecutionFailed: a RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

  • CancelWorkflowExecutionFailed: a CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

  • CompleteWorkflowExecutionFailed: a CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

  • ContinueAsNewWorkflowExecutionFailed: a ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.

  • FailWorkflowExecutionFailed: a FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.

Note

A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.

How to Code a Decision

You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:

Contents

cancelTimerDecisionAttributes

Provides details of the CancelTimer decision. It is not set for other decision types.

Type: CancelTimerDecisionAttributes object

Required: No

cancelWorkflowExecutionDecisionAttributes

Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.

Type: CancelWorkflowExecutionDecisionAttributes object

Required: No

completeWorkflowExecutionDecisionAttributes

Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.

Type: CompleteWorkflowExecutionDecisionAttributes object

Required: No

continueAsNewWorkflowExecutionDecisionAttributes

Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.

Type: ContinueAsNewWorkflowExecutionDecisionAttributes object

Required: No

decisionType

Specifies the type of the decision.

Type: String

Valid Values: ScheduleActivityTask | RequestCancelActivityTask | CompleteWorkflowExecution | FailWorkflowExecution | CancelWorkflowExecution | ContinueAsNewWorkflowExecution | RecordMarker | StartTimer | CancelTimer | SignalExternalWorkflowExecution | RequestCancelExternalWorkflowExecution | StartChildWorkflowExecution | ScheduleLambdaFunction

Required: Yes

failWorkflowExecutionDecisionAttributes

Provides details of the FailWorkflowExecution decision. It is not set for other decision types.

Type: FailWorkflowExecutionDecisionAttributes object

Required: No

recordMarkerDecisionAttributes

Provides details of the RecordMarker decision. It is not set for other decision types.

Type: RecordMarkerDecisionAttributes object

Required: No

requestCancelActivityTaskDecisionAttributes

Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.

Type: RequestCancelActivityTaskDecisionAttributes object

Required: No

requestCancelExternalWorkflowExecutionDecisionAttributes

Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.

Type: RequestCancelExternalWorkflowExecutionDecisionAttributes object

Required: No

scheduleActivityTaskDecisionAttributes

Provides details of the ScheduleActivityTask decision. It is not set for other decision types.

Type: ScheduleActivityTaskDecisionAttributes object

Required: No

scheduleLambdaFunctionDecisionAttributes

Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.

Type: ScheduleLambdaFunctionDecisionAttributes object

Required: No

signalExternalWorkflowExecutionDecisionAttributes

Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.

Type: SignalExternalWorkflowExecutionDecisionAttributes object

Required: No

startChildWorkflowExecutionDecisionAttributes

Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.

Type: StartChildWorkflowExecutionDecisionAttributes object

Required: No

startTimerDecisionAttributes

Provides details of the StartTimer decision. It is not set for other decision types.

Type: StartTimerDecisionAttributes object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: