TestRenderEmailTemplate
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 Syntax
POST /v2/email/templates/TemplateName/render HTTP/1.1
Content-type: application/json
{
"TemplateData": "string"
}URI Request Parameters
The request uses the following URI parameters.
- TemplateName
-
The name of the template.
Length Constraints: Minimum length of 1.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- 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
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"RenderedTemplate": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- RenderedTemplate
-
The complete MIME message rendered by applying the data in the
TemplateDataparameter 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.
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- NotFoundException
-
The resource you attempted to access doesn't exist.
HTTP Status Code: 404
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
