class Aws::SWF::Types::Decision

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

**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] in the *Amazon SWF Developer Guide*.

**Decision Failure**

Decisions can fail for several reasons

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] in the *Amazon SWF Developer Guide*.

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 markdown=“1”> 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 is 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.

</note>

**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:

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html

@note When making an API call, you may pass Decision

data as a hash:

    {
      decision_type: "ScheduleActivityTask", # required, accepts ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution, ScheduleLambdaFunction
      schedule_activity_task_decision_attributes: {
        activity_type: { # required
          name: "Name", # required
          version: "Version", # required
        },
        activity_id: "ActivityId", # required
        control: "Data",
        input: "Data",
        schedule_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        schedule_to_start_timeout: "DurationInSecondsOptional",
        start_to_close_timeout: "DurationInSecondsOptional",
        heartbeat_timeout: "DurationInSecondsOptional",
      },
      request_cancel_activity_task_decision_attributes: {
        activity_id: "ActivityId", # required
      },
      complete_workflow_execution_decision_attributes: {
        result: "Data",
      },
      fail_workflow_execution_decision_attributes: {
        reason: "FailureReason",
        details: "Data",
      },
      cancel_workflow_execution_decision_attributes: {
        details: "Data",
      },
      continue_as_new_workflow_execution_decision_attributes: {
        input: "Data",
        execution_start_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        task_start_to_close_timeout: "DurationInSecondsOptional",
        child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
        tag_list: ["Tag"],
        workflow_type_version: "Version",
        lambda_role: "Arn",
      },
      record_marker_decision_attributes: {
        marker_name: "MarkerName", # required
        details: "Data",
      },
      start_timer_decision_attributes: {
        timer_id: "TimerId", # required
        control: "Data",
        start_to_fire_timeout: "DurationInSeconds", # required
      },
      cancel_timer_decision_attributes: {
        timer_id: "TimerId", # required
      },
      signal_external_workflow_execution_decision_attributes: {
        workflow_id: "WorkflowId", # required
        run_id: "WorkflowRunIdOptional",
        signal_name: "SignalName", # required
        input: "Data",
        control: "Data",
      },
      request_cancel_external_workflow_execution_decision_attributes: {
        workflow_id: "WorkflowId", # required
        run_id: "WorkflowRunIdOptional",
        control: "Data",
      },
      start_child_workflow_execution_decision_attributes: {
        workflow_type: { # required
          name: "Name", # required
          version: "Version", # required
        },
        workflow_id: "WorkflowId", # required
        control: "Data",
        input: "Data",
        execution_start_to_close_timeout: "DurationInSecondsOptional",
        task_list: {
          name: "Name", # required
        },
        task_priority: "TaskPriority",
        task_start_to_close_timeout: "DurationInSecondsOptional",
        child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
        tag_list: ["Tag"],
        lambda_role: "Arn",
      },
      schedule_lambda_function_decision_attributes: {
        id: "FunctionId", # required
        name: "FunctionName", # required
        control: "Data",
        input: "FunctionInput",
        start_to_close_timeout: "DurationInSecondsOptional",
      },
    }

@!attribute [rw] decision_type

Specifies the type of the decision.
@return [String]

@!attribute [rw] schedule_activity_task_decision_attributes

Provides the details of the `ScheduleActivityTask` decision. It
isn't set for other decision types.
@return [Types::ScheduleActivityTaskDecisionAttributes]

@!attribute [rw] request_cancel_activity_task_decision_attributes

Provides the details of the `RequestCancelActivityTask` decision. It
isn't set for other decision types.
@return [Types::RequestCancelActivityTaskDecisionAttributes]

@!attribute [rw] complete_workflow_execution_decision_attributes

Provides the details of the `CompleteWorkflowExecution` decision. It
isn't set for other decision types.
@return [Types::CompleteWorkflowExecutionDecisionAttributes]

@!attribute [rw] fail_workflow_execution_decision_attributes

Provides the details of the `FailWorkflowExecution` decision. It
isn't set for other decision types.
@return [Types::FailWorkflowExecutionDecisionAttributes]

@!attribute [rw] cancel_workflow_execution_decision_attributes

Provides the details of the `CancelWorkflowExecution` decision. It
isn't set for other decision types.
@return [Types::CancelWorkflowExecutionDecisionAttributes]

@!attribute [rw] continue_as_new_workflow_execution_decision_attributes

Provides the details of the `ContinueAsNewWorkflowExecution`
decision. It isn't set for other decision types.
@return [Types::ContinueAsNewWorkflowExecutionDecisionAttributes]

@!attribute [rw] record_marker_decision_attributes

Provides the details of the `RecordMarker` decision. It isn't set
for other decision types.
@return [Types::RecordMarkerDecisionAttributes]

@!attribute [rw] start_timer_decision_attributes

Provides the details of the `StartTimer` decision. It isn't set for
other decision types.
@return [Types::StartTimerDecisionAttributes]

@!attribute [rw] cancel_timer_decision_attributes

Provides the details of the `CancelTimer` decision. It isn't set
for other decision types.
@return [Types::CancelTimerDecisionAttributes]

@!attribute [rw] signal_external_workflow_execution_decision_attributes

Provides the details of the `SignalExternalWorkflowExecution`
decision. It isn't set for other decision types.
@return [Types::SignalExternalWorkflowExecutionDecisionAttributes]

@!attribute [rw] request_cancel_external_workflow_execution_decision_attributes

Provides the details of the `RequestCancelExternalWorkflowExecution`
decision. It isn't set for other decision types.
@return [Types::RequestCancelExternalWorkflowExecutionDecisionAttributes]

@!attribute [rw] start_child_workflow_execution_decision_attributes

Provides the details of the `StartChildWorkflowExecution` decision.
It isn't set for other decision types.
@return [Types::StartChildWorkflowExecutionDecisionAttributes]

@!attribute [rw] schedule_lambda_function_decision_attributes

Provides the details of the `ScheduleLambdaFunction` decision. It
isn't set for other decision types.
@return [Types::ScheduleLambdaFunctionDecisionAttributes]

Constants

SENSITIVE