Amazon Simple Email Service
API Reference (API Version 2010-12-01)

TestRenderTemplate

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TemplateData

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.

Type: String

Length Constraints: Maximum length of 262144.

Required: Yes

TemplateName

The name of the template that you want to render.

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

RenderedTemplate

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRenderingParameter

Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

HTTP Status Code: 400

MissingRenderingAttribute

Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

HTTP Status Code: 400

TemplateDoesNotExist

Indicates that the Template object you specified does not exist in your Amazon SES account.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: