Amazon WorkMail
API Reference (API Version 2017-10-01)


Remove the alias from a set of aliases for a given user.

Request Syntax

{ "Alias": "string", "EntityId": "string", "OrganizationId": "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.


The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 254.

Pattern: [a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

Required: Yes


The identifier for the Amazon WorkMail entity to have the aliases removed.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: Yes


The identifier for the organization under which the user exists.

Type: String

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


The identifier supplied for the entity is valid, but it does not exist in your organization.

HTTP Status Code: 400


You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted user.

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 400


The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: