:doc:`WorkMail <../../workmail>` / Client / register_to_work_mail

*********************
register_to_work_mail
*********************



.. py:method:: WorkMail.Client.register_to_work_mail(**kwargs)

  

  Registers an existing and disabled user, group, or resource for WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see `Pricing <https://aws.amazon.com/workmail/pricing>`__. The equivalent console functionality for this operation is *Enable*.

   

  Users can either be created by calling the  CreateUser API operation or they can be synchronized from your directory. For more information, see  DeregisterFromWorkMail.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail>`_  


  **Request Syntax**
  ::

    response = client.register_to_work_mail(
        OrganizationId='string',
        EntityId='string',
        Email='string'
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The identifier for the organization under which the user, group, or resource exists.

    

  
  :type EntityId: string
  :param EntityId: **[REQUIRED]** 

    The identifier for the user, group, or resource to be updated.

     

    The identifier can accept *UserId, ResourceId, or GroupId*, or *Username, Resourcename, or Groupname*. The following identity formats are available:

     

    
    * Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
     
    * Entity name: entity
    

    

  
  :type Email: string
  :param Email: **[REQUIRED]** 

    The email for the user, group, or resource to be updated.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException`

  
  *   :py:class:`WorkMail.Client.exceptions.DirectoryUnavailableException`

  
  *   :py:class:`WorkMail.Client.exceptions.EmailAddressInUseException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityAlreadyRegisteredException`

  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`WorkMail.Client.exceptions.MailDomainNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.MailDomainStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.UnsupportedOperationException`

  