Amazonka.Pinpoint.Types.PushMessageActivity

Documentation

data PushMessageActivity

Specifies the settings for a push notification activity in a journey. This type of activity sends a push notification to participants.

See: newPushMessageActivity smart constructor.

Constructors

PushMessageActivity'

Fields

• messageConfig :: Maybe JourneyPushMessage

  Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

• nextActivity :: Maybe Text

  The unique identifier for the next activity to perform, after the message is sent.

• templateName :: Maybe Text

  The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

• templateVersion :: Maybe Text

  The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

  If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Instances

FromJSON PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

parseJSON :: Value -> Parser PushMessageActivity

parseJSONList :: Value -> Parser [PushMessageActivity]

ToJSON PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

toJSON :: PushMessageActivity -> Value

toEncoding :: PushMessageActivity -> Encoding

toJSONList :: [PushMessageActivity] -> Value

toEncodingList :: [PushMessageActivity] -> Encoding

Generic PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Associated Types

type Rep PushMessageActivity :: Type -> Type

Methods

from :: PushMessageActivity -> Rep PushMessageActivity x

to :: Rep PushMessageActivity x -> PushMessageActivity

Read PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

readsPrec :: Int -> ReadS PushMessageActivity

readList :: ReadS [PushMessageActivity]

readPrec :: ReadPrec PushMessageActivity

readListPrec :: ReadPrec [PushMessageActivity]

Show PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

showsPrec :: Int -> PushMessageActivity -> ShowS

show :: PushMessageActivity -> String

showList :: [PushMessageActivity] -> ShowS

NFData PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

rnf :: PushMessageActivity -> ()

Eq PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

(==) :: PushMessageActivity -> PushMessageActivity -> Bool

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

Hashable PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

Methods

hashWithSalt :: Int -> PushMessageActivity -> Int

hash :: PushMessageActivity -> Int

type Rep PushMessageActivity

Defined in Amazonka.Pinpoint.Types.PushMessageActivity

type Rep PushMessageActivity = D1 ('MetaData "PushMessageActivity" "Amazonka.Pinpoint.Types.PushMessageActivity" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "PushMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneyPushMessage)) :*: S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPushMessageActivity :: PushMessageActivity

Create a value of PushMessageActivity 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:messageConfig:PushMessageActivity', pushMessageActivity_messageConfig - Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

$sel:nextActivity:PushMessageActivity', pushMessageActivity_nextActivity - The unique identifier for the next activity to perform, after the message is sent.

$sel:templateName:PushMessageActivity', pushMessageActivity_templateName - The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:PushMessageActivity', pushMessageActivity_templateVersion - The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

pushMessageActivity_messageConfig :: Lens' PushMessageActivity (Maybe JourneyPushMessage)

Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.

pushMessageActivity_nextActivity :: Lens' PushMessageActivity (Maybe Text)

The unique identifier for the next activity to perform, after the message is sent.

pushMessageActivity_templateName :: Lens' PushMessageActivity (Maybe Text)

The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.

pushMessageActivity_templateVersion :: Lens' PushMessageActivity (Maybe Text)

The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.