ListMailDomains
Lists the mail domains in a given WorkMail organization.
Request Syntax
{
"MaxResults": number,
"NextToken": "string",
"OrganizationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The token to use to retrieve the next page of results. The first call does not require a token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S\s]*|[a-zA-Z0-9/+=]{1,1024}Required: No
- OrganizationId
-
The WorkMail organization for which to list domains.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"MailDomains": [
{
"DefaultDomain": boolean,
"DomainName": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MailDomains
-
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.
Type: Array of MailDomainSummary objects
- NextToken
-
The token to use to retrieve the next page of results. The value becomes
nullwhen there are no more results to return.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S\s]*|[a-zA-Z0-9/+=]{1,1024}
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
