« blib/lib/Paws/LexRuntimeV2/PlaybackCompletionEvent.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/PutSession.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexRuntimeV2::PlaybackInterruptionEvent; | ||
| 3 | use Moose; | ||
| 4 | has CausedByEventId => (is => 'ro', isa => 'Str', request_name => 'causedByEventId', traits => ['NameInRequest']); | ||
| 5 | has EventId => (is => 'ro', isa => 'Str', request_name => 'eventId', traits => ['NameInRequest']); | ||
| 6 | has EventReason => (is => 'ro', isa => 'Str', request_name => 'eventReason', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LexRuntimeV2::PlaybackInterruptionEvent | ||
| 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::LexRuntimeV2::PlaybackInterruptionEvent object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { CausedByEventId => $value, ..., EventReason => $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::LexRuntimeV2::PlaybackInterruptionEvent object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->CausedByEventId | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Event sent from Amazon Lex V2 to indicate to the client application | ||
| 39 | should stop playback of audio. For example, if the client is playing a | ||
| 40 | prompt that asks for the user's telephone number, the user might start | ||
| 41 | to say the phone number before the prompt is complete. Amazon Lex V2 | ||
| 42 | sends this event to the client application to indicate that the user is | ||
| 43 | responding and that Amazon Lex V2 is processing their input. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CausedByEventId => Str | ||
| 49 | |||
| 50 | The identifier of the event that contained the audio, DTMF, or text | ||
| 51 | that caused the interruption. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 EventId => Str | ||
| 55 | |||
| 56 | A unique identifier of the event sent by Amazon Lex V2. The identifier | ||
| 57 | is in the form C<RESPONSE-N>, where N is a number starting with one and | ||
| 58 | incremented for each event sent by Amazon Lex V2 in the current | ||
| 59 | session. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 EventReason => Str | ||
| 63 | |||
| 64 | Indicates the type of user input that Amazon Lex V2 detected. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntimeV2> | ||
| 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 |