putRetentionPolicy method

Future<void> putRetentionPolicy({ required List<FolderConfiguration> folderConfigurations, required String name, required String organizationId, String? description, String? id, })

Puts a retention policy to the specified organization.

May throw InvalidParameterException. May throw OrganizationNotFoundException. May throw OrganizationStateException. May throw LimitExceededException.

Parameter folderConfigurations : The retention policy folder configurations.

Parameter name : The retention policy name.

Parameter organizationId : The organization ID.

Parameter description : The retention policy description.

Parameter id : The retention policy ID.

Implementation

Future<void> putRetentionPolicy({
  required List<FolderConfiguration> folderConfigurations,
  required String name,
  required String organizationId,
  String? description,
  String? id,
}) async {
  ArgumentError.checkNotNull(folderConfigurations, 'folderConfigurations');
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    64,
    isRequired: true,
  );
  ArgumentError.checkNotNull(organizationId, 'organizationId');
  _s.validateStringLength(
    'organizationId',
    organizationId,
    34,
    34,
    isRequired: true,
  );
  _s.validateStringLength(
    'description',
    description,
    0,
    256,
  );
  _s.validateStringLength(
    'id',
    id,
    1,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'WorkMailService.PutRetentionPolicy'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'FolderConfigurations': folderConfigurations,
      'Name': name,
      'OrganizationId': organizationId,
      if (description != null) 'Description': description,
      if (id != null) 'Id': id,
    },
  );
}