Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pinpoint.UpdateSmsTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpdateSmsTemplate = UpdateSmsTemplate' {
- createNewVersion :: Maybe Bool
- version :: Maybe Text
- templateName :: Text
- sMSTemplateRequest :: SMSTemplateRequest
}
newUpdateSmsTemplate :: Text -> SMSTemplateRequest -> UpdateSmsTemplate
updateSmsTemplate_createNewVersion :: Lens' UpdateSmsTemplate (Maybe Bool)
updateSmsTemplate_version :: Lens' UpdateSmsTemplate (Maybe Text)
updateSmsTemplate_templateName :: Lens' UpdateSmsTemplate Text
updateSmsTemplate_sMSTemplateRequest :: Lens' UpdateSmsTemplate SMSTemplateRequest
data UpdateSmsTemplateResponse = UpdateSmsTemplateResponse' {
- httpStatus :: Int
- messageBody :: MessageBody
}
newUpdateSmsTemplateResponse :: Int -> MessageBody -> UpdateSmsTemplateResponse
updateSmsTemplateResponse_httpStatus :: Lens' UpdateSmsTemplateResponse Int
updateSmsTemplateResponse_messageBody :: Lens' UpdateSmsTemplateResponse MessageBody

Creating a Request

data UpdateSmsTemplate Source #

See: newUpdateSmsTemplate smart constructor.

Constructors

UpdateSmsTemplate'

Fields

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.
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.
sMSTemplateRequest :: SMSTemplateRequest

Instances

Instances details

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

newUpdateSmsTemplate Source #

Arguments

:: Text	`UpdateSmsTemplate`
-> SMSTemplateRequest	`$sel:sMSTemplateRequest:UpdateSmsTemplate'`
-> UpdateSmsTemplate

Create a value of UpdateSmsTemplate 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:createNewVersion:UpdateSmsTemplate', updateSmsTemplate_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.

UpdateSmsTemplate, updateSmsTemplate_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.

UpdateSmsTemplate, updateSmsTemplate_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:sMSTemplateRequest:UpdateSmsTemplate', updateSmsTemplate_sMSTemplateRequest - Undocumented member.

Request Lenses

updateSmsTemplate_createNewVersion :: Lens' UpdateSmsTemplate (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.

updateSmsTemplate_version :: Lens' UpdateSmsTemplate (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.

updateSmsTemplate_templateName :: Lens' UpdateSmsTemplate 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.

updateSmsTemplate_sMSTemplateRequest :: Lens' UpdateSmsTemplate SMSTemplateRequest Source #

Undocumented member.

Destructuring the Response

data UpdateSmsTemplateResponse Source #

See: newUpdateSmsTemplateResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateSmsTemplateResponse Source #

Arguments

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

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

$sel:messageBody:UpdateSmsTemplateResponse', updateSmsTemplateResponse_messageBody - Undocumented member.

Response Lenses

updateSmsTemplateResponse_httpStatus :: Lens' UpdateSmsTemplateResponse Int Source #

The response's http status code.

updateSmsTemplateResponse_messageBody :: Lens' UpdateSmsTemplateResponse MessageBody Source #

Undocumented member.