- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
SendCustomVerificationEmailCommand
Adds an email address to the list of identities for your Amazon SES account in the current Amazon Web Services Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.
To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using custom verification email templates 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 { SESv2Client, SendCustomVerificationEmailCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, SendCustomVerificationEmailCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // SendCustomVerificationEmailRequest
EmailAddress: "STRING_VALUE", // required
TemplateName: "STRING_VALUE", // required
ConfigurationSetName: "STRING_VALUE",
};
const command = new SendCustomVerificationEmailCommand(input);
const response = await client.send(command);
// { // SendCustomVerificationEmailResponse
// MessageId: "STRING_VALUE",
// };
SendCustomVerificationEmailCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
EmailAddressRequired | string | undefined | The email address to verify. |
TemplateNameRequired | string | undefined | The name of the custom verification email template to use when sending the verification email. |
ConfigurationSetName | string | undefined | Name of a configuration set to use when sending the verification email. |
SendCustomVerificationEmailCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
MessageId | string | undefined | The unique message identifier returned from the |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | The input you provided is invalid. |
| LimitExceededException | client | There are too many instances of the specified resource type. |
| MailFromDomainNotVerifiedException | client | The message can't be sent because the sending domain isn't verified. |
| MessageRejected | client | The message can't be sent because it contains invalid content. |
| NotFoundException | client | The resource you attempted to access doesn't exist. |
| SendingPausedException | client | The message can't be sent because the account's ability to send email is currently paused. |
| TooManyRequestsException | client | Too many requests have been made to the operation. |
| SESv2ServiceException | Base exception class for all service exceptions from SESv2 service. |