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 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.
Parameters:
-
domain
(DomainName)
–
The name of the domain containing the workflow execution to cancel.
-
workflow_id
(WorkflowId)
–
The workflowId of the workflow execution to cancel.
-
run_id
(Optional[WorkflowRunIdOptional], default:
None
)
–
The runId of the workflow execution to cancel.
Raises:
-
OperationNotPermittedFault
–
Returned when the caller doesn't have sufficient permissions to invoke the action.
-
UnknownResourceFault
–
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_swf/_services/swf.py
| def request_cancel_workflow_execution(
self,
domain: "capo_swf.types.domain_name.DomainName",
workflow_id: "capo_swf.types.workflow_id.WorkflowId",
*,
config_overrides: Optional[SWFClientConfig] = None,
run_id: Optional[
"capo_swf.types.workflow_run_id_optional.WorkflowRunIdOptional"
] = None,
) -> None:
"""<p>Records a <code>WorkflowExecutionCancelRequested</code> 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.</p> <note> <p>If the runId isn't specified, the <code>WorkflowExecutionCancelRequested</code> event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.</p> </note> <note> <p>Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of <a>TerminateWorkflowExecution</a> when possible.</p> </note> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li> <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li> <li> <p>You cannot use an IAM policy to constrain this action's parameters.</p> </li> </ul> <p>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 <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
Args:
domain: <p>The name of the domain containing the workflow execution to cancel.</p>
workflow_id: <p>The workflowId of the workflow execution to cancel.</p>
run_id: <p>The runId of the workflow execution to cancel.</p>
Raises:
capo_swf.errors.operation_not_permitted_fault.OperationNotPermittedFault: <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
capo_swf.errors.unknown_resource_fault.UnknownResourceFault: <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
capo_swf.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_swf.types.request_cancel_workflow_execution_input.RequestCancelWorkflowExecutionInput]",
) -> OperationResponse[None]:
import capo_swf._operations.simple_workflow_service.request_cancel_workflow_execution
output, http_response = (
capo_swf._operations.simple_workflow_service.request_cancel_workflow_execution.request_cancel_workflow_execution(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("RequestCancelWorkflowExecution")
)
input_: capo_swf.types.request_cancel_workflow_execution_input.RequestCancelWorkflowExecutionInput = {
"domain": domain,
"workflow_id": workflow_id,
}
if run_id is not None:
input_["run_id"] = run_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|