list_mail_domains

WorkMail.Client.list_mail_domains(**kwargs)

Lists the mail domains in a given WorkMail organization.

See also: AWS API Documentation

Request Syntax

response = client.list_mail_domains(
    OrganizationId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• OrganizationId (string) --

  [REQUIRED]

  The WorkMail organization for which to list domains.

• MaxResults (integer) -- The maximum number of results to return in a single call.
• NextToken (string) -- The token to use to retrieve the next page of results. The first call does not require a token.

Return type

dict

Returns

Response Syntax

{
    'MailDomains': [
        {
            'DomainName': 'string',
            'DefaultDomain': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • MailDomains (list) --

    The list of mail domain summaries, specifying domains that exist in the specified WorkMail organization, along with the information about whether the domain is or isn't the default.

    • (dict) --

      The data for a given domain.

      • DomainName (string) --

        The domain name.

      • DefaultDomain (boolean) --

        Whether the domain is default or not.

  • NextToken (string) --

    The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.

Exceptions

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