[ aws . workmail ]



Lists the mail domains in a given Amazon WorkMail organization.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--organization-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--organization-id (string)

The Amazon WorkMail organization for which to list domains.

--max-results (integer)

The maximum number of results to return in a single call.

--next-token (string)

The token to use to retrieve the next page of results. The first call does not require a token.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


MailDomains -> (list)

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


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.