swf_terminate_workflow_execution: Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId

Description

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

See https://www.paws-r-sdk.com/docs/swf_terminate_workflow_execution/ for full documentation.

Usage

swf_terminate_workflow_execution(
  domain,
  workflowId,
  runId = NULL,
  reason = NULL,
  details = NULL,
  childPolicy = NULL
)

Arguments

domain

[required] The domain of the workflow execution to terminate.

workflowId

[required] The workflowId of the workflow execution to terminate.

runId

The runId of the workflow execution to terminate.

reason

A descriptive reason for terminating the workflow execution.

details

Details for terminating the workflow execution.

childPolicy

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

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.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.