class Aws::SWF::Types::TerminateWorkflowExecutionInput
@note When making an API call, you may pass TerminateWorkflowExecutionInput
data as a hash: { domain: "DomainName", # required workflow_id: "WorkflowId", # required run_id: "WorkflowRunIdOptional", reason: "TerminateReason", details: "Data", child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON }
@!attribute [rw] domain
The domain of the workflow execution to terminate. @return [String]
@!attribute [rw] workflow_id
The workflowId of the workflow execution to terminate. @return [String]
@!attribute [rw] run_id
The runId of the workflow execution to terminate. @return [String]
@!attribute [rw] reason
A descriptive reason for terminating the workflow execution. @return [String]
@!attribute [rw] details
Details for terminating the workflow execution. @return [String]
@!attribute [rw] child_policy
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. <note markdown="1"> 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. </note> @return [String]
Constants
- SENSITIVE