« blib/lib/Paws/Pinpoint/TemplateConfiguration.pm
↑ Summary
blib/lib/Paws/Pinpoint/TemplateVersionResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::TemplateResponse; | ||
| 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 LastModifiedDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 9 | has TemplateDescription => (is => 'ro', isa => 'Str'); | ||
| 10 | has TemplateName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has TemplateType => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has Version => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::TemplateResponse | ||
| 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::TemplateResponse object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Arn => $value, ..., Version => $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::TemplateResponse object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Arn | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Provides information about a message template that's associated with | ||
| 45 | your Amazon Pinpoint account. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Arn => Str | ||
| 51 | |||
| 52 | The Amazon Resource Name (ARN) of the message template. This value | ||
| 53 | isn't included in a TemplateResponse object. To retrieve the ARN of a | ||
| 54 | template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or | ||
| 55 | GetVoiceTemplate operation, depending on the type of template that you | ||
| 56 | want to retrieve the ARN for. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> CreationDate => Str | ||
| 60 | |||
| 61 | The date, in ISO 8601 format, when the message template was created. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 DefaultSubstitutions => Str | ||
| 65 | |||
| 66 | The JSON object that specifies the default values that are used for | ||
| 67 | message variables in the message template. This object isn't included | ||
| 68 | in a TemplateResponse object. To retrieve this object for a template, | ||
| 69 | use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or | ||
| 70 | GetVoiceTemplate operation, depending on the type of template that you | ||
| 71 | want to retrieve the object for. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> LastModifiedDate => Str | ||
| 75 | |||
| 76 | The date, in ISO 8601 format, when the message template was last | ||
| 77 | modified. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 81 | |||
| 82 | A map of key-value pairs that identifies the tags that are associated | ||
| 83 | with the message template. This object isn't included in a | ||
| 84 | TemplateResponse object. To retrieve this object for a template, use | ||
| 85 | the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or | ||
| 86 | GetVoiceTemplate operation, depending on the type of template that you | ||
| 87 | want to retrieve the object for. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 TemplateDescription => Str | ||
| 91 | |||
| 92 | The custom description of the message template. This value isn't | ||
| 93 | included in a TemplateResponse object. To retrieve the description of a | ||
| 94 | template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or | ||
| 95 | GetVoiceTemplate operation, depending on the type of template that you | ||
| 96 | want to retrieve the description for. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> TemplateName => Str | ||
| 100 | |||
| 101 | The name of the message template. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> TemplateType => Str | ||
| 105 | |||
| 106 | The type of channel that the message template is designed for. Possible | ||
| 107 | values are: EMAIL, PUSH, SMS, and VOICE. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Version => Str | ||
| 111 | |||
| 112 | The unique identifier, as an integer, for the active version of the | ||
| 113 | message template. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |