DeleteUser
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.
Request Syntax
{
"OrganizationId": "string",
"UserId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- OrganizationId
-
The organization that contains the user to be deleted.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- UserId
-
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
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectoryServiceAuthenticationFailedException
-
The directory service doesn't recognize the credentials supplied by WorkMail.
HTTP Status Code: 400
- DirectoryUnavailableException
-
The directory is unavailable. It might be located in another Region or deleted.
HTTP Status Code: 400
- EntityStateException
-
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.
HTTP Status Code: 400
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
- UnsupportedOperationException
-
You can't perform a write operation against a read-only directory.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
