AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.


For .NET Core and PCL this operation is only available in asynchronous form. Please refer to RegisterToWorkMailAsync.

Namespace: Amazon.WorkMail
Assembly: AWSSDK.WorkMail.dll
Version: 3.x.y.z


public abstract RegisterToWorkMailResponse RegisterToWorkMail(
         RegisterToWorkMailRequest request
Type: Amazon.WorkMail.Model.RegisterToWorkMailRequest

Container for the necessary parameters to execute the RegisterToWorkMail service method.

Return Value
The response from the RegisterToWorkMail service method, as returned by WorkMail.


DirectoryServiceAuthenticationFailedException The Directory Service doesn't recognize the credentials supplied by the Amazon WorkMail service.
DirectoryUnavailableException The directory that you are trying to perform operations on isn't available.
EmailAddressInUseException The email address that you're trying to assign is already created for a different user, group, or resource.
EntityAlreadyRegisteredException The user, group, or resource that you're trying to register is already registered.
EntityNotFoundException The identifier supplied for the entity is valid, but it does not exist in your organization.
EntityStateException You are performing an operation on an entity that isn't in the expected state, such as trying to update a deleted user.
InvalidParameterException One or more of the input parameters don't match the service's restrictions.
MailDomainNotFoundException For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.
MailDomainStateException After a domain has been added to the organization, it must be verified. The domain is not yet verified.
OrganizationNotFoundException An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its entities.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also