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

Description

 
Synopsis

Documentation

data CampaignSmsMessage Source #

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

See: newCampaignSmsMessage smart constructor.

Constructors

CampaignSmsMessage' 

Fields

  • originationNumber :: Maybe Text

    The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

  • templateId :: Maybe Text

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

  • body :: Maybe Text

    The body of the SMS message.

  • 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).

  • senderId :: Maybe Text

    The sender ID to display on recipients' devices when they receive 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.

Instances

Instances details
Eq CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

(==) :: CampaignSmsMessage -> CampaignSmsMessage -> Bool #

(/=) :: CampaignSmsMessage -> CampaignSmsMessage -> Bool #

Read CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

readsPrec :: Int -> ReadS CampaignSmsMessage #

readList :: ReadS [CampaignSmsMessage] #

readPrec :: ReadPrec CampaignSmsMessage #

readListPrec :: ReadPrec [CampaignSmsMessage] #

Show CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

showsPrec :: Int -> CampaignSmsMessage -> ShowS #

show :: CampaignSmsMessage -> String #

showList :: [CampaignSmsMessage] -> ShowS #

Generic CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Associated Types

type Rep CampaignSmsMessage :: Type -> Type #

Methods

from :: CampaignSmsMessage -> Rep CampaignSmsMessage x #

to :: Rep CampaignSmsMessage x -> CampaignSmsMessage #

NFData CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

rnf :: CampaignSmsMessage -> () #

Hashable CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

hashWithSalt :: Int -> CampaignSmsMessage -> Int #

hash :: CampaignSmsMessage -> Int #

ToJSON CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

toJSON :: CampaignSmsMessage -> Value #

toEncoding :: CampaignSmsMessage -> Encoding #

toJSONList :: [CampaignSmsMessage] -> Value #

toEncodingList :: [CampaignSmsMessage] -> Encoding #

FromJSON CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

Methods

parseJSON :: Value -> Parser CampaignSmsMessage #

parseJSONList :: Value -> Parser [CampaignSmsMessage] #

type Rep CampaignSmsMessage Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.CampaignSmsMessage

type Rep CampaignSmsMessage = D1 ('MetaData "CampaignSmsMessage" "Amazonka.Pinpoint.Types.CampaignSmsMessage" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "CampaignSmsMessage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "originationNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :*: (S1 ('MetaSel ('Just "senderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCampaignSmsMessage :: CampaignSmsMessage Source #

Create a value of CampaignSmsMessage 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:originationNumber:CampaignSmsMessage', campaignSmsMessage_originationNumber - The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

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

$sel:body:CampaignSmsMessage', campaignSmsMessage_body - The body of the SMS message.

$sel:messageType:CampaignSmsMessage', campaignSmsMessage_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:senderId:CampaignSmsMessage', campaignSmsMessage_senderId - The sender ID to display on recipients' devices when they receive the SMS message.

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

campaignSmsMessage_originationNumber :: Lens' CampaignSmsMessage (Maybe Text) Source #

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

campaignSmsMessage_templateId :: Lens' CampaignSmsMessage (Maybe Text) Source #

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

campaignSmsMessage_body :: Lens' CampaignSmsMessage (Maybe Text) Source #

The body of the SMS message.

campaignSmsMessage_messageType :: Lens' CampaignSmsMessage (Maybe MessageType) Source #

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

campaignSmsMessage_senderId :: Lens' CampaignSmsMessage (Maybe Text) Source #

The sender ID to display on recipients' devices when they receive the SMS message.

campaignSmsMessage_entityId :: Lens' CampaignSmsMessage (Maybe Text) Source #

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