libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.TestRenderTemplate

Description

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.

Synopsis

Creating a Request

data TestRenderTemplate Source #

See: newTestRenderTemplate smart constructor.

Constructors

TestRenderTemplate' 

Fields

  • templateName :: Text

    The name of the template that you want to render.

  • templateData :: Text

    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.

Instances

Instances details
Eq TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

(==) :: TestRenderTemplate -> TestRenderTemplate -> Bool #

(/=) :: TestRenderTemplate -> TestRenderTemplate -> Bool #

Read TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

readsPrec :: Int -> ReadS TestRenderTemplate #

readList :: ReadS [TestRenderTemplate] #

readPrec :: ReadPrec TestRenderTemplate #

readListPrec :: ReadPrec [TestRenderTemplate] #

Show TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

showsPrec :: Int -> TestRenderTemplate -> ShowS #

show :: TestRenderTemplate -> String #

showList :: [TestRenderTemplate] -> ShowS #

Generic TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Associated Types

type Rep TestRenderTemplate :: Type -> Type #

Methods

from :: TestRenderTemplate -> Rep TestRenderTemplate x #

to :: Rep TestRenderTemplate x -> TestRenderTemplate #

NFData TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

rnf :: TestRenderTemplate -> () #

Hashable TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

hashWithSalt :: Int -> TestRenderTemplate -> Int #

hash :: TestRenderTemplate -> Int #

AWSRequest TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Associated Types

type AWSResponse TestRenderTemplate #

Methods

request :: TestRenderTemplate -> Request TestRenderTemplate #

response :: MonadResource m => Logger -> Service -> Proxy TestRenderTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestRenderTemplate))) #

ToHeaders TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

toHeaders :: TestRenderTemplate -> [Header] #

ToPath TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

toPath :: TestRenderTemplate -> ByteString #

ToQuery TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

toQuery :: TestRenderTemplate -> QueryString #

type Rep TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

type Rep TestRenderTemplate = D1 ('MetaData "TestRenderTemplate" "Amazonka.SES.TestRenderTemplate" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "TestRenderTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse TestRenderTemplate Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

type AWSResponse TestRenderTemplate = TestRenderTemplateResponse

newTestRenderTemplate Source #

Arguments

:: Text

$sel:templateName:TestRenderTemplate'

-> Text

$sel:templateData:TestRenderTemplate'

-> TestRenderTemplate 

Create a value of TestRenderTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:templateName:TestRenderTemplate', testRenderTemplate_templateName - The name of the template that you want to render.

$sel:templateData:TestRenderTemplate', testRenderTemplate_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.

Request Lenses

testRenderTemplate_templateName :: Lens' TestRenderTemplate Text Source #

The name of the template that you want to render.

testRenderTemplate_templateData :: Lens' TestRenderTemplate Text Source #

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.

Destructuring the Response

data TestRenderTemplateResponse Source #

See: newTestRenderTemplateResponse smart constructor.

Constructors

TestRenderTemplateResponse' 

Fields

  • renderedTemplate :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

(==) :: TestRenderTemplateResponse -> TestRenderTemplateResponse -> Bool #

(/=) :: TestRenderTemplateResponse -> TestRenderTemplateResponse -> Bool #

Read TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

readsPrec :: Int -> ReadS TestRenderTemplateResponse #

readList :: ReadS [TestRenderTemplateResponse] #

readPrec :: ReadPrec TestRenderTemplateResponse #

readListPrec :: ReadPrec [TestRenderTemplateResponse] #

Show TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

showsPrec :: Int -> TestRenderTemplateResponse -> ShowS #

show :: TestRenderTemplateResponse -> String #

showList :: [TestRenderTemplateResponse] -> ShowS #

Generic TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Associated Types

type Rep TestRenderTemplateResponse :: Type -> Type #

Methods

from :: TestRenderTemplateResponse -> Rep TestRenderTemplateResponse x #

to :: Rep TestRenderTemplateResponse x -> TestRenderTemplateResponse #

NFData TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

Methods

rnf :: TestRenderTemplateResponse -> () #

type Rep TestRenderTemplateResponse Source # 
Instance details

Defined in Amazonka.SES.TestRenderTemplate

type Rep TestRenderTemplateResponse = D1 ('MetaData "TestRenderTemplateResponse" "Amazonka.SES.TestRenderTemplate" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "TestRenderTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "renderedTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestRenderTemplateResponse Source #

Arguments

:: Int

$sel:httpStatus:TestRenderTemplateResponse'

-> TestRenderTemplateResponse 

Create a value of TestRenderTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:renderedTemplate:TestRenderTemplateResponse', testRenderTemplateResponse_renderedTemplate - The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

$sel:httpStatus:TestRenderTemplateResponse', testRenderTemplateResponse_httpStatus - The response's http status code.

Response Lenses

testRenderTemplateResponse_renderedTemplate :: Lens' TestRenderTemplateResponse (Maybe Text) Source #

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

testRenderTemplateResponse_httpStatus :: Lens' TestRenderTemplateResponse Int Source #

The response's http status code.