deprecateWorkflowType method

Future<void> deprecateWorkflowType({ required String domain, required WorkflowType workflowType, })

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions. 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.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • workflowType.name: String constraint. The key is swf:workflowType.name.
  • workflowType.version: String constraint. The key is swf:workflowType.version.

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 OperationNotPermittedFault. May throw TypeDeprecatedFault. May throw UnknownResourceFault.

Parameter domain : The name of the domain in which the workflow type is registered.

Parameter workflowType : The workflow type to deprecate.

Implementation

Future<void> deprecateWorkflowType({
  required String domain,
  required WorkflowType workflowType,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.DeprecateWorkflowType'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'domain': domain,
      'workflowType': workflowType,
    },
  );
}