« blib/lib/Paws/Pinpoint/SMSChannelResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/SMSMessageActivity.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::SMSMessage; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str'); | ||
| 5 | has EntityId => (is => 'ro', isa => 'Str'); | ||
| 6 | has Keyword => (is => 'ro', isa => 'Str'); | ||
| 7 | has MediaUrl => (is => 'ro', isa => 'Str'); | ||
| 8 | has MessageType => (is => 'ro', isa => 'Str'); | ||
| 9 | has OriginationNumber => (is => 'ro', isa => 'Str'); | ||
| 10 | has SenderId => (is => 'ro', isa => 'Str'); | ||
| 11 | has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string'); | ||
| 12 | has TemplateId => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::SMSMessage | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Pinpoint::SMSMessage object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Body => $value, ..., TemplateId => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::SMSMessage object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Body | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Specifies the default settings for a one-time SMS message that's sent | ||
| 45 | directly to an endpoint. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Body => Str | ||
| 51 | |||
| 52 | The body of the SMS message. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 EntityId => Str | ||
| 56 | |||
| 57 | The entity ID or Principal Entity (PE) id received from the regulatory | ||
| 58 | body for sending SMS in your country. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Keyword => Str | ||
| 62 | |||
| 63 | The SMS program name that you provided to AWS Support when you | ||
| 64 | requested your dedicated number. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 MediaUrl => Str | ||
| 68 | |||
| 69 | This field is reserved for future use. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 MessageType => Str | ||
| 73 | |||
| 74 | The SMS message type. Valid values are TRANSACTIONAL (for messages that | ||
| 75 | are critical or time-sensitive, such as a one-time passwords) and | ||
| 76 | PROMOTIONAL (for messsages that aren't critical or time-sensitive, such | ||
| 77 | as marketing messages). | ||
| 78 | |||
| 79 | |||
| 80 | =head2 OriginationNumber => Str | ||
| 81 | |||
| 82 | The number to send the SMS message from. This value should be one of | ||
| 83 | the dedicated long or short codes that's assigned to your AWS account. | ||
| 84 | If you don't specify a long or short code, Amazon Pinpoint assigns a | ||
| 85 | random long code to the SMS message and sends the message from that | ||
| 86 | code. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 SenderId => Str | ||
| 90 | |||
| 91 | The sender ID to display as the sender of the message on a recipient's | ||
| 92 | device. Support for sender IDs varies by country or region. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string> | ||
| 96 | |||
| 97 | The message variables to use in the SMS message. You can override the | ||
| 98 | default variables with individual address variables. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 TemplateId => Str | ||
| 102 | |||
| 103 | The template ID received from the regulatory body for sending SMS in | ||
| 104 | your country. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |