« blib/lib/Paws/Pinpoint/EmailTemplateRequest.pm
↑ Summary
blib/lib/Paws/Pinpoint/EndpointBatchItem.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EmailTemplateResponse; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreationDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DefaultSubstitutions => (is => 'ro', isa => 'Str'); | ||
| 7 | has HtmlPart => (is => 'ro', isa => 'Str'); | ||
| 8 | has LastModifiedDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has RecommenderId => (is => 'ro', isa => 'Str'); | ||
| 10 | has Subject => (is => 'ro', isa => 'Str'); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 12 | has TemplateDescription => (is => 'ro', isa => 'Str'); | ||
| 13 | has TemplateName => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has TemplateType => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | has TextPart => (is => 'ro', isa => 'Str'); | ||
| 16 | has Version => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Pinpoint::EmailTemplateResponse | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Pinpoint::EmailTemplateResponse object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { Arn => $value, ..., Version => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EmailTemplateResponse object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->Arn | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Provides information about the content and settings for a message | ||
| 49 | template that can be used in messages that are sent through the email | ||
| 50 | channel. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Arn => Str | ||
| 56 | |||
| 57 | The Amazon Resource Name (ARN) of the message template. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> CreationDate => Str | ||
| 61 | |||
| 62 | The date, in ISO 8601 format, when the message template was created. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DefaultSubstitutions => Str | ||
| 66 | |||
| 67 | The JSON object that specifies the default values that are used for | ||
| 68 | message variables in the message template. This object is a set of | ||
| 69 | key-value pairs. Each key defines a message variable in the template. | ||
| 70 | The corresponding value defines the default value for that variable. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 HtmlPart => Str | ||
| 74 | |||
| 75 | The message body, in HTML format, that's used in email messages that | ||
| 76 | are based on the message template. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> LastModifiedDate => Str | ||
| 80 | |||
| 81 | The date, in ISO 8601 format, when the message template was last | ||
| 82 | modified. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 RecommenderId => Str | ||
| 86 | |||
| 87 | The unique identifier for the recommender model that's used by the | ||
| 88 | message template. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Subject => Str | ||
| 92 | |||
| 93 | The subject line, or title, that's used in email messages that are | ||
| 94 | based on the message template. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 98 | |||
| 99 | A string-to-string map of key-value pairs that identifies the tags that | ||
| 100 | are associated with the message template. Each tag consists of a | ||
| 101 | required tag key and an associated tag value. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 TemplateDescription => Str | ||
| 105 | |||
| 106 | The custom description of the message template. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> TemplateName => Str | ||
| 110 | |||
| 111 | The name of the message template. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> TemplateType => Str | ||
| 115 | |||
| 116 | The type of channel that the message template is designed for. For an | ||
| 117 | email template, this value is EMAIL. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 TextPart => Str | ||
| 121 | |||
| 122 | The message body, in plain text format, that's used in email messages | ||
| 123 | that are based on the message template. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Version => Str | ||
| 127 | |||
| 128 | The unique identifier, as an integer, for the active version of the | ||
| 129 | message template, or the version of the template that you specified by | ||
| 130 | using the version parameter in your request. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |