blib/lib/Paws/WorkDocs/DescribeUsers.pm untested

filter: Statementstmt 0.0% 0 / 30 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 32 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkDocs::DescribeUsers;
3 use Moose;
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 use MooseX::ClassAttribute;
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 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::WorkDocs::DescribeUsers - Arguments for method DescribeUsers on L<Paws::WorkDocs>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method DescribeUsers on the
32 L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class
33 as arguments to method DescribeUsers.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeUsers.
36  
37 =head1 SYNOPSIS
38  
39 my $workdocs = Paws->service('WorkDocs');
40 my $DescribeUsersResponse = $workdocs->DescribeUsers(
41 AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL
42 Fields => 'MyFieldNamesType', # OPTIONAL
43 Include => 'ALL', # OPTIONAL
44 Limit => 1, # OPTIONAL
45 Marker => 'MyPageMarkerType', # OPTIONAL
46 Order => 'ASCENDING', # OPTIONAL
47 OrganizationId => 'MyIdType', # OPTIONAL
48 Query => 'MySearchQueryType', # OPTIONAL
49 Sort => 'USER_NAME', # OPTIONAL
50 UserIds => 'MyUserIdsType', # OPTIONAL
51 );
52  
53 # Results:
54 my $Marker = $DescribeUsersResponse->Marker;
55 my $TotalNumberOfUsers = $DescribeUsersResponse->TotalNumberOfUsers;
56 my $Users = $DescribeUsersResponse->Users;
57  
58 # Returns a L<Paws::WorkDocs::DescribeUsersResponse> object.
59  
60 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.
61 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeUsers>
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 AuthenticationToken => Str
67  
68 Amazon WorkDocs authentication token. Not required when using AWS
69 administrator credentials to access the API.
70  
71  
72  
73 =head2 Fields => Str
74  
75 A comma-separated list of values. Specify "STORAGE_METADATA" to include
76 the user storage quota and utilization information.
77  
78  
79  
80 =head2 Include => Str
81  
82 The state of the users. Specify "ALL" to include inactive users.
83  
84 Valid values are: C<"ALL">, C<"ACTIVE_PENDING">
85  
86 =head2 Limit => Int
87  
88 The maximum number of items to return.
89  
90  
91  
92 =head2 Marker => Str
93  
94 The marker for the next set of results. (You received this marker from
95 a previous call.)
96  
97  
98  
99 =head2 Order => Str
100  
101 The order for the results.
102  
103 Valid values are: C<"ASCENDING">, C<"DESCENDING">
104  
105 =head2 OrganizationId => Str
106  
107 The ID of the organization.
108  
109  
110  
111 =head2 Query => Str
112  
113 A query to filter users by user name.
114  
115  
116  
117 =head2 Sort => Str
118  
119 The sorting criteria.
120  
121 Valid values are: C<"USER_NAME">, C<"FULL_NAME">, C<"STORAGE_LIMIT">, C<"USER_STATUS">, C<"STORAGE_USED">
122  
123 =head2 UserIds => Str
124  
125 The IDs of the users.
126  
127  
128  
129  
130 =head1 SEE ALSO
131  
132 This class forms part of L<Paws>, documenting arguments for method DescribeUsers in L<Paws::WorkDocs>
133  
134 =head1 BUGS and CONTRIBUTIONS
135  
136 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
137  
138 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
139  
140 =cut
141