update_primary_email_address

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

Request Syntax

response = client.update_primary_email_address(
    OrganizationId='string',
    EntityId='string',
    Email='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

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

• EntityId (string) --

  [REQUIRED]

  The user, group, or resource to update.

• Email (string) --

  [REQUIRED]

  The value of the email to be updated as primary.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException
• WorkMail.Client.exceptions.DirectoryUnavailableException
• WorkMail.Client.exceptions.EmailAddressInUseException
• WorkMail.Client.exceptions.EntityNotFoundException
• WorkMail.Client.exceptions.EntityStateException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.MailDomainNotFoundException
• WorkMail.Client.exceptions.MailDomainStateException
• WorkMail.Client.exceptions.InvalidParameterException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException
• WorkMail.Client.exceptions.UnsupportedOperationException