WorkMail / Client / delete_user

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.

    The identifier can be the UserId or Username. The following identity formats are available:

    • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

    • User name: user

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions