File Coverage

blib/lib/Paws/AppStream/DescribeSessions.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::AppStream::DescribeSessions;
3 1     1   729 use Moose;
  1         4  
  1         12  
4             has AuthenticationType => (is => 'ro', isa => 'Str');
5             has FleetName => (is => 'ro', isa => 'Str', required => 1);
6             has Limit => (is => 'ro', isa => 'Int');
7             has NextToken => (is => 'ro', isa => 'Str');
8             has StackName => (is => 'ro', isa => 'Str', required => 1);
9             has UserId => (is => 'ro', isa => 'Str');
10              
11 1     1   9495 use MooseX::ClassAttribute;
  1         3  
  1         12  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSessions');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppStream::DescribeSessionsResult');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::AppStream::DescribeSessions - Arguments for method DescribeSessions on Paws::AppStream
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeSessions on the
27             Amazon AppStream service. Use the attributes of this class
28             as arguments to method DescribeSessions.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSessions.
31              
32             As an example:
33              
34             $service_obj->DescribeSessions(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 AuthenticationType => Str
42              
43             The authentication method of the user. It can be C<API> for a user
44             authenticated using a streaming URL, or C<SAML> for a SAML federated
45             user. If an authentication type is not provided, the operation defaults
46             to users authenticated using a streaming URL.
47              
48             Valid values are: C<"API">, C<"SAML">, C<"USERPOOL">
49              
50             =head2 B<REQUIRED> FleetName => Str
51              
52             The name of the fleet for which to list sessions.
53              
54              
55              
56             =head2 Limit => Int
57              
58             The size of each page of results. The default value is 20 and the
59             maximum supported value is 50.
60              
61              
62              
63             =head2 NextToken => Str
64              
65             The pagination token to use to retrieve the next page of results for
66             this operation. If this value is null, it retrieves the first page.
67              
68              
69              
70             =head2 B<REQUIRED> StackName => Str
71              
72             The name of the stack for which to list sessions.
73              
74              
75              
76             =head2 UserId => Str
77              
78             The user for whom to list sessions. Use null to describe all the
79             sessions for the stack and fleet.
80              
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, documenting arguments for method DescribeSessions in L<Paws::AppStream>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95