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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing message template for messages sent through the in-app message channel.

Synopsis

data UpdateInAppTemplate = UpdateInAppTemplate' {
- version :: Maybe Text
- createNewVersion :: Maybe Bool
- templateName :: Text
- inAppTemplateRequest :: InAppTemplateRequest
}
newUpdateInAppTemplate :: Text -> InAppTemplateRequest -> UpdateInAppTemplate
updateInAppTemplate_version :: Lens' UpdateInAppTemplate (Maybe Text)
updateInAppTemplate_createNewVersion :: Lens' UpdateInAppTemplate (Maybe Bool)
updateInAppTemplate_templateName :: Lens' UpdateInAppTemplate Text
updateInAppTemplate_inAppTemplateRequest :: Lens' UpdateInAppTemplate InAppTemplateRequest
data UpdateInAppTemplateResponse = UpdateInAppTemplateResponse' {
- httpStatus :: Int
- messageBody :: MessageBody
}
newUpdateInAppTemplateResponse :: Int -> MessageBody -> UpdateInAppTemplateResponse
updateInAppTemplateResponse_httpStatus :: Lens' UpdateInAppTemplateResponse Int
updateInAppTemplateResponse_messageBody :: Lens' UpdateInAppTemplateResponse MessageBody

Creating a Request

data UpdateInAppTemplate Source #

See: newUpdateInAppTemplate smart constructor.

Constructors

UpdateInAppTemplate'

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.
inAppTemplateRequest :: InAppTemplateRequest

Instances

Instances details

Eq UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods (==) :: UpdateInAppTemplate -> UpdateInAppTemplate -> Bool # (/=) :: UpdateInAppTemplate -> UpdateInAppTemplate -> Bool #
Read UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods readsPrec :: Int -> ReadS UpdateInAppTemplate # readList :: ReadS [UpdateInAppTemplate] # readPrec :: ReadPrec UpdateInAppTemplate # readListPrec :: ReadPrec [UpdateInAppTemplate] #
Show UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods showsPrec :: Int -> UpdateInAppTemplate -> ShowS # show :: UpdateInAppTemplate -> String # showList :: [UpdateInAppTemplate] -> ShowS #
Generic UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Associated Types type Rep UpdateInAppTemplate :: Type -> Type # Methods from :: UpdateInAppTemplate -> Rep UpdateInAppTemplate x # to :: Rep UpdateInAppTemplate x -> UpdateInAppTemplate #
NFData UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods rnf :: UpdateInAppTemplate -> () #
Hashable UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods hashWithSalt :: Int -> UpdateInAppTemplate -> Int # hash :: UpdateInAppTemplate -> Int #
ToJSON UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods toJSON :: UpdateInAppTemplate -> Value # toEncoding :: UpdateInAppTemplate -> Encoding # toJSONList :: [UpdateInAppTemplate] -> Value # toEncodingList :: [UpdateInAppTemplate] -> Encoding #
AWSRequest UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Associated Types type AWSResponse UpdateInAppTemplate # Methods request :: UpdateInAppTemplate -> Request UpdateInAppTemplate # response :: MonadResource m => Logger -> Service -> Proxy UpdateInAppTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateInAppTemplate))) #
ToHeaders UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods toHeaders :: UpdateInAppTemplate -> [Header] #
ToPath UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods toPath :: UpdateInAppTemplate -> ByteString #
ToQuery UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate Methods toQuery :: UpdateInAppTemplate -> QueryString #
type Rep UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate type Rep UpdateInAppTemplate = D1 ('MetaData "UpdateInAppTemplate" "Amazonka.Pinpoint.UpdateInAppTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "UpdateInAppTemplate'" '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 "inAppTemplateRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InAppTemplateRequest))))
type AWSResponse UpdateInAppTemplate Source #
Instance details Defined in Amazonka.Pinpoint.UpdateInAppTemplate type AWSResponse UpdateInAppTemplate = UpdateInAppTemplateResponse

newUpdateInAppTemplate Source #

Arguments

:: Text	`$sel:templateName:UpdateInAppTemplate'`
-> InAppTemplateRequest	`$sel:inAppTemplateRequest:UpdateInAppTemplate'`
-> UpdateInAppTemplate

Create a value of UpdateInAppTemplate 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:UpdateInAppTemplate', updateInAppTemplate_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:UpdateInAppTemplate', updateInAppTemplate_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:UpdateInAppTemplate', updateInAppTemplate_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:inAppTemplateRequest:UpdateInAppTemplate', updateInAppTemplate_inAppTemplateRequest - Undocumented member.

Request Lenses

updateInAppTemplate_version :: Lens' UpdateInAppTemplate (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.

updateInAppTemplate_createNewVersion :: Lens' UpdateInAppTemplate (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.

updateInAppTemplate_templateName :: Lens' UpdateInAppTemplate 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.

updateInAppTemplate_inAppTemplateRequest :: Lens' UpdateInAppTemplate InAppTemplateRequest Source #

Undocumented member.

Destructuring the Response

data UpdateInAppTemplateResponse Source #

See: newUpdateInAppTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateInAppTemplateResponse Source #

Arguments

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

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

$sel:messageBody:UpdateInAppTemplateResponse', updateInAppTemplateResponse_messageBody - Undocumented member.

Response Lenses

updateInAppTemplateResponse_httpStatus :: Lens' UpdateInAppTemplateResponse Int Source #

The response's http status code.

updateInAppTemplateResponse_messageBody :: Lens' UpdateInAppTemplateResponse MessageBody Source #

Undocumented member.