Class: Aws::SWF::Types::TerminateWorkflowExecutionInput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-swf/types.rb

Overview

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
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end

#details ⇒ String

Details for terminating the workflow execution.

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

The domain of the workflow execution to terminate.

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

A descriptive reason for terminating the workflow execution.

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end

#run_id ⇒ String

The runId of the workflow execution to terminate.

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

The workflowId of the workflow execution to terminate.

Returns:

  • (String) 


6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
 
# File 'lib/aws-sdk-swf/types.rb', line 6233

class TerminateWorkflowExecutionInput < Struct.new(
  :domain,
  :workflow_id,
  :run_id,
  :reason,
  :details,
  :child_policy)
  SENSITIVE = []
  include Aws::Structure
end