WorkMail / Client / deregister_mail_domain

deregister_mail_domain#

WorkMail.Client.deregister_mail_domain(**kwargs)#

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

See also: AWS API Documentation

Request Syntax

response = client.deregister_mail_domain(
    OrganizationId='string',
    DomainName='string'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization for which the domain will be deregistered.

  • DomainName (string) –

    [REQUIRED]

    The domain to deregister in WorkMail and SES.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkMail.Client.exceptions.MailDomainInUseException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.InvalidCustomSesConfigurationException