Amazonka.Pinpoint.UpdatePushTemplate

Updates an existing message template for messages that are sent through a push notification channel.

Creating a Request

data UpdatePushTemplate

See: newUpdatePushTemplate smart constructor.

Constructors

UpdatePushTemplate'

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.

• pushNotificationTemplateRequest :: PushNotificationTemplateRequest

Instances

ToJSON UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

toJSON :: UpdatePushTemplate -> Value

toEncoding :: UpdatePushTemplate -> Encoding

toJSONList :: [UpdatePushTemplate] -> Value

toEncodingList :: [UpdatePushTemplate] -> Encoding

ToHeaders UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

toHeaders :: UpdatePushTemplate -> [Header]

ToPath UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

toPath :: UpdatePushTemplate -> ByteString

ToQuery UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

toQuery :: UpdatePushTemplate -> QueryString

AWSRequest UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type AWSResponse UpdatePushTemplate

Methods

request :: (Service -> Service) -> UpdatePushTemplate -> Request UpdatePushTemplate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePushTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePushTemplate)))

Generic UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type Rep UpdatePushTemplate :: Type -> Type

Methods

from :: UpdatePushTemplate -> Rep UpdatePushTemplate x

to :: Rep UpdatePushTemplate x -> UpdatePushTemplate

Read UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

readsPrec :: Int -> ReadS UpdatePushTemplate

readList :: ReadS [UpdatePushTemplate]

readPrec :: ReadPrec UpdatePushTemplate

readListPrec :: ReadPrec [UpdatePushTemplate]

Show UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

showsPrec :: Int -> UpdatePushTemplate -> ShowS

show :: UpdatePushTemplate -> String

showList :: [UpdatePushTemplate] -> ShowS

NFData UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

rnf :: UpdatePushTemplate -> ()

Eq UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

(==) :: UpdatePushTemplate -> UpdatePushTemplate -> Bool

(/=) :: UpdatePushTemplate -> UpdatePushTemplate -> Bool

Hashable UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

hashWithSalt :: Int -> UpdatePushTemplate -> Int

hash :: UpdatePushTemplate -> Int

type AWSResponse UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type AWSResponse UpdatePushTemplate = UpdatePushTemplateResponse

type Rep UpdatePushTemplate

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplate = D1 ('MetaData "UpdatePushTemplate" "Amazonka.Pinpoint.UpdatePushTemplate" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "UpdatePushTemplate'" '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 "pushNotificationTemplateRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PushNotificationTemplateRequest))))

newUpdatePushTemplate

Arguments

:: Text

UpdatePushTemplate

-> PushNotificationTemplateRequest

$sel:pushNotificationTemplateRequest:UpdatePushTemplate'

-> UpdatePushTemplate

Create a value of UpdatePushTemplate 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:UpdatePushTemplate', updatePushTemplate_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.

UpdatePushTemplate, updatePushTemplate_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.

UpdatePushTemplate, updatePushTemplate_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:pushNotificationTemplateRequest:UpdatePushTemplate', updatePushTemplate_pushNotificationTemplateRequest - Undocumented member.

Request Lenses

updatePushTemplate_createNewVersion :: Lens' UpdatePushTemplate (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.

updatePushTemplate_version :: Lens' UpdatePushTemplate (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.

updatePushTemplate_templateName :: Lens' UpdatePushTemplate 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.

updatePushTemplate_pushNotificationTemplateRequest :: Lens' UpdatePushTemplate PushNotificationTemplateRequest

Undocumented member.

Destructuring the Response

data UpdatePushTemplateResponse

See: newUpdatePushTemplateResponse smart constructor.

Constructors

UpdatePushTemplateResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• messageBody :: MessageBody

Instances

Generic UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type Rep UpdatePushTemplateResponse :: Type -> Type

Methods

from :: UpdatePushTemplateResponse -> Rep UpdatePushTemplateResponse x

to :: Rep UpdatePushTemplateResponse x -> UpdatePushTemplateResponse

Read UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

readsPrec :: Int -> ReadS UpdatePushTemplateResponse

readList :: ReadS [UpdatePushTemplateResponse]

readPrec :: ReadPrec UpdatePushTemplateResponse

readListPrec :: ReadPrec [UpdatePushTemplateResponse]

Show UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

showsPrec :: Int -> UpdatePushTemplateResponse -> ShowS

show :: UpdatePushTemplateResponse -> String

showList :: [UpdatePushTemplateResponse] -> ShowS

NFData UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

rnf :: UpdatePushTemplateResponse -> ()

Eq UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

(==) :: UpdatePushTemplateResponse -> UpdatePushTemplateResponse -> Bool

(/=) :: UpdatePushTemplateResponse -> UpdatePushTemplateResponse -> Bool

type Rep UpdatePushTemplateResponse

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplateResponse = D1 ('MetaData "UpdatePushTemplateResponse" "Amazonka.Pinpoint.UpdatePushTemplate" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "UpdatePushTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "messageBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MessageBody)))

newUpdatePushTemplateResponse

Arguments

:: Int

$sel:httpStatus:UpdatePushTemplateResponse'

-> MessageBody

$sel:messageBody:UpdatePushTemplateResponse'

-> UpdatePushTemplateResponse

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

$sel:messageBody:UpdatePushTemplateResponse', updatePushTemplateResponse_messageBody - Undocumented member.

Response Lenses

updatePushTemplateResponse_httpStatus :: Lens' UpdatePushTemplateResponse Int

The response's http status code.

updatePushTemplateResponse_messageBody :: Lens' UpdatePushTemplateResponse MessageBody

Undocumented member.