deprecateActivityType method

Future<void> deprecateActivityType({ required ActivityType activityType, required String domain, })

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run. 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.
  • activityType.name: String constraint. The key is swf:activityType.name.
  • activityType.version: String constraint. The key is swf:activityType.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 UnknownResourceFault. May throw TypeDeprecatedFault. May throw OperationNotPermittedFault.

Parameter activityType : The activity type to deprecate.

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

Implementation

Future<void> deprecateActivityType({
  required ActivityType activityType,
  required String domain,
}) async {
  ArgumentError.checkNotNull(activityType, 'activityType');
  ArgumentError.checkNotNull(domain, 'domain');
  _s.validateStringLength(
    'domain',
    domain,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.DeprecateActivityType'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'activityType': activityType,
      'domain': domain,
    },
  );
}