« blib/lib/Paws/LexModelsV2/WaitAndContinueSpecification.pm
↑ Summary
blib/lib/Paws/LexRuntime/ActiveContextParametersMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexRuntime::ActiveContext; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Parameters => (is => 'ro', isa => 'Paws::LexRuntime::ActiveContextParametersMap', request_name => 'parameters', traits => ['NameInRequest'], required => 1); | ||
| 6 | has TimeToLive => (is => 'ro', isa => 'Paws::LexRuntime::ActiveContextTimeToLive', request_name => 'timeToLive', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::LexRuntime::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::LexRuntime::ActiveContext object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $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::LexRuntime::ActiveContext object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A context is a variable that contains information about the current | ||
| 39 | state of the conversation between a user and Amazon Lex. Context can be | ||
| 40 | set automatically by Amazon Lex when an intent is fulfilled, or it can | ||
| 41 | be set at runtime using the C<PutContent>, C<PutText>, or C<PutSession> | ||
| 42 | operation. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> Name => Str | ||
| 48 | |||
| 49 | The name of the context. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Parameters => L<Paws::LexRuntime::ActiveContextParametersMap> | ||
| 53 | |||
| 54 | State variables for the current context. You can use these values as | ||
| 55 | default values for slots in subsequent events. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> TimeToLive => L<Paws::LexRuntime::ActiveContextTimeToLive> | ||
| 59 | |||
| 60 | The length of time or number of turns that a context remains active. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head1 SEE ALSO | ||
| 65 | |||
| 66 | This class forms part of L<Paws>, describing an object used in L<Paws::LexRuntime> | ||
| 67 | |||
| 68 | =head1 BUGS and CONTRIBUTIONS | ||
| 69 | |||
| 70 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 71 | |||
| 72 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 73 | |||
| 74 | =cut | ||
| 75 |