UpdateCustomVerificationEmailTemplateCommand

Suggest an Edit

Updates an existing custom verification email template.

For more information about 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, UpdateCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, UpdateCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // UpdateCustomVerificationEmailTemplateRequest
  TemplateName: "STRING_VALUE", // required
  FromEmailAddress: "STRING_VALUE", // required
  TemplateSubject: "STRING_VALUE", // required
  TemplateContent: "STRING_VALUE", // required
  SuccessRedirectionURL: "STRING_VALUE", // required
  FailureRedirectionURL: "STRING_VALUE", // required
};
const command = new UpdateCustomVerificationEmailTemplateCommand(input);
const response = await client.send(command);
// {};

UpdateCustomVerificationEmailTemplateCommand Input

See UpdateCustomVerificationEmailTemplateCommandInput for more details

Parameter
Type
Description
FailureRedirectionURL
Required
string | undefined

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

FromEmailAddress
Required
string | undefined

The email address that the custom verification email is sent from.

SuccessRedirectionURL
Required
string | undefined

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

TemplateContent
Required
string | undefined

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom verification email frequently asked questions  in the Amazon SES Developer Guide.

TemplateName
Required
string | undefined

The name of the custom verification email template that you want to update.

TemplateSubject
Required
string | undefined

The subject line of the custom verification email.

UpdateCustomVerificationEmailTemplateCommand Output

See UpdateCustomVerificationEmailTemplateCommandOutput for details

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

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

NotFoundException
client

The resource you attempted to access doesn't exist.

TooManyRequestsException
client

Too many requests have been made to the operation.

SESv2ServiceException
Base exception class for all service exceptions from SESv2 service.