| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::JourneySMSMessage; | ||
| 3 | use Moose; | ||
| 4 | has EntityId => (is => 'ro', isa => 'Str'); | ||
| 5 | has MessageType => (is => 'ro', isa => 'Str'); | ||
| 6 | has OriginationNumber => (is => 'ro', isa => 'Str'); | ||
| 7 | has SenderId => (is => 'ro', isa => 'Str'); | ||
| 8 | has TemplateId => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Pinpoint::JourneySMSMessage | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Pinpoint::JourneySMSMessage object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { EntityId => $value, ..., TemplateId => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::JourneySMSMessage object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->EntityId | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the sender ID and message type for an SMS message that's sent | ||
| 41 | to participants in a journey. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 EntityId => Str | ||
| 47 | |||
| 48 | The entity ID or Principal Entity (PE) id received from the regulatory | ||
| 49 | body for sending SMS in your country. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 MessageType => Str | ||
| 53 | |||
| 54 | The SMS message type. Valid values are TRANSACTIONAL (for messages that | ||
| 55 | are critical or time-sensitive, such as a one-time passwords) and | ||
| 56 | PROMOTIONAL (for messsages that aren't critical or time-sensitive, such | ||
| 57 | as marketing messages). | ||
| 58 | |||
| 59 | |||
| 60 | =head2 OriginationNumber => Str | ||
| 61 | |||
| 62 | The long code to send the SMS message from. This value should be one of | ||
| 63 | the dedicated long codes that's assigned to your AWS account. Although | ||
| 64 | it isn't required, we recommend that you specify the long code using an | ||
| 65 | E.164 format to ensure prompt and accurate delivery of the message. For | ||
| 66 | example, +12065550100. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 SenderId => Str | ||
| 70 | |||
| 71 | The sender ID to display as the sender of the message on a recipient's | ||
| 72 | device. Support for sender IDs varies by country or region. For more | ||
| 73 | information, see Supported Countries and Regions | ||
| 74 | (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) | ||
| 75 | in the Amazon Pinpoint User Guide. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 TemplateId => Str | ||
| 79 | |||
| 80 | The template ID received from the regulatory body for sending SMS in | ||
| 81 | your country. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |