| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexModels::Prompt; | ||
| 3 | use Moose; | ||
| 4 | has MaxAttempts => (is => 'ro', isa => 'Int', request_name => 'maxAttempts', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Messages => (is => 'ro', isa => 'ArrayRef[Paws::LexModels::Message]', request_name => 'messages', traits => ['NameInRequest'], required => 1); | ||
| 6 | has ResponseCard => (is => 'ro', isa => 'Str', request_name => 'responseCard', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LexModels::Prompt | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::LexModels::Prompt object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { MaxAttempts => $value, ..., ResponseCard => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::LexModels::Prompt object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->MaxAttempts | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Obtains information from the user. To define a prompt, provide one or | ||
| 39 | more messages and specify the number of attempts to get information | ||
| 40 | from the user. If you provide more than one message, Amazon Lex chooses | ||
| 41 | one of the messages to use to prompt the user. For more information, | ||
| 42 | see how-it-works. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> MaxAttempts => Int | ||
| 48 | |||
| 49 | The number of times to prompt the user for information. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Messages => ArrayRef[L<Paws::LexModels::Message>] | ||
| 53 | |||
| 54 | An array of objects, each of which provides a message string and its | ||
| 55 | type. You can specify the message string in plain text or in Speech | ||
| 56 | Synthesis Markup Language (SSML). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ResponseCard => Str | ||
| 60 | |||
| 61 | A response card. Amazon Lex uses this prompt at runtime, in the | ||
| 62 | C<PostText> API response. It substitutes session attributes and slot | ||
| 63 | values for placeholders in the response card. For more information, see | ||
| 64 | ex-resp-card. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::LexModels> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |