SWF / Client / terminate_workflow_execution

terminate_workflow_execution#

SWF.Client.terminate_workflow_execution(**kwargs)#

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

Warning

If the identified workflow execution was in progress, it is terminated immediately.

Note

If a runId isn’t specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

Note

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn’t.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.terminate_workflow_execution(
    domain='string',
    workflowId='string',
    runId='string',
    reason='string',
    details='string',
    childPolicy='TERMINATE'|'REQUEST_CANCEL'|'ABANDON'
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The domain of the workflow execution to terminate.

  • workflowId (string) –

    [REQUIRED]

    The workflowId of the workflow execution to terminate.

  • runId (string) – The runId of the workflow execution to terminate.

  • reason (string) – A descriptive reason for terminating the workflow execution.

  • details (string) – Details for terminating the workflow execution.

  • childPolicy (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

    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:

None

Exceptions

  • SWF.Client.exceptions.UnknownResourceFault

  • SWF.Client.exceptions.OperationNotPermittedFault