Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.GetEmailTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the content and settings of a message template for messages that are sent through the email channel.

Creating a Request

data GetEmailTemplate Source #

See: newGetEmailTemplate smart constructor.

Constructors

GetEmailTemplate'

Fields

version :: Maybe Text
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
- For a get operation, retrieves information about the active version of the template.
- For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
- For a delete operation, deletes the template, including all versions of the template.
templateName :: Text
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Instances

Instances details

Eq GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods (==) :: GetEmailTemplate -> GetEmailTemplate -> Bool # (/=) :: GetEmailTemplate -> GetEmailTemplate -> Bool #
Read GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods readsPrec :: Int -> ReadS GetEmailTemplate # readList :: ReadS [GetEmailTemplate] # readPrec :: ReadPrec GetEmailTemplate # readListPrec :: ReadPrec [GetEmailTemplate] #
Show GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods showsPrec :: Int -> GetEmailTemplate -> ShowS # show :: GetEmailTemplate -> String # showList :: [GetEmailTemplate] -> ShowS #
Generic GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Associated Types type Rep GetEmailTemplate :: Type -> Type # Methods from :: GetEmailTemplate -> Rep GetEmailTemplate x # to :: Rep GetEmailTemplate x -> GetEmailTemplate #
NFData GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods rnf :: GetEmailTemplate -> () #
Hashable GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods hashWithSalt :: Int -> GetEmailTemplate -> Int # hash :: GetEmailTemplate -> Int #
AWSRequest GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Associated Types type AWSResponse GetEmailTemplate # Methods request :: GetEmailTemplate -> Request GetEmailTemplate # response :: MonadResource m => Logger -> Service -> Proxy GetEmailTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEmailTemplate))) #
ToHeaders GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods toHeaders :: GetEmailTemplate -> [Header] #
ToPath GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods toPath :: GetEmailTemplate -> ByteString #
ToQuery GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods toQuery :: GetEmailTemplate -> QueryString #
type Rep GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate type Rep GetEmailTemplate = D1 ('MetaData "GetEmailTemplate" "Amazonka.Pinpoint.GetEmailTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetEmailTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetEmailTemplate Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate type AWSResponse GetEmailTemplate = GetEmailTemplateResponse

newGetEmailTemplate Source #

Arguments

:: Text	`$sel:templateName:GetEmailTemplate'`
-> GetEmailTemplate

Create a value of GetEmailTemplate 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:version:GetEmailTemplate', getEmailTemplate_version - The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

$sel:templateName:GetEmailTemplate', getEmailTemplate_templateName - The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Request Lenses

getEmailTemplate_version :: Lens' GetEmailTemplate (Maybe Text) Source #

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.

getEmailTemplate_templateName :: Lens' GetEmailTemplate Text Source #

The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Destructuring the Response

data GetEmailTemplateResponse Source #

See: newGetEmailTemplateResponse smart constructor.

Constructors

GetEmailTemplateResponse'
Fields httpStatus :: Int The response's http status code. emailTemplateResponse :: EmailTemplateResponse

Instances

Instances details

Eq GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods (==) :: GetEmailTemplateResponse -> GetEmailTemplateResponse -> Bool # (/=) :: GetEmailTemplateResponse -> GetEmailTemplateResponse -> Bool #
Read GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods readsPrec :: Int -> ReadS GetEmailTemplateResponse # readList :: ReadS [GetEmailTemplateResponse] # readPrec :: ReadPrec GetEmailTemplateResponse # readListPrec :: ReadPrec [GetEmailTemplateResponse] #
Show GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods showsPrec :: Int -> GetEmailTemplateResponse -> ShowS # show :: GetEmailTemplateResponse -> String # showList :: [GetEmailTemplateResponse] -> ShowS #
Generic GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Associated Types type Rep GetEmailTemplateResponse :: Type -> Type # Methods from :: GetEmailTemplateResponse -> Rep GetEmailTemplateResponse x # to :: Rep GetEmailTemplateResponse x -> GetEmailTemplateResponse #
NFData GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate Methods rnf :: GetEmailTemplateResponse -> () #
type Rep GetEmailTemplateResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetEmailTemplate type Rep GetEmailTemplateResponse = D1 ('MetaData "GetEmailTemplateResponse" "Amazonka.Pinpoint.GetEmailTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetEmailTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "emailTemplateResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EmailTemplateResponse)))

newGetEmailTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetEmailTemplateResponse'`
-> EmailTemplateResponse	`$sel:emailTemplateResponse:GetEmailTemplateResponse'`
-> GetEmailTemplateResponse

Create a value of GetEmailTemplateResponse 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:httpStatus:GetEmailTemplateResponse', getEmailTemplateResponse_httpStatus - The response's http status code.

$sel:emailTemplateResponse:GetEmailTemplateResponse', getEmailTemplateResponse_emailTemplateResponse - Undocumented member.

Response Lenses

getEmailTemplateResponse_httpStatus :: Lens' GetEmailTemplateResponse Int Source #

The response's http status code.

getEmailTemplateResponse_emailTemplateResponse :: Lens' GetEmailTemplateResponse EmailTemplateResponse Source #

Undocumented member.