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


Registers an existing and disabled user, group, or resource/entity for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the entity is enabled and fails if the entity is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable. Users can either be created by calling the CreateUser API or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

Request Syntax

{ "Email": "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 email for the entity to be updated.

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 entity to be updated.

Type: String

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

Required: Yes


The identifier for the organization under which the Amazon WorkMail entity 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 Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.

HTTP Status Code: 400


The directory that you are trying to perform operations on isn't available.

HTTP Status Code: 400


The email address that you're trying to assign is already created for a different user, group, or resource.

HTTP Status Code: 400


The user, group, or resource that you're trying to register is already registered.

HTTP Status Code: 400


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


For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

HTTP Status Code: 400


After a domain has been added to the organization, it must be verified. The domain is not yet verified.

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: