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.Types.SMSMessageActivity

Description

Documentation

data SMSMessageActivity Source #

Specifies the settings for an SMS activity in a journey. This type of activity sends a text message to participants.

See: newSMSMessageActivity smart constructor.

Constructors

SMSMessageActivity'

Fields

templateName :: Maybe Text
The name of the SMS message 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 SMS 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.
nextActivity :: Maybe Text
The unique identifier for the next activity to perform, after the message is sent.
messageConfig :: Maybe JourneySMSMessage
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

Instances

Instances details

Eq SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods (==) :: SMSMessageActivity -> SMSMessageActivity -> Bool # (/=) :: SMSMessageActivity -> SMSMessageActivity -> Bool #
Read SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods readsPrec :: Int -> ReadS SMSMessageActivity # readList :: ReadS [SMSMessageActivity] # readPrec :: ReadPrec SMSMessageActivity # readListPrec :: ReadPrec [SMSMessageActivity] #
Show SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods showsPrec :: Int -> SMSMessageActivity -> ShowS # show :: SMSMessageActivity -> String # showList :: [SMSMessageActivity] -> ShowS #
Generic SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Associated Types type Rep SMSMessageActivity :: Type -> Type # Methods from :: SMSMessageActivity -> Rep SMSMessageActivity x # to :: Rep SMSMessageActivity x -> SMSMessageActivity #
NFData SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods rnf :: SMSMessageActivity -> () #
Hashable SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods hashWithSalt :: Int -> SMSMessageActivity -> Int # hash :: SMSMessageActivity -> Int #
ToJSON SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods toJSON :: SMSMessageActivity -> Value # toEncoding :: SMSMessageActivity -> Encoding # toJSONList :: [SMSMessageActivity] -> Value # toEncodingList :: [SMSMessageActivity] -> Encoding #
FromJSON SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity Methods parseJSON :: Value -> Parser SMSMessageActivity # parseJSONList :: Value -> Parser [SMSMessageActivity] #
type Rep SMSMessageActivity Source #
Instance details Defined in Amazonka.Pinpoint.Types.SMSMessageActivity type Rep SMSMessageActivity = D1 ('MetaData "SMSMessageActivity" "Amazonka.Pinpoint.Types.SMSMessageActivity" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SMSMessageActivity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "templateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JourneySMSMessage)))))

newSMSMessageActivity :: SMSMessageActivity Source #

Create a value of SMSMessageActivity 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:templateName:SMSMessageActivity', sMSMessageActivity_templateName - The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.

$sel:templateVersion:SMSMessageActivity', sMSMessageActivity_templateVersion - The unique identifier for the version of the SMS 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.

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

$sel:messageConfig:SMSMessageActivity', sMSMessageActivity_messageConfig - Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.

sMSMessageActivity_templateName :: Lens' SMSMessageActivity (Maybe Text) Source #

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

sMSMessageActivity_templateVersion :: Lens' SMSMessageActivity (Maybe Text) Source #

The unique identifier for the version of the SMS 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.

sMSMessageActivity_nextActivity :: Lens' SMSMessageActivity (Maybe Text) Source #

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

sMSMessageActivity_messageConfig :: Lens' SMSMessageActivity (Maybe JourneySMSMessage) Source #

Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.