« blib/lib/Paws/Pinpoint/SMSMessageActivity.pm
↑ Summary
blib/lib/Paws/Pinpoint/SMSTemplateResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::SMSTemplateRequest; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str'); | ||
| 5 | has DefaultSubstitutions => (is => 'ro', isa => 'Str'); | ||
| 6 | has RecommenderId => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 8 | has TemplateDescription => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Pinpoint::SMSTemplateRequest | ||
| 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::SMSTemplateRequest object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Body => $value, ..., TemplateDescription => $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::SMSTemplateRequest object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Body | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the content and settings for a message template that can be | ||
| 41 | used in text messages that are sent through the SMS channel. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Body => Str | ||
| 47 | |||
| 48 | The message body to use in text messages that are based on the message | ||
| 49 | template. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DefaultSubstitutions => Str | ||
| 53 | |||
| 54 | A JSON object that specifies the default values to use for message | ||
| 55 | variables in the message template. This object is a set of key-value | ||
| 56 | pairs. Each key defines a message variable in the template. The | ||
| 57 | corresponding value defines the default value for that variable. When | ||
| 58 | you create a message that's based on the template, you can override | ||
| 59 | these defaults with message-specific and address-specific variables and | ||
| 60 | values. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 RecommenderId => Str | ||
| 64 | |||
| 65 | The unique identifier for the recommender model to use for the message | ||
| 66 | template. Amazon Pinpoint uses this value to determine how to retrieve | ||
| 67 | and process data from a recommender model when it sends messages that | ||
| 68 | use the template, if the template contains message variables for | ||
| 69 | recommendation data. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 73 | |||
| 74 | A string-to-string map of key-value pairs that defines the tags to | ||
| 75 | associate with the message template. Each tag consists of a required | ||
| 76 | tag key and an associated tag value. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 TemplateDescription => Str | ||
| 80 | |||
| 81 | A custom description of the message template. | ||
| 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 |