SWF / Client / request_cancel_workflow_execution

request_cancel_workflow_execution#

SWF.Client.request_cancel_workflow_execution(**kwargs)#

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

Note

If the runId isn’t specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Note

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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.request_cancel_workflow_execution(
    domain='string',
    workflowId='string',
    runId='string'
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The name of the domain containing the workflow execution to cancel.

  • workflowId (string) –

    [REQUIRED]

    The workflowId of the workflow execution to cancel.

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

Returns:

None

Exceptions

  • SWF.Client.exceptions.UnknownResourceFault

  • SWF.Client.exceptions.OperationNotPermittedFault