DeregisterMailDomainCommand

Suggest an Edit

Removes a domain from WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first remove any email address used by WorkMail entities before you remove the domain.

Example Syntax

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

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

DeregisterMailDomainCommand Input

See DeregisterMailDomainCommandInput for more details

Parameter
Type
Description
DomainName
Required
string | undefined

The domain to deregister in WorkMail and SES.

OrganizationId
Required
string | undefined

The WorkMail organization for which the domain will be deregistered.

DeregisterMailDomainCommand Output

See DeregisterMailDomainCommandOutput for details

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

Throws

Name
Fault
Details
InvalidCustomSesConfigurationException
client

You SES configuration has customizations that WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to CreateReceiptRule .

InvalidParameterException
client

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

MailDomainInUseException
client

The domain you're trying to change is in use by another user or organization in your account. See the error message for details.

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.