GetMailDomain
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
Gets details for a mail domain, including domain records required to configure your domain with recommended security.
Request Syntax
{
"DomainName": "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.
- DomainName
-
The domain from which you want to retrieve details.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 209.
Pattern:
[a-zA-Z0-9.-]+Required: Yes
- OrganizationId
-
The WorkMail organization for which the domain is retrieved.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"DkimVerificationStatus": "string",
"IsDefault": boolean,
"IsTestDomain": boolean,
"OwnershipVerificationStatus": "string",
"Records": [
{
"Hostname": "string",
"Type": "string",
"Value": "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.
- DkimVerificationStatus
-
Indicates the status of a DKIM verification.
Type: String
Valid Values:
PENDING | VERIFIED | FAILED - IsDefault
-
Specifies whether the domain is the default domain for your organization.
Type: Boolean
- IsTestDomain
-
Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
Type: Boolean
- OwnershipVerificationStatus
-
Indicates the status of the domain ownership verification.
Type: String
Valid Values:
PENDING | VERIFIED | FAILED - Records
-
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.
Type: Array of DnsRecord objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidParameterException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- MailDomainNotFoundException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
The domain specified is not found in your organization.
HTTP Status Code: 400
- OrganizationNotFoundException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
Important
End of support notice: On March 31, 2027, AWS will end support for Amazon WorkMail. After March 31, 2027, you will no longer be able to access the WorkMail console or WorkMail resources. For more information, see Amazon WorkMail end of support.
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:
