UpdateDefaultMailDomainCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkMailClient, UpdateDefaultMailDomainCommand } from "@aws-sdk/client-workmail"; // ES Modules import
// const { WorkMailClient, UpdateDefaultMailDomainCommand } = require("@aws-sdk/client-workmail"); // CommonJS import
const client = new WorkMailClient(config);
const input = { // UpdateDefaultMailDomainRequest
  OrganizationId: "STRING_VALUE", // required
  DomainName: "STRING_VALUE", // required
};
const command = new UpdateDefaultMailDomainCommand(input);
const response = await client.send(command);
// {};

UpdateDefaultMailDomainCommand Input

See UpdateDefaultMailDomainCommandInput for more details

Parameter
Type
Description
DomainName
Required
string | undefined

The domain name that will become the default domain.

OrganizationId
Required
string | undefined

The WorkMail organization for which to list domains.

UpdateDefaultMailDomainCommand Output

See UpdateDefaultMailDomainCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidParameterException
client

One or more of the input parameters don't match the service's restrictions.

MailDomainNotFoundException
client

The domain specified is not found in your organization.

MailDomainStateException
client

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

OrganizationNotFoundException
client

An operation received a valid organization identifier that either doesn't belong or exist in the system.

OrganizationStateException
client

The organization must have a valid state to perform certain operations on the organization or its members.

WorkMailServiceException
Base exception class for all service exceptions from WorkMail service.