delete_user

WorkMail.Client.delete_user(**kwargs)

Deletes a user from 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.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    OrganizationId='string',
    UserId='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The organization that contains the user to be deleted.

• UserId (string) --

  [REQUIRED]

  The identifier of the user to be deleted.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException
• WorkMail.Client.exceptions.DirectoryUnavailableException
• WorkMail.Client.exceptions.EntityStateException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException
• WorkMail.Client.exceptions.UnsupportedOperationException