update_default_mail_domain

update_default_mail_domain(**kwargs)

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

See also: AWS API Documentation

Request Syntax

response = client.update_default_mail_domain(
    OrganizationId='string',
    DomainName='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The WorkMail organization for which to list domains.

• DomainName (string) --

  [REQUIRED]

  The domain name that will become the default domain.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• WorkMail.Client.exceptions.MailDomainNotFoundException
• WorkMail.Client.exceptions.MailDomainStateException
• WorkMail.Client.exceptions.OrganizationNotFoundException
• WorkMail.Client.exceptions.OrganizationStateException
• WorkMail.Client.exceptions.InvalidParameterException