WorkMail / Client / update_primary_email_address

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.

    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

  • 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