« blib/lib/Paws/Pinpoint/VoiceMessage.pm
↑ Summary
blib/lib/Paws/Pinpoint/VoiceTemplateResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::VoiceTemplateRequest; | ||
| 3 | use Moose; | ||
| 4 | has Body => (is => 'ro', isa => 'Str'); | ||
| 5 | has DefaultSubstitutions => (is => 'ro', isa => 'Str'); | ||
| 6 | has LanguageCode => (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 | has VoiceId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Pinpoint::VoiceTemplateRequest | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Pinpoint::VoiceTemplateRequest object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Body => $value, ..., VoiceId => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::VoiceTemplateRequest object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Body | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Specifies the content and settings for a message template that can be | ||
| 42 | used in messages that are sent through the voice channel. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Body => Str | ||
| 48 | |||
| 49 | The text of the script to use in messages that are based on the message | ||
| 50 | template, in plain text format. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 DefaultSubstitutions => Str | ||
| 54 | |||
| 55 | A JSON object that specifies the default values to use for message | ||
| 56 | variables in the message template. This object is a set of key-value | ||
| 57 | pairs. Each key defines a message variable in the template. The | ||
| 58 | corresponding value defines the default value for that variable. When | ||
| 59 | you create a message that's based on the template, you can override | ||
| 60 | these defaults with message-specific and address-specific variables and | ||
| 61 | values. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 LanguageCode => Str | ||
| 65 | |||
| 66 | The code for the language to use when synthesizing the text of the | ||
| 67 | script in messages that are based on the message template. For a list | ||
| 68 | of supported languages and the code for each one, see the Amazon Polly | ||
| 69 | Developer Guide | ||
| 70 | (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). | ||
| 71 | |||
| 72 | |||
| 73 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 74 | |||
| 75 | A string-to-string map of key-value pairs that defines the tags to | ||
| 76 | associate with the message template. Each tag consists of a required | ||
| 77 | tag key and an associated tag value. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 TemplateDescription => Str | ||
| 81 | |||
| 82 | A custom description of the message template. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 VoiceId => Str | ||
| 86 | |||
| 87 | The name of the voice to use when delivering messages that are based on | ||
| 88 | the message template. For a list of supported voices, see the Amazon | ||
| 89 | Polly Developer Guide | ||
| 90 | (https://docs.aws.amazon.com/polly/latest/dg/what-is.html). | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |