- 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.
TestRenderEmailTemplateCommand
Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.
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, TestRenderEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import
// const { SESv2Client, TestRenderEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import
const client = new SESv2Client(config);
const input = { // TestRenderEmailTemplateRequest
TemplateName: "STRING_VALUE", // required
TemplateData: "STRING_VALUE", // required
};
const command = new TestRenderEmailTemplateCommand(input);
const response = await client.send(command);
// { // TestRenderEmailTemplateResponse
// RenderedTemplate: "STRING_VALUE", // required
// };
TestRenderEmailTemplateCommand Input
See TestRenderEmailTemplateCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
TemplateDataRequired | string | undefined | A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template. |
TemplateNameRequired | string | undefined | The name of the template. |
TestRenderEmailTemplateCommand Output
See TestRenderEmailTemplateCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
RenderedTemplateRequired | string | undefined | The complete MIME message rendered by applying the data in the |
Throws
Name | Fault | Details |
|---|
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. |