WorkMail / Client / get_mail_domain

get_mail_domain#

WorkMail.Client.get_mail_domain(**kwargs)#

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

See also: AWS API Documentation

Request Syntax

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

  • OrganizationId (string) –

    [REQUIRED]

    The WorkMail organization for which the domain is retrieved.

  • DomainName (string) –

    [REQUIRED]

    The domain from which you want to retrieve details.

Return type:

dict

Returns:

Response Syntax

{
    'Records': [
        {
            'Type': 'string',
            'Hostname': 'string',
            'Value': 'string'
        },
    ],
    'IsTestDomain': True|False,
    'IsDefault': True|False,
    'OwnershipVerificationStatus': 'PENDING'|'VERIFIED'|'FAILED',
    'DkimVerificationStatus': 'PENDING'|'VERIFIED'|'FAILED'
}

Response Structure

  • (dict) –

    • Records (list) –

      A list of the DNS records that WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming email traffic to SES. See admin guide for more details.

      • (dict) –

        A DNS record uploaded to your DNS provider.

        • Type (string) –

          The RFC 1035 record type. Possible values: CNAME, A, MX.

        • Hostname (string) –

          The DNS hostname.- For example, domain.example.com.

        • Value (string) –

          The value returned by the DNS for a query to that hostname and record type.

    • IsTestDomain (boolean) –

      Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.

    • IsDefault (boolean) –

      Specifies whether the domain is the default domain for your organization.

    • OwnershipVerificationStatus (string) –

      Indicates the status of the domain ownership verification.

    • DkimVerificationStatus (string) –

      Indicates the status of a DKIM verification.

Exceptions

  • WorkMail.Client.exceptions.MailDomainNotFoundException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.InvalidParameterException