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

****************************
update_primary_email_address
****************************



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

  

  Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

  

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


  **Request Syntax**
  ::

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

    The organization that contains the user, group, or resource to update.

    

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

    The user, group, or resource to update.

     

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

     

    
    * Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234
     
    * Email address: entity@domain.tld
     
    * Entity name: entity
    

    

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

    The value of the email to be updated as primary.

    

  
  
  :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.InvalidParameterException`

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

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

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

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

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

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

  