AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#child_policyString

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.

Possible values:

  • TERMINATE
  • REQUEST_CANCEL
  • ABANDON

Returns:

  • (String)

    If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.

#detailsString

Details for terminating the workflow execution.

Returns:

  • (String)

    Details for terminating the workflow execution.

#domainString

The domain of the workflow execution to terminate.

Returns:

  • (String)

    The domain of the workflow execution to terminate.

#reasonString

A descriptive reason for terminating the workflow execution.

Returns:

  • (String)

    A descriptive reason for terminating the workflow execution.

#run_idString

The runId of the workflow execution to terminate.

Returns:

  • (String)

    The runId of the workflow execution to terminate.

#workflow_idString

The workflowId of the workflow execution to terminate.

Returns:

  • (String)

    The workflowId of the workflow execution to terminate.