Amazonka.Pinpoint.Types.SMSMessage

Documentation

data SMSMessage

Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

See: newSMSMessage smart constructor.

Constructors

SMSMessage'

Fields

• body :: Maybe Text

  The body of the SMS message.

• entityId :: Maybe Text

  The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

• keyword :: Maybe Text

  The SMS program name that you provided to AWS Support when you requested your dedicated number.

• mediaUrl :: Maybe Text

  This field is reserved for future use.

• messageType :: Maybe MessageType

  The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

• originationNumber :: Maybe Text

  The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

• senderId :: Maybe Text

  The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

• substitutions :: Maybe (HashMap Text [Text])

  The message variables to use in the SMS message. You can override the default variables with individual address variables.

• templateId :: Maybe Text

  The template ID received from the regulatory body for sending SMS in your country.

Instances

ToJSON SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

toJSON :: SMSMessage -> Value

toEncoding :: SMSMessage -> Encoding

toJSONList :: [SMSMessage] -> Value

toEncodingList :: [SMSMessage] -> Encoding

Generic SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Associated Types

type Rep SMSMessage :: Type -> Type

Methods

from :: SMSMessage -> Rep SMSMessage x

to :: Rep SMSMessage x -> SMSMessage

Read SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

readsPrec :: Int -> ReadS SMSMessage

readList :: ReadS [SMSMessage]

readPrec :: ReadPrec SMSMessage

readListPrec :: ReadPrec [SMSMessage]

Show SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

showsPrec :: Int -> SMSMessage -> ShowS

show :: SMSMessage -> String

showList :: [SMSMessage] -> ShowS

NFData SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

rnf :: SMSMessage -> ()

Eq SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

(==) :: SMSMessage -> SMSMessage -> Bool

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

Hashable SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

Methods

hashWithSalt :: Int -> SMSMessage -> Int

hash :: SMSMessage -> Int

type Rep SMSMessage

Defined in Amazonka.Pinpoint.Types.SMSMessage

type Rep SMSMessage = D1 ('MetaData "SMSMessage" "Amazonka.Pinpoint.Types.SMSMessage" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SMSMessage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "keyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mediaUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "substitutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newSMSMessage :: SMSMessage

Create a value of SMSMessage 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:body:SMSMessage', sMSMessage_body - The body of the SMS message.

$sel:entityId:SMSMessage', sMSMessage_entityId - The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

$sel:keyword:SMSMessage', sMSMessage_keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

$sel:mediaUrl:SMSMessage', sMSMessage_mediaUrl - This field is reserved for future use.

$sel:messageType:SMSMessage', sMSMessage_messageType - The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

$sel:originationNumber:SMSMessage', sMSMessage_originationNumber - The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

$sel:senderId:SMSMessage', sMSMessage_senderId - The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

$sel:substitutions:SMSMessage', sMSMessage_substitutions - The message variables to use in the SMS message. You can override the default variables with individual address variables.

$sel:templateId:SMSMessage', sMSMessage_templateId - The template ID received from the regulatory body for sending SMS in your country.

sMSMessage_body :: Lens' SMSMessage (Maybe Text)

The body of the SMS message.

sMSMessage_entityId :: Lens' SMSMessage (Maybe Text)

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

sMSMessage_keyword :: Lens' SMSMessage (Maybe Text)

The SMS program name that you provided to AWS Support when you requested your dedicated number.

sMSMessage_mediaUrl :: Lens' SMSMessage (Maybe Text)

This field is reserved for future use.

sMSMessage_messageType :: Lens' SMSMessage (Maybe MessageType)

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

sMSMessage_originationNumber :: Lens' SMSMessage (Maybe Text)

The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

sMSMessage_senderId :: Lens' SMSMessage (Maybe Text)

The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

sMSMessage_substitutions :: Lens' SMSMessage (Maybe (HashMap Text [Text]))

The message variables to use in the SMS message. You can override the default variables with individual address variables.

sMSMessage_templateId :: Lens' SMSMessage (Maybe Text)

The template ID received from the regulatory body for sending SMS in your country.