File Coverage

blib/lib/Paws/LexModels/Prompt.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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