DeleteUserCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, DeleteUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, DeleteUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // DeleteUserRequest
  OrganizationId: "STRING_VALUE", // required
  UserId: "STRING_VALUE", // required
};
const command = new DeleteUserCommand(input);
const response = await client.send(command);
// {};

DeleteUserCommand Input

See DeleteUserCommandInput for more details

Parameter
Type
Description
OrganizationId
Required
string | undefined

The organization that contains the user to be deleted.

UserId
Required
string | undefined

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

DeleteUserCommand Output

See DeleteUserCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
DirectoryServiceAuthenticationFailedException
client

The directory service doesn't recognize the credentials supplied by WorkMail.

DirectoryUnavailableException
client

The directory is unavailable. It might be located in another Region or deleted.

EntityStateException
client

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

OrganizationNotFoundException
client

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

UnsupportedOperationException
client

You can't perform a write operation against a read-only directory.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.