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.UpdateEmailTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing message template for messages that are sent through the email channel.

Synopsis

data UpdateEmailTemplate = UpdateEmailTemplate' {
- version :: Maybe Text
- createNewVersion :: Maybe Bool
- templateName :: Text
- emailTemplateRequest :: EmailTemplateRequest
}
newUpdateEmailTemplate :: Text -> EmailTemplateRequest -> UpdateEmailTemplate
updateEmailTemplate_version :: Lens' UpdateEmailTemplate (Maybe Text)
updateEmailTemplate_createNewVersion :: Lens' UpdateEmailTemplate (Maybe Bool)
updateEmailTemplate_templateName :: Lens' UpdateEmailTemplate Text
updateEmailTemplate_emailTemplateRequest :: Lens' UpdateEmailTemplate EmailTemplateRequest
data UpdateEmailTemplateResponse = UpdateEmailTemplateResponse' {
- httpStatus :: Int
- messageBody :: MessageBody
}
newUpdateEmailTemplateResponse :: Int -> MessageBody -> UpdateEmailTemplateResponse
updateEmailTemplateResponse_httpStatus :: Lens' UpdateEmailTemplateResponse Int
updateEmailTemplateResponse_messageBody :: Lens' UpdateEmailTemplateResponse MessageBody

Creating a Request

data UpdateEmailTemplate Source #

See: newUpdateEmailTemplate smart constructor.

Constructors

UpdateEmailTemplate'

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.
createNewVersion :: Maybe Bool
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
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.
emailTemplateRequest :: EmailTemplateRequest

Instances

Instances details

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

newUpdateEmailTemplate Source #

Arguments

:: Text	`$sel:templateName:UpdateEmailTemplate'`
-> EmailTemplateRequest	`$sel:emailTemplateRequest:UpdateEmailTemplate'`
-> UpdateEmailTemplate

Create a value of UpdateEmailTemplate 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:UpdateEmailTemplate', updateEmailTemplate_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:createNewVersion:UpdateEmailTemplate', updateEmailTemplate_createNewVersion - Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

$sel:templateName:UpdateEmailTemplate', updateEmailTemplate_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.

$sel:emailTemplateRequest:UpdateEmailTemplate', updateEmailTemplate_emailTemplateRequest - Undocumented member.

Request Lenses

updateEmailTemplate_version :: Lens' UpdateEmailTemplate (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.

updateEmailTemplate_createNewVersion :: Lens' UpdateEmailTemplate (Maybe Bool) Source #

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

updateEmailTemplate_templateName :: Lens' UpdateEmailTemplate 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.

updateEmailTemplate_emailTemplateRequest :: Lens' UpdateEmailTemplate EmailTemplateRequest Source #

Undocumented member.

Destructuring the Response

data UpdateEmailTemplateResponse Source #

See: newUpdateEmailTemplateResponse smart constructor.

Constructors

UpdateEmailTemplateResponse'
Fields httpStatus :: Int The response's http status code. messageBody :: MessageBody

Instances

Instances details

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

newUpdateEmailTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEmailTemplateResponse'`
-> MessageBody	`$sel:messageBody:UpdateEmailTemplateResponse'`
-> UpdateEmailTemplateResponse

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

$sel:messageBody:UpdateEmailTemplateResponse', updateEmailTemplateResponse_messageBody - Undocumented member.

Response Lenses

updateEmailTemplateResponse_httpStatus :: Lens' UpdateEmailTemplateResponse Int Source #

The response's http status code.

updateEmailTemplateResponse_messageBody :: Lens' UpdateEmailTemplateResponse MessageBody Source #

Undocumented member.