VerifyDomainIdentityCommand

Suggest an Edit

Adds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains  in the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

Example Syntax

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

import { SESClient, VerifyDomainIdentityCommand } from "@aws-sdk/client-ses"; // ES Modules import
// const { SESClient, VerifyDomainIdentityCommand } = require("@aws-sdk/client-ses"); // CommonJS import
const client = new SESClient(config);
const input = { // VerifyDomainIdentityRequest
  Domain: "STRING_VALUE", // required
};
const command = new VerifyDomainIdentityCommand(input);
const response = await client.send(command);
// { // VerifyDomainIdentityResponse
//   VerificationToken: "STRING_VALUE", // required
// };

Example Usage

 There was an error loading the code editor. Retry

VerifyDomainIdentityCommand Input

See VerifyDomainIdentityCommandInput for more details

Parameter
Type
Description
Domain
Required
string | undefined

The domain to be verified.

VerifyDomainIdentityCommand Output

See VerifyDomainIdentityCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
VerificationToken
Required
string | undefined

A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.

As Amazon SES searches for the TXT record, the domain's verification status is "Pending". When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, to verify the domain, you must restart the verification process from the beginning. The domain's verification status also changes to "Success" when it is DKIM verified.

Throws

Name
Fault
Details
SESServiceException
Base exception class for all service exceptions from SES service.