libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.UpdatePushTemplate

Description

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

Synopsis

Creating a Request

data UpdatePushTemplate Source #

See: newUpdatePushTemplate smart constructor.

Constructors

UpdatePushTemplate' 

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.

  • pushNotificationTemplateRequest :: PushNotificationTemplateRequest
     

Instances

Instances details
Eq UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Read UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Show UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Generic UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type Rep UpdatePushTemplate :: Type -> Type #

NFData UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Methods

rnf :: UpdatePushTemplate -> () #

Hashable UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

ToJSON UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

AWSRequest UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type AWSResponse UpdatePushTemplate #

ToHeaders UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

ToPath UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

ToQuery UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplate = D1 ('MetaData "UpdatePushTemplate" "Amazonka.Pinpoint.UpdatePushTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "UpdatePushTemplate'" '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 "pushNotificationTemplateRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PushNotificationTemplateRequest))))
type AWSResponse UpdatePushTemplate Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

newUpdatePushTemplate Source #

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:version: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.

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

$sel:templateName: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_version :: Lens' UpdatePushTemplate (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.

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

updatePushTemplate_templateName :: Lens' UpdatePushTemplate 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 UpdatePushTemplateResponse Source #

See: newUpdatePushTemplateResponse smart constructor.

Constructors

UpdatePushTemplateResponse' 

Fields

Instances

Instances details
Eq UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Read UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Show UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Generic UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

Associated Types

type Rep UpdatePushTemplateResponse :: Type -> Type #

NFData UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplateResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.UpdatePushTemplate

type Rep UpdatePushTemplateResponse = D1 ('MetaData "UpdatePushTemplateResponse" "Amazonka.Pinpoint.UpdatePushTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" '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 Source #

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