SES / Client / test_render_template

test_render_template#

SES.Client.test_render_template(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.test_render_template(
    TemplateName='string',
    TemplateData='string'
)
Parameters:

  • TemplateName (string) –

    [REQUIRED]

    The name of the template to render.

  • TemplateData (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'RenderedTemplate': 'string'
}

Response Structure

  • (dict) –

    • RenderedTemplate (string) –

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

Exceptions