swf_request_cancel_workflow_execution: Records a WorkflowExecutionCancelRequested event in the...

Description Usage Arguments Value Request syntax

View source: R/swf_operations.R

Description

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.

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.

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

Access Control

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

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.

Usage

1
swf_request_cancel_workflow_execution(domain, workflowId, runId)

Arguments

domain

[required] The name of the domain containing the workflow execution to cancel.

workflowId

[required] The workflowId of the workflow execution to cancel.

runId

The runId of the workflow execution to cancel.

Value

An empty list.

Request syntax

1
2
3
4
5
svc$request_cancel_workflow_execution(
  domain = "string",
  workflowId = "string",
  runId = "string"
)

paws.application.integration documentation built on Aug. 23, 2021, 9:20 a.m.