deleteUser method
Deletes a user from Amazon WorkMail and all subsequent systems. Before you
can delete a user, the user state must be DISABLED
. Use the
DescribeUser action to confirm the user state.
Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.
May throw DirectoryServiceAuthenticationFailedException. May throw DirectoryUnavailableException. May throw EntityStateException. May throw InvalidParameterException. May throw OrganizationNotFoundException. May throw OrganizationStateException. May throw UnsupportedOperationException.
Parameter organizationId
:
The organization that contains the user to be deleted.
Parameter userId
:
The identifier of the user to be deleted.
Implementation
Future<void> deleteUser({
required String organizationId,
required String userId,
}) async {
ArgumentError.checkNotNull(organizationId, 'organizationId');
_s.validateStringLength(
'organizationId',
organizationId,
34,
34,
isRequired: true,
);
ArgumentError.checkNotNull(userId, 'userId');
_s.validateStringLength(
'userId',
userId,
12,
256,
isRequired: true,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'WorkMailService.DeleteUser'
};
await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'OrganizationId': organizationId,
'UserId': userId,
},
);
}