« blib/lib/Paws/LexRuntime/GenericAttachment.pm
↑ Summary
blib/lib/Paws/LexRuntime/GetSessionResponse.pm »
| 1 | |||
| 2 | package Paws::LexRuntime::GetSession; | ||
| 3 | use Moose; | ||
| 4 | has BotAlias => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botAlias', required => 1); | ||
| 5 | has BotName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botName', required => 1); | ||
| 6 | has CheckpointLabelFilter => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'checkpointLabelFilter'); | ||
| 7 | has UserId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'userId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSession'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bot/{botName}/alias/{botAlias}/user/{userId}/session/'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexRuntime::GetSessionResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LexRuntime::GetSession - Arguments for method GetSession on L<Paws::LexRuntime> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetSession on the | ||
| 26 | L<Amazon Lex Runtime Service|Paws::LexRuntime> service. Use the attributes of this class | ||
| 27 | as arguments to method GetSession. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSession. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $runtime.lex = Paws->service('LexRuntime'); | ||
| 34 | my $GetSessionResponse = $runtime . lex->GetSession( | ||
| 35 | BotAlias => 'MyBotAlias', | ||
| 36 | BotName => 'MyBotName', | ||
| 37 | UserId => 'MyUserId', | ||
| 38 | CheckpointLabelFilter => 'MyIntentSummaryCheckpointLabel', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ActiveContexts = $GetSessionResponse->ActiveContexts; | ||
| 43 | my $DialogAction = $GetSessionResponse->DialogAction; | ||
| 44 | my $RecentIntentSummaryView = $GetSessionResponse->RecentIntentSummaryView; | ||
| 45 | my $SessionAttributes = $GetSessionResponse->SessionAttributes; | ||
| 46 | my $SessionId = $GetSessionResponse->SessionId; | ||
| 47 | |||
| 48 | # Returns a L<Paws::LexRuntime::GetSessionResponse> object. | ||
| 49 | |||
| 50 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/runtime.lex/GetSession> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> BotAlias => Str | ||
| 57 | |||
| 58 | The alias in use for the bot that contains the session data. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> BotName => Str | ||
| 63 | |||
| 64 | The name of the bot that contains the session data. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 CheckpointLabelFilter => Str | ||
| 69 | |||
| 70 | A string used to filter the intents returned in the | ||
| 71 | C<recentIntentSummaryView> structure. | ||
| 72 | |||
| 73 | When you specify a filter, only intents with their C<checkpointLabel> | ||
| 74 | field set to that string are returned. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> UserId => Str | ||
| 79 | |||
| 80 | The ID of the client application user. Amazon Lex uses this to identify | ||
| 81 | a user's conversation with your bot. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method GetSession in L<Paws::LexRuntime> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |