WorkMail / Client / register_mail_domain

register_mail_domain#

WorkMail.Client.register_mail_domain(**kwargs)#

Registers a new domain in WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has permanent permission to use the specified domain for sending your users’ emails.

See also: AWS API Documentation

Request Syntax

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

  • ClientToken (string) –

    Idempotency token used when retrying requests.

    This field is autopopulated if not provided.

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization under which you’re creating the domain.

  • DomainName (string) –

    [REQUIRED]

    The name of the mail domain to create 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.LimitExceededException

  • WorkMail.Client.exceptions.InvalidParameterException