You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SWF::Types::TerminateWorkflowExecutionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::TerminateWorkflowExecutionInput
- Defined in:
- (unknown)
Overview
When passing TerminateWorkflowExecutionInput as input to an Aws::Client method, you can use a vanilla Hash:
{
domain: "DomainName", # required
workflow_id: "WorkflowId", # required
run_id: "WorkflowRunIdOptional",
reason: "TerminateReason",
details: "Data",
child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
}
Instance Attribute Summary collapse
-
#child_policy ⇒ String
If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
-
#details ⇒ String
Details for terminating the workflow execution.
-
#domain ⇒ String
The domain of the workflow execution to terminate.
-
#reason ⇒ String
A descriptive reason for terminating the workflow execution.
-
#run_id ⇒ String
The runId of the workflow execution to terminate.
-
#workflow_id ⇒ String
The workflowId of the workflow execution to terminate.
Instance Attribute Details
#child_policy ⇒ String
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 aWorkflowExecutionCancelRequested
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.
Possible values:
- TERMINATE
- REQUEST_CANCEL
- ABANDON
#details ⇒ String
Details for terminating the workflow execution.
#domain ⇒ String
The domain of the workflow execution to terminate.
#reason ⇒ String
A descriptive reason for terminating the workflow execution.
#run_id ⇒ String
The runId of the workflow execution to terminate.
#workflow_id ⇒ String
The workflowId of the workflow execution to terminate.