UpdateDefaultMailDomain - Amazon WorkMail

UpdateDefaultMailDomain

Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.

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 name that will become the default domain.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 209.

Pattern: [a-zA-Z0-9.-]+\.[a-zA-Z-]{2,}

Required: Yes

OrganizationId

The Amazon WorkMail organization for which to list domains.

Type: String

Length Constraints: Fixed length of 34.

Pattern: ^m-[0-9a-f]{32}$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

MailDomainNotFoundException

The domain specified is not found in your organization.

HTTP Status Code: 400

MailDomainStateException

After a domain has been added to the organization, it must be verified. The domain is not yet verified.

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: