« blib/lib/Paws/LexRuntimeV2/AccessDeniedException.pm
↑ Summary
blib/lib/Paws/LexRuntimeV2/ActiveContextParametersMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexRuntimeV2::ActiveContext; | ||
| 3 | use Moose; | ||
| 4 | has ContextAttributes => (is => 'ro', isa => 'Paws::LexRuntimeV2::ActiveContextParametersMap', request_name => 'contextAttributes', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 6 | has TimeToLive => (is => 'ro', isa => 'Paws::LexRuntimeV2::ActiveContextTimeToLive', request_name => 'timeToLive', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LexRuntimeV2::ActiveContext | ||
| 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::ActiveContext object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ContextAttributes => $value, ..., TimeToLive => $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::ActiveContext object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ContextAttributes | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Contains information about the contexts that a user is using in a | ||
| 39 | session. You can configure Amazon Lex V2 to set a context when an | ||
| 40 | intent is fulfilled, or you can set a context using the , , or | ||
| 41 | operations. | ||
| 42 | |||
| 43 | Use a context to indicate to Amazon Lex V2 intents that should be used | ||
| 44 | as follow-up intents. For example, if the active context is | ||
| 45 | C<order-fulfilled>, only intents that have C<order-fulfilled> | ||
| 46 | configured as a trigger are considered for follow up. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> ContextAttributes => L<Paws::LexRuntimeV2::ActiveContextParametersMap> | ||
| 52 | |||
| 53 | A lis tof contexts active for the request. A context can be activated | ||
| 54 | when a previous intent is fulfilled, or by including the context in the | ||
| 55 | request. | ||
| 56 | |||
| 57 | If you don't specify a list of contexts, Amazon Lex will use the | ||
| 58 | current list of contexts for the session. If you specify an empty list, | ||
| 59 | all contexts for the session are cleared. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> Name => Str | ||
| 63 | |||
| 64 | The name of the context. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> TimeToLive => L<Paws::LexRuntimeV2::ActiveContextTimeToLive> | ||
| 68 | |||
| 69 | Indicates the number of turns or seconds that the context is active. | ||
| 70 | Once the time to live expires, the context is no longer returned in a | ||
| 71 | response. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntimeV2> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |