terminateWorkflowExecution method

Future<void> terminateWorkflowExecution({ required String domain, required String workflowId, ChildPolicy? childPolicy, String? details, String? reason, String? runId, })

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. 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.

May throw UnknownResourceFault. May throw OperationNotPermittedFault.

Parameter domain : The domain of the workflow execution to terminate.

Parameter workflowId : The workflowId of the workflow execution to terminate.

Parameter childPolicy : 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.

Parameter details : Details for terminating the workflow execution.

Parameter reason : A descriptive reason for terminating the workflow execution.

Parameter runId : The runId of the workflow execution to terminate.

Implementation

Future<void> terminateWorkflowExecution({
  required String domain,
  required String workflowId,
  ChildPolicy? childPolicy,
  String? details,
  String? reason,
  String? runId,
}) async {
  ArgumentError.checkNotNull(domain, 'domain');
  _s.validateStringLength(
    'domain',
    domain,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(workflowId, 'workflowId');
  _s.validateStringLength(
    'workflowId',
    workflowId,
    1,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'details',
    details,
    0,
    32768,
  );
  _s.validateStringLength(
    'reason',
    reason,
    0,
    256,
  );
  _s.validateStringLength(
    'runId',
    runId,
    0,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.TerminateWorkflowExecution'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'domain': domain,
      'workflowId': workflowId,
      if (childPolicy != null) 'childPolicy': childPolicy.toValue(),
      if (details != null) 'details': details,
      if (reason != null) 'reason': reason,
      if (runId != null) 'runId': runId,
    },
  );
}