NAME

Paws::SimpleWorkflow::TerminateWorkflowExecution - Arguments for method TerminateWorkflowExecution on Paws::SimpleWorkflow

DESCRIPTION

This class represents the parameters used for calling the method TerminateWorkflowExecution on the Amazon Simple Workflow Service service. Use the attributes of this class as arguments to method TerminateWorkflowExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateWorkflowExecution.

SYNOPSIS

my $swf = Paws->service('SimpleWorkflow');
$swf->TerminateWorkflowExecution(
  Domain      => 'MyDomainName',
  WorkflowId  => 'MyWorkflowId',
  ChildPolicy => 'TERMINATE',                  # OPTIONAL
  Details     => 'MyData',                     # OPTIONAL
  Reason      => 'MyTerminateReason',          # OPTIONAL
  RunId       => 'MyWorkflowRunIdOptional',    # OPTIONAL
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/swf/TerminateWorkflowExecution

ATTRIBUTES

ChildPolicy => Str

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.

Valid values are: "TERMINATE", "REQUEST_CANCEL", "ABANDON"

Details => Str

Details for terminating the workflow execution.

REQUIRED Domain => Str

The domain of the workflow execution to terminate.

Reason => Str

A descriptive reason for terminating the workflow execution.

RunId => Str

The runId of the workflow execution to terminate.

REQUIRED WorkflowId => Str

The workflowId of the workflow execution to terminate.

SEE ALSO

This class forms part of Paws, documenting arguments for method TerminateWorkflowExecution in Paws::SimpleWorkflow

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues