You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/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
}

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.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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

#detailsString

Details for terminating the workflow execution.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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

#domainString

The domain of the workflow execution to terminate.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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

#reasonString

A descriptive reason for terminating the workflow execution.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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

#run_idString

The runId of the workflow execution to terminate.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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

#workflow_idString

The workflowId of the workflow execution to terminate.

Returns:

  • (String)


5949
5950
5951
5952
5953
5954
5955
5956
5957
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5949

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