File Coverage

blib/lib/Paws/WorkDocs/DescribeUsers.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::WorkDocs::DescribeUsers;
3 1     1   532 use Moose;
  1         4  
  1         14  
4             has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication' );
5             has Fields => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'fields' );
6             has Include => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'include' );
7             has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit' );
8             has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker' );
9             has Order => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'order' );
10             has OrganizationId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'organizationId' );
11             has Query => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'query' );
12             has Sort => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'sort' );
13             has UserIds => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'userIds' );
14              
15 1     1   6852 use MooseX::ClassAttribute;
  1         4  
  1         15  
16              
17             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeUsers');
18             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/users');
19             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DescribeUsersResponse');
21             class_has _result_key => (isa => 'Str', is => 'ro');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::WorkDocs::DescribeUsers - Arguments for method DescribeUsers on Paws::WorkDocs
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method DescribeUsers on the
33             Amazon WorkDocs service. Use the attributes of this class
34             as arguments to method DescribeUsers.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeUsers.
37              
38             As an example:
39              
40             $service_obj->DescribeUsers(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 AuthenticationToken => Str
48              
49             Amazon WorkDocs authentication token. This field should not be set when
50             using administrative API actions, as in accessing the API using AWS
51             credentials.
52              
53              
54              
55             =head2 Fields => Str
56              
57             A comma-separated list of values. Specify "STORAGE_METADATA" to include
58             the user storage quota and utilization information.
59              
60              
61              
62             =head2 Include => Str
63              
64             The state of the users. Specify "ALL" to include inactive users.
65              
66             Valid values are: C<"ALL">, C<"ACTIVE_PENDING">
67              
68             =head2 Limit => Int
69              
70             The maximum number of items to return.
71              
72              
73              
74             =head2 Marker => Str
75              
76             The marker for the next set of results. (You received this marker from
77             a previous call.)
78              
79              
80              
81             =head2 Order => Str
82              
83             The order for the results.
84              
85             Valid values are: C<"ASCENDING">, C<"DESCENDING">
86              
87             =head2 OrganizationId => Str
88              
89             The ID of the organization.
90              
91              
92              
93             =head2 Query => Str
94              
95             A query to filter users by user name.
96              
97              
98              
99             =head2 Sort => Str
100              
101             The sorting criteria.
102              
103             Valid values are: C<"USER_NAME">, C<"FULL_NAME">, C<"STORAGE_LIMIT">, C<"USER_STATUS">, C<"STORAGE_USED">
104              
105             =head2 UserIds => Str
106              
107             The IDs of the users.
108              
109              
110              
111              
112             =head1 SEE ALSO
113              
114             This class forms part of L<Paws>, documenting arguments for method DescribeUsers in L<Paws::WorkDocs>
115              
116             =head1 BUGS and CONTRIBUTIONS
117              
118             The source code is located here: https://github.com/pplu/aws-sdk-perl
119              
120             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
121              
122             =cut
123