signalWorkflowExecution method

Future<void> signalWorkflowExecution({ required String domain, required String signalName, required String workflowId, String? input, String? runId, })

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided). 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 name of the domain containing the workflow execution to signal.

Parameter signalName : The name of the signal. This name must be meaningful to the target workflow.

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

Parameter input : Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

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

Implementation

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