blib/lib/Paws/WorkDocs.pm untested

filter: Statementstmt 0.0% 0 / 325 Branchbran 0.0% 0 / 36 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 56 Podpod 0.0% 0 / 55 totaltotal 0.0% 0 / 472 CC 19 SCAR 17.3
CC
19
Cov
0%
DescribeAllActivities
12.0
DescribeAllComments
12.0
DescribeAllDocumentVersions
12.0
CRAP 5.6
1 package Paws::WorkDocs;
2 use Moose;
3 sub service { 'workdocs' }
4 sub signing_name { 'workdocs' }
5 sub version { '2016-05-01' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub AbortDocumentVersionUpload {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::WorkDocs::AbortDocumentVersionUpload', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub ActivateUser {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::WorkDocs::ActivateUser', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub AddResourcePermissions {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::WorkDocs::AddResourcePermissions', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub CreateComment {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateComment', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub CreateCustomMetadata {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateCustomMetadata', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub CreateFolder {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateFolder', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub CreateLabels {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateLabels', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub CreateNotificationSubscription {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateNotificationSubscription', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub CreateUser {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateUser', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub DeactivateUser {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeactivateUser', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub DeleteComment {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteComment', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub DeleteCustomMetadata {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteCustomMetadata', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub DeleteDocument {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteDocument', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub DeleteFolder {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteFolder', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub DeleteFolderContents {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteFolderContents', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub DeleteLabels {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteLabels', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub DeleteNotificationSubscription {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteNotificationSubscription', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102 sub DeleteUser {
103 my $self = shift;
104 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteUser', @_);
105 return $self->caller->do_call($self, $call_object);
106 }
107 sub DescribeActivities {
108 my $self = shift;
109 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeActivities', @_);
110 return $self->caller->do_call($self, $call_object);
111 }
112 sub DescribeComments {
113 my $self = shift;
114 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeComments', @_);
115 return $self->caller->do_call($self, $call_object);
116 }
117 sub DescribeDocumentVersions {
118 my $self = shift;
119 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeDocumentVersions', @_);
120 return $self->caller->do_call($self, $call_object);
121 }
122 sub DescribeFolderContents {
123 my $self = shift;
124 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeFolderContents', @_);
125 return $self->caller->do_call($self, $call_object);
126 }
127 sub DescribeGroups {
128 my $self = shift;
129 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeGroups', @_);
130 return $self->caller->do_call($self, $call_object);
131 }
132 sub DescribeNotificationSubscriptions {
133 my $self = shift;
134 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeNotificationSubscriptions', @_);
135 return $self->caller->do_call($self, $call_object);
136 }
137 sub DescribeResourcePermissions {
138 my $self = shift;
139 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeResourcePermissions', @_);
140 return $self->caller->do_call($self, $call_object);
141 }
142 sub DescribeRootFolders {
143 my $self = shift;
144 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeRootFolders', @_);
145 return $self->caller->do_call($self, $call_object);
146 }
147 sub DescribeUsers {
148 my $self = shift;
149 my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeUsers', @_);
150 return $self->caller->do_call($self, $call_object);
151 }
152 sub GetCurrentUser {
153 my $self = shift;
154 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetCurrentUser', @_);
155 return $self->caller->do_call($self, $call_object);
156 }
157 sub GetDocument {
158 my $self = shift;
159 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocument', @_);
160 return $self->caller->do_call($self, $call_object);
161 }
162 sub GetDocumentPath {
163 my $self = shift;
164 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocumentPath', @_);
165 return $self->caller->do_call($self, $call_object);
166 }
167 sub GetDocumentVersion {
168 my $self = shift;
169 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocumentVersion', @_);
170 return $self->caller->do_call($self, $call_object);
171 }
172 sub GetFolder {
173 my $self = shift;
174 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetFolder', @_);
175 return $self->caller->do_call($self, $call_object);
176 }
177 sub GetFolderPath {
178 my $self = shift;
179 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetFolderPath', @_);
180 return $self->caller->do_call($self, $call_object);
181 }
182 sub GetResources {
183 my $self = shift;
184 my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetResources', @_);
185 return $self->caller->do_call($self, $call_object);
186 }
187 sub InitiateDocumentVersionUpload {
188 my $self = shift;
189 my $call_object = $self->new_with_coercions('Paws::WorkDocs::InitiateDocumentVersionUpload', @_);
190 return $self->caller->do_call($self, $call_object);
191 }
192 sub RemoveAllResourcePermissions {
193 my $self = shift;
194 my $call_object = $self->new_with_coercions('Paws::WorkDocs::RemoveAllResourcePermissions', @_);
195 return $self->caller->do_call($self, $call_object);
196 }
197 sub RemoveResourcePermission {
198 my $self = shift;
199 my $call_object = $self->new_with_coercions('Paws::WorkDocs::RemoveResourcePermission', @_);
200 return $self->caller->do_call($self, $call_object);
201 }
202 sub UpdateDocument {
203 my $self = shift;
204 my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateDocument', @_);
205 return $self->caller->do_call($self, $call_object);
206 }
207 sub UpdateDocumentVersion {
208 my $self = shift;
209 my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateDocumentVersion', @_);
210 return $self->caller->do_call($self, $call_object);
211 }
212 sub UpdateFolder {
213 my $self = shift;
214 my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateFolder', @_);
215 return $self->caller->do_call($self, $call_object);
216 }
217 sub UpdateUser {
218 my $self = shift;
219 my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateUser', @_);
220 return $self->caller->do_call($self, $call_object);
221 }
222
223 sub DescribeAllActivities {
224 my $self = shift;
225  
226 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
227 my $result = $self->DescribeActivities(@_);
228 my $next_result = $result;
229  
230 if (not defined $callback) {
231 while ($next_result->Marker) {
232 $next_result = $self->DescribeActivities(@_, Marker => $next_result->Marker);
233 push @{ $result->UserActivities }, @{ $next_result->UserActivities };
234 }
235 return $result;
236 } else {
237 while ($result->Marker) {
238 $callback->($_ => 'UserActivities') foreach (@{ $result->UserActivities });
239 $result = $self->DescribeActivities(@_, Marker => $result->Marker);
240 }
241 $callback->($_ => 'UserActivities') foreach (@{ $result->UserActivities });
242 }
243  
244 return undef
245 }
246 sub DescribeAllComments {
247 my $self = shift;
248  
249 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
250 my $result = $self->DescribeComments(@_);
251 my $next_result = $result;
252  
253 if (not defined $callback) {
254 while ($next_result->Marker) {
255 $next_result = $self->DescribeComments(@_, Marker => $next_result->Marker);
256 push @{ $result->Comments }, @{ $next_result->Comments };
257 }
258 return $result;
259 } else {
260 while ($result->Marker) {
261 $callback->($_ => 'Comments') foreach (@{ $result->Comments });
262 $result = $self->DescribeComments(@_, Marker => $result->Marker);
263 }
264 $callback->($_ => 'Comments') foreach (@{ $result->Comments });
265 }
266  
267 return undef
268 }
269 sub DescribeAllDocumentVersions {
270 my $self = shift;
271  
272 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
273 my $result = $self->DescribeDocumentVersions(@_);
274 my $next_result = $result;
275  
276 if (not defined $callback) {
277 while ($next_result->Marker) {
278 $next_result = $self->DescribeDocumentVersions(@_, Marker => $next_result->Marker);
279 push @{ $result->DocumentVersions }, @{ $next_result->DocumentVersions };
280 }
281 return $result;
282 } else {
283 while ($result->Marker) {
284 $callback->($_ => 'DocumentVersions') foreach (@{ $result->DocumentVersions });
285 $result = $self->DescribeDocumentVersions(@_, Marker => $result->Marker);
286 }
287 $callback->($_ => 'DocumentVersions') foreach (@{ $result->DocumentVersions });
288 }
289  
290 return undef
291 }
292 sub DescribeAllFolderContents {
293 my $self = shift;
294  
295 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
296 my $result = $self->DescribeFolderContents(@_);
297 my $next_result = $result;
298  
299 if (not defined $callback) {
300 while ($next_result->Marker) {
301 $next_result = $self->DescribeFolderContents(@_, Marker => $next_result->Marker);
302 push @{ $result->Folders }, @{ $next_result->Folders };
303 push @{ $result->Documents }, @{ $next_result->Documents };
304 }
305 return $result;
306 } else {
307 while ($result->Marker) {
308 $callback->($_ => 'Folders') foreach (@{ $result->Folders });
309 $callback->($_ => 'Documents') foreach (@{ $result->Documents });
310 $result = $self->DescribeFolderContents(@_, Marker => $result->Marker);
311 }
312 $callback->($_ => 'Folders') foreach (@{ $result->Folders });
313 $callback->($_ => 'Documents') foreach (@{ $result->Documents });
314 }
315  
316 return undef
317 }
318 sub DescribeAllGroups {
319 my $self = shift;
320  
321 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
322 my $result = $self->DescribeGroups(@_);
323 my $next_result = $result;
324  
325 if (not defined $callback) {
326 while ($next_result->Marker) {
327 $next_result = $self->DescribeGroups(@_, Marker => $next_result->Marker);
328 push @{ $result->Groups }, @{ $next_result->Groups };
329 }
330 return $result;
331 } else {
332 while ($result->Marker) {
333 $callback->($_ => 'Groups') foreach (@{ $result->Groups });
334 $result = $self->DescribeGroups(@_, Marker => $result->Marker);
335 }
336 $callback->($_ => 'Groups') foreach (@{ $result->Groups });
337 }
338  
339 return undef
340 }
341 sub DescribeAllNotificationSubscriptions {
342 my $self = shift;
343  
344 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
345 my $result = $self->DescribeNotificationSubscriptions(@_);
346 my $next_result = $result;
347  
348 if (not defined $callback) {
349 while ($next_result->Marker) {
350 $next_result = $self->DescribeNotificationSubscriptions(@_, Marker => $next_result->Marker);
351 push @{ $result->Subscriptions }, @{ $next_result->Subscriptions };
352 }
353 return $result;
354 } else {
355 while ($result->Marker) {
356 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
357 $result = $self->DescribeNotificationSubscriptions(@_, Marker => $result->Marker);
358 }
359 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
360 }
361  
362 return undef
363 }
364 sub DescribeAllResourcePermissions {
365 my $self = shift;
366  
367 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
368 my $result = $self->DescribeResourcePermissions(@_);
369 my $next_result = $result;
370  
371 if (not defined $callback) {
372 while ($next_result->Marker) {
373 $next_result = $self->DescribeResourcePermissions(@_, Marker => $next_result->Marker);
374 push @{ $result->Principals }, @{ $next_result->Principals };
375 }
376 return $result;
377 } else {
378 while ($result->Marker) {
379 $callback->($_ => 'Principals') foreach (@{ $result->Principals });
380 $result = $self->DescribeResourcePermissions(@_, Marker => $result->Marker);
381 }
382 $callback->($_ => 'Principals') foreach (@{ $result->Principals });
383 }
384  
385 return undef
386 }
387 sub DescribeAllRootFolders {
388 my $self = shift;
389  
390 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
391 my $result = $self->DescribeRootFolders(@_);
392 my $next_result = $result;
393  
394 if (not defined $callback) {
395 while ($next_result->Marker) {
396 $next_result = $self->DescribeRootFolders(@_, Marker => $next_result->Marker);
397 push @{ $result->Folders }, @{ $next_result->Folders };
398 }
399 return $result;
400 } else {
401 while ($result->Marker) {
402 $callback->($_ => 'Folders') foreach (@{ $result->Folders });
403 $result = $self->DescribeRootFolders(@_, Marker => $result->Marker);
404 }
405 $callback->($_ => 'Folders') foreach (@{ $result->Folders });
406 }
407  
408 return undef
409 }
410 sub DescribeAllUsers {
411 my $self = shift;
412  
413 my $callback = shift @_ if (ref($_[0]) eq 'CODE');
414 my $result = $self->DescribeUsers(@_);
415 my $next_result = $result;
416  
417 if (not defined $callback) {
418 while ($next_result->Marker) {
419 $next_result = $self->DescribeUsers(@_, Marker => $next_result->Marker);
420 push @{ $result->Users }, @{ $next_result->Users };
421 }
422 return $result;
423 } else {
424 while ($result->Marker) {
425 $callback->($_ => 'Users') foreach (@{ $result->Users });
426 $result = $self->DescribeUsers(@_, Marker => $result->Marker);
427 }
428 $callback->($_ => 'Users') foreach (@{ $result->Users });
429 }
430  
431 return undef
432 }
433  
434  
435 sub operations { qw/AbortDocumentVersionUpload ActivateUser AddResourcePermissions CreateComment CreateCustomMetadata CreateFolder CreateLabels CreateNotificationSubscription CreateUser DeactivateUser DeleteComment DeleteCustomMetadata DeleteDocument DeleteFolder DeleteFolderContents DeleteLabels DeleteNotificationSubscription DeleteUser DescribeActivities DescribeComments DescribeDocumentVersions DescribeFolderContents DescribeGroups DescribeNotificationSubscriptions DescribeResourcePermissions DescribeRootFolders DescribeUsers GetCurrentUser GetDocument GetDocumentPath GetDocumentVersion GetFolder GetFolderPath GetResources InitiateDocumentVersionUpload RemoveAllResourcePermissions RemoveResourcePermission UpdateDocument UpdateDocumentVersion UpdateFolder UpdateUser / }
436  
437 1;
438  
439 ### main pod documentation begin ###
440  
441 =head1 NAME
442  
443 Paws::WorkDocs - Perl Interface to AWS Amazon WorkDocs
444  
445 =head1 SYNOPSIS
446  
447 use Paws;
448  
449 my $obj = Paws->service('WorkDocs');
450 my $res = $obj->Method(
451 Arg1 => $val1,
452 Arg2 => [ 'V1', 'V2' ],
453 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
454 # of the arguments type
455 Arg3 => { Att1 => 'Val1' },
456 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
457 # the constructor of the arguments type
458 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
459 );
460  
461 =head1 DESCRIPTION
462  
463 The WorkDocs API is designed for the following use cases:
464  
465 =over
466  
467 =item *
468  
469 File Migration: File migration applications are supported for users who
470 want to migrate their files from an on-premises or off-premises file
471 system or service. Users can insert files into a user directory
472 structure, as well as allow for basic metadata changes, such as
473 modifications to the permissions of files.
474  
475 =item *
476  
477 Security: Support security applications are supported for users who
478 have additional security needs, such as antivirus or data loss
479 prevention. The API actions, along with AWS CloudTrail, allow these
480 applications to detect when changes occur in Amazon WorkDocs. Then, the
481 application can take the necessary actions and replace the target file.
482 If the target file violates the policy, the application can also choose
483 to email the user.
484  
485 =item *
486  
487 eDiscovery/Analytics: General administrative applications are
488 supported, such as eDiscovery and analytics. These applications can
489 choose to mimic or record the actions in an Amazon WorkDocs site, along
490 with AWS CloudTrail, to replicate data for eDiscovery, backup, or
491 analytical applications.
492  
493 =back
494  
495 All Amazon WorkDocs API actions are Amazon authenticated and
496 certificate-signed. They not only require the use of the AWS SDK, but
497 also allow for the exclusive use of IAM users and roles to help
498 facilitate access, trust, and permission policies. By creating a role
499 and allowing an IAM user to access the Amazon WorkDocs site, the IAM
500 user gains full administrative visibility into the entire Amazon
501 WorkDocs site (or as set in the IAM policy). This includes, but is not
502 limited to, the ability to modify file permissions and upload any file
503 to any user. This allows developers to perform the three use cases
504 above, as well as give users the ability to grant access on a selective
505 basis using the IAM model.
506  
507 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01>
508  
509  
510 =head1 METHODS
511  
512 =head2 AbortDocumentVersionUpload
513  
514 =over
515  
516 =item DocumentId => Str
517  
518 =item VersionId => Str
519  
520 =item [AuthenticationToken => Str]
521  
522  
523 =back
524  
525 Each argument is described in detail in: L<Paws::WorkDocs::AbortDocumentVersionUpload>
526  
527 Returns: nothing
528  
529 Aborts the upload of the specified document version that was previously
530 initiated by InitiateDocumentVersionUpload. The client should make this
531 call only when it no longer intends to upload the document version, or
532 fails to do so.
533  
534  
535 =head2 ActivateUser
536  
537 =over
538  
539 =item UserId => Str
540  
541 =item [AuthenticationToken => Str]
542  
543  
544 =back
545  
546 Each argument is described in detail in: L<Paws::WorkDocs::ActivateUser>
547  
548 Returns: a L<Paws::WorkDocs::ActivateUserResponse> instance
549  
550 Activates the specified user. Only active users can access Amazon
551 WorkDocs.
552  
553  
554 =head2 AddResourcePermissions
555  
556 =over
557  
558 =item Principals => ArrayRef[L<Paws::WorkDocs::SharePrincipal>]
559  
560 =item ResourceId => Str
561  
562 =item [AuthenticationToken => Str]
563  
564 =item [NotificationOptions => L<Paws::WorkDocs::NotificationOptions>]
565  
566  
567 =back
568  
569 Each argument is described in detail in: L<Paws::WorkDocs::AddResourcePermissions>
570  
571 Returns: a L<Paws::WorkDocs::AddResourcePermissionsResponse> instance
572  
573 Creates a set of permissions for the specified folder or document. The
574 resource permissions are overwritten if the principals already have
575 different permissions.
576  
577  
578 =head2 CreateComment
579  
580 =over
581  
582 =item DocumentId => Str
583  
584 =item Text => Str
585  
586 =item VersionId => Str
587  
588 =item [AuthenticationToken => Str]
589  
590 =item [NotifyCollaborators => Bool]
591  
592 =item [ParentId => Str]
593  
594 =item [ThreadId => Str]
595  
596 =item [Visibility => Str]
597  
598  
599 =back
600  
601 Each argument is described in detail in: L<Paws::WorkDocs::CreateComment>
602  
603 Returns: a L<Paws::WorkDocs::CreateCommentResponse> instance
604  
605 Adds a new comment to the specified document version.
606  
607  
608 =head2 CreateCustomMetadata
609  
610 =over
611  
612 =item CustomMetadata => L<Paws::WorkDocs::CustomMetadataMap>
613  
614 =item ResourceId => Str
615  
616 =item [AuthenticationToken => Str]
617  
618 =item [VersionId => Str]
619  
620  
621 =back
622  
623 Each argument is described in detail in: L<Paws::WorkDocs::CreateCustomMetadata>
624  
625 Returns: a L<Paws::WorkDocs::CreateCustomMetadataResponse> instance
626  
627 Adds one or more custom properties to the specified resource (a folder,
628 document, or version).
629  
630  
631 =head2 CreateFolder
632  
633 =over
634  
635 =item ParentFolderId => Str
636  
637 =item [AuthenticationToken => Str]
638  
639 =item [Name => Str]
640  
641  
642 =back
643  
644 Each argument is described in detail in: L<Paws::WorkDocs::CreateFolder>
645  
646 Returns: a L<Paws::WorkDocs::CreateFolderResponse> instance
647  
648 Creates a folder with the specified name and parent folder.
649  
650  
651 =head2 CreateLabels
652  
653 =over
654  
655 =item Labels => ArrayRef[Str|Undef]
656  
657 =item ResourceId => Str
658  
659 =item [AuthenticationToken => Str]
660  
661  
662 =back
663  
664 Each argument is described in detail in: L<Paws::WorkDocs::CreateLabels>
665  
666 Returns: a L<Paws::WorkDocs::CreateLabelsResponse> instance
667  
668 Adds the specified list of labels to the given resource (a document or
669 folder)
670  
671  
672 =head2 CreateNotificationSubscription
673  
674 =over
675  
676 =item Endpoint => Str
677  
678 =item OrganizationId => Str
679  
680 =item Protocol => Str
681  
682 =item SubscriptionType => Str
683  
684  
685 =back
686  
687 Each argument is described in detail in: L<Paws::WorkDocs::CreateNotificationSubscription>
688  
689 Returns: a L<Paws::WorkDocs::CreateNotificationSubscriptionResponse> instance
690  
691 Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint
692 receives a confirmation message, and must confirm the subscription.
693  
694 For more information, see Subscribe to Notifications
695 (https://docs.aws.amazon.com/workdocs/latest/developerguide/subscribe-notifications.html)
696 in the I<Amazon WorkDocs Developer Guide>.
697  
698  
699 =head2 CreateUser
700  
701 =over
702  
703 =item GivenName => Str
704  
705 =item Password => Str
706  
707 =item Surname => Str
708  
709 =item Username => Str
710  
711 =item [AuthenticationToken => Str]
712  
713 =item [EmailAddress => Str]
714  
715 =item [OrganizationId => Str]
716  
717 =item [StorageRule => L<Paws::WorkDocs::StorageRuleType>]
718  
719 =item [TimeZoneId => Str]
720  
721  
722 =back
723  
724 Each argument is described in detail in: L<Paws::WorkDocs::CreateUser>
725  
726 Returns: a L<Paws::WorkDocs::CreateUserResponse> instance
727  
728 Creates a user in a Simple AD or Microsoft AD directory. The status of
729 a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
730  
731  
732 =head2 DeactivateUser
733  
734 =over
735  
736 =item UserId => Str
737  
738 =item [AuthenticationToken => Str]
739  
740  
741 =back
742  
743 Each argument is described in detail in: L<Paws::WorkDocs::DeactivateUser>
744  
745 Returns: nothing
746  
747 Deactivates the specified user, which revokes the user's access to
748 Amazon WorkDocs.
749  
750  
751 =head2 DeleteComment
752  
753 =over
754  
755 =item CommentId => Str
756  
757 =item DocumentId => Str
758  
759 =item VersionId => Str
760  
761 =item [AuthenticationToken => Str]
762  
763  
764 =back
765  
766 Each argument is described in detail in: L<Paws::WorkDocs::DeleteComment>
767  
768 Returns: nothing
769  
770 Deletes the specified comment from the document version.
771  
772  
773 =head2 DeleteCustomMetadata
774  
775 =over
776  
777 =item ResourceId => Str
778  
779 =item [AuthenticationToken => Str]
780  
781 =item [DeleteAll => Bool]
782  
783 =item [Keys => ArrayRef[Str|Undef]]
784  
785 =item [VersionId => Str]
786  
787  
788 =back
789  
790 Each argument is described in detail in: L<Paws::WorkDocs::DeleteCustomMetadata>
791  
792 Returns: a L<Paws::WorkDocs::DeleteCustomMetadataResponse> instance
793  
794 Deletes custom metadata from the specified resource.
795  
796  
797 =head2 DeleteDocument
798  
799 =over
800  
801 =item DocumentId => Str
802  
803 =item [AuthenticationToken => Str]
804  
805  
806 =back
807  
808 Each argument is described in detail in: L<Paws::WorkDocs::DeleteDocument>
809  
810 Returns: nothing
811  
812 Permanently deletes the specified document and its associated metadata.
813  
814  
815 =head2 DeleteFolder
816  
817 =over
818  
819 =item FolderId => Str
820  
821 =item [AuthenticationToken => Str]
822  
823  
824 =back
825  
826 Each argument is described in detail in: L<Paws::WorkDocs::DeleteFolder>
827  
828 Returns: nothing
829  
830 Permanently deletes the specified folder and its contents.
831  
832  
833 =head2 DeleteFolderContents
834  
835 =over
836  
837 =item FolderId => Str
838  
839 =item [AuthenticationToken => Str]
840  
841  
842 =back
843  
844 Each argument is described in detail in: L<Paws::WorkDocs::DeleteFolderContents>
845  
846 Returns: nothing
847  
848 Deletes the contents of the specified folder.
849  
850  
851 =head2 DeleteLabels
852  
853 =over
854  
855 =item ResourceId => Str
856  
857 =item [AuthenticationToken => Str]
858  
859 =item [DeleteAll => Bool]
860  
861 =item [Labels => ArrayRef[Str|Undef]]
862  
863  
864 =back
865  
866 Each argument is described in detail in: L<Paws::WorkDocs::DeleteLabels>
867  
868 Returns: a L<Paws::WorkDocs::DeleteLabelsResponse> instance
869  
870 Deletes the specified list of labels from a resource.
871  
872  
873 =head2 DeleteNotificationSubscription
874  
875 =over
876  
877 =item OrganizationId => Str
878  
879 =item SubscriptionId => Str
880  
881  
882 =back
883  
884 Each argument is described in detail in: L<Paws::WorkDocs::DeleteNotificationSubscription>
885  
886 Returns: nothing
887  
888 Deletes the specified subscription from the specified organization.
889  
890  
891 =head2 DeleteUser
892  
893 =over
894  
895 =item UserId => Str
896  
897 =item [AuthenticationToken => Str]
898  
899  
900 =back
901  
902 Each argument is described in detail in: L<Paws::WorkDocs::DeleteUser>
903  
904 Returns: nothing
905  
906 Deletes the specified user from a Simple AD or Microsoft AD directory.
907  
908  
909 =head2 DescribeActivities
910  
911 =over
912  
913 =item [ActivityTypes => Str]
914  
915 =item [AuthenticationToken => Str]
916  
917 =item [EndTime => Str]
918  
919 =item [IncludeIndirectActivities => Bool]
920  
921 =item [Limit => Int]
922  
923 =item [Marker => Str]
924  
925 =item [OrganizationId => Str]
926  
927 =item [ResourceId => Str]
928  
929 =item [StartTime => Str]
930  
931 =item [UserId => Str]
932  
933  
934 =back
935  
936 Each argument is described in detail in: L<Paws::WorkDocs::DescribeActivities>
937  
938 Returns: a L<Paws::WorkDocs::DescribeActivitiesResponse> instance
939  
940 Describes the user activities in a specified time period.
941  
942  
943 =head2 DescribeComments
944  
945 =over
946  
947 =item DocumentId => Str
948  
949 =item VersionId => Str
950  
951 =item [AuthenticationToken => Str]
952  
953 =item [Limit => Int]
954  
955 =item [Marker => Str]
956  
957  
958 =back
959  
960 Each argument is described in detail in: L<Paws::WorkDocs::DescribeComments>
961  
962 Returns: a L<Paws::WorkDocs::DescribeCommentsResponse> instance
963  
964 List all the comments for the specified document version.
965  
966  
967 =head2 DescribeDocumentVersions
968  
969 =over
970  
971 =item DocumentId => Str
972  
973 =item [AuthenticationToken => Str]
974  
975 =item [Fields => Str]
976  
977 =item [Include => Str]
978  
979 =item [Limit => Int]
980  
981 =item [Marker => Str]
982  
983  
984 =back
985  
986 Each argument is described in detail in: L<Paws::WorkDocs::DescribeDocumentVersions>
987  
988 Returns: a L<Paws::WorkDocs::DescribeDocumentVersionsResponse> instance
989  
990 Retrieves the document versions for the specified document.
991  
992 By default, only active versions are returned.
993  
994  
995 =head2 DescribeFolderContents
996  
997 =over
998  
999 =item FolderId => Str
1000  
1001 =item [AuthenticationToken => Str]
1002  
1003 =item [Include => Str]
1004  
1005 =item [Limit => Int]
1006  
1007 =item [Marker => Str]
1008  
1009 =item [Order => Str]
1010  
1011 =item [Sort => Str]
1012  
1013 =item [Type => Str]
1014  
1015  
1016 =back
1017  
1018 Each argument is described in detail in: L<Paws::WorkDocs::DescribeFolderContents>
1019  
1020 Returns: a L<Paws::WorkDocs::DescribeFolderContentsResponse> instance
1021  
1022 Describes the contents of the specified folder, including its documents
1023 and subfolders.
1024  
1025 By default, Amazon WorkDocs returns the first 100 active document and
1026 folder metadata items. If there are more results, the response includes
1027 a marker that you can use to request the next set of results. You can
1028 also request initialized documents.
1029  
1030  
1031 =head2 DescribeGroups
1032  
1033 =over
1034  
1035 =item SearchQuery => Str
1036  
1037 =item [AuthenticationToken => Str]
1038  
1039 =item [Limit => Int]
1040  
1041 =item [Marker => Str]
1042  
1043 =item [OrganizationId => Str]
1044  
1045  
1046 =back
1047  
1048 Each argument is described in detail in: L<Paws::WorkDocs::DescribeGroups>
1049  
1050 Returns: a L<Paws::WorkDocs::DescribeGroupsResponse> instance
1051  
1052 Describes the groups specified by the query. Groups are defined by the
1053 underlying Active Directory.
1054  
1055  
1056 =head2 DescribeNotificationSubscriptions
1057  
1058 =over
1059  
1060 =item OrganizationId => Str
1061  
1062 =item [Limit => Int]
1063  
1064 =item [Marker => Str]
1065  
1066  
1067 =back
1068  
1069 Each argument is described in detail in: L<Paws::WorkDocs::DescribeNotificationSubscriptions>
1070  
1071 Returns: a L<Paws::WorkDocs::DescribeNotificationSubscriptionsResponse> instance
1072  
1073 Lists the specified notification subscriptions.
1074  
1075  
1076 =head2 DescribeResourcePermissions
1077  
1078 =over
1079  
1080 =item ResourceId => Str
1081  
1082 =item [AuthenticationToken => Str]
1083  
1084 =item [Limit => Int]
1085  
1086 =item [Marker => Str]
1087  
1088 =item [PrincipalId => Str]
1089  
1090  
1091 =back
1092  
1093 Each argument is described in detail in: L<Paws::WorkDocs::DescribeResourcePermissions>
1094  
1095 Returns: a L<Paws::WorkDocs::DescribeResourcePermissionsResponse> instance
1096  
1097 Describes the permissions of a specified resource.
1098  
1099  
1100 =head2 DescribeRootFolders
1101  
1102 =over
1103  
1104 =item AuthenticationToken => Str
1105  
1106 =item [Limit => Int]
1107  
1108 =item [Marker => Str]
1109  
1110  
1111 =back
1112  
1113 Each argument is described in detail in: L<Paws::WorkDocs::DescribeRootFolders>
1114  
1115 Returns: a L<Paws::WorkDocs::DescribeRootFoldersResponse> instance
1116  
1117 Describes the current user's special folders; the C<RootFolder> and the
1118 C<RecycleBin>. C<RootFolder> is the root of user's files and folders
1119 and C<RecycleBin> is the root of recycled items. This is not a valid
1120 action for SigV4 (administrative API) clients.
1121  
1122 This action requires an authentication token. To get an authentication
1123 token, register an application with Amazon WorkDocs. For more
1124 information, see Authentication and Access Control for User
1125 Applications
1126 (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html)
1127 in the I<Amazon WorkDocs Developer Guide>.
1128  
1129  
1130 =head2 DescribeUsers
1131  
1132 =over
1133  
1134 =item [AuthenticationToken => Str]
1135  
1136 =item [Fields => Str]
1137  
1138 =item [Include => Str]
1139  
1140 =item [Limit => Int]
1141  
1142 =item [Marker => Str]
1143  
1144 =item [Order => Str]
1145  
1146 =item [OrganizationId => Str]
1147  
1148 =item [Query => Str]
1149  
1150 =item [Sort => Str]
1151  
1152 =item [UserIds => Str]
1153  
1154  
1155 =back
1156  
1157 Each argument is described in detail in: L<Paws::WorkDocs::DescribeUsers>
1158  
1159 Returns: a L<Paws::WorkDocs::DescribeUsersResponse> instance
1160  
1161 Describes the specified users. You can describe all users or filter the
1162 results (for example, by status or organization).
1163  
1164 By default, Amazon WorkDocs returns the first 24 active or pending
1165 users. If there are more results, the response includes a marker that
1166 you can use to request the next set of results.
1167  
1168  
1169 =head2 GetCurrentUser
1170  
1171 =over
1172  
1173 =item AuthenticationToken => Str
1174  
1175  
1176 =back
1177  
1178 Each argument is described in detail in: L<Paws::WorkDocs::GetCurrentUser>
1179  
1180 Returns: a L<Paws::WorkDocs::GetCurrentUserResponse> instance
1181  
1182 Retrieves details of the current user for whom the authentication token
1183 was generated. This is not a valid action for SigV4 (administrative
1184 API) clients.
1185  
1186 This action requires an authentication token. To get an authentication
1187 token, register an application with Amazon WorkDocs. For more
1188 information, see Authentication and Access Control for User
1189 Applications
1190 (https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html)
1191 in the I<Amazon WorkDocs Developer Guide>.
1192  
1193  
1194 =head2 GetDocument
1195  
1196 =over
1197  
1198 =item DocumentId => Str
1199  
1200 =item [AuthenticationToken => Str]
1201  
1202 =item [IncludeCustomMetadata => Bool]
1203  
1204  
1205 =back
1206  
1207 Each argument is described in detail in: L<Paws::WorkDocs::GetDocument>
1208  
1209 Returns: a L<Paws::WorkDocs::GetDocumentResponse> instance
1210  
1211 Retrieves details of a document.
1212  
1213  
1214 =head2 GetDocumentPath
1215  
1216 =over
1217  
1218 =item DocumentId => Str
1219  
1220 =item [AuthenticationToken => Str]
1221  
1222 =item [Fields => Str]
1223  
1224 =item [Limit => Int]
1225  
1226 =item [Marker => Str]
1227  
1228  
1229 =back
1230  
1231 Each argument is described in detail in: L<Paws::WorkDocs::GetDocumentPath>
1232  
1233 Returns: a L<Paws::WorkDocs::GetDocumentPathResponse> instance
1234  
1235 Retrieves the path information (the hierarchy from the root folder) for
1236 the requested document.
1237  
1238 By default, Amazon WorkDocs returns a maximum of 100 levels upwards
1239 from the requested document and only includes the IDs of the parent
1240 folders in the path. You can limit the maximum number of levels. You
1241 can also request the names of the parent folders.
1242  
1243  
1244 =head2 GetDocumentVersion
1245  
1246 =over
1247  
1248 =item DocumentId => Str
1249  
1250 =item VersionId => Str
1251  
1252 =item [AuthenticationToken => Str]
1253  
1254 =item [Fields => Str]
1255  
1256 =item [IncludeCustomMetadata => Bool]
1257  
1258  
1259 =back
1260  
1261 Each argument is described in detail in: L<Paws::WorkDocs::GetDocumentVersion>
1262  
1263 Returns: a L<Paws::WorkDocs::GetDocumentVersionResponse> instance
1264  
1265 Retrieves version metadata for the specified document.
1266  
1267  
1268 =head2 GetFolder
1269  
1270 =over
1271  
1272 =item FolderId => Str
1273  
1274 =item [AuthenticationToken => Str]
1275  
1276 =item [IncludeCustomMetadata => Bool]
1277  
1278  
1279 =back
1280  
1281 Each argument is described in detail in: L<Paws::WorkDocs::GetFolder>
1282  
1283 Returns: a L<Paws::WorkDocs::GetFolderResponse> instance
1284  
1285 Retrieves the metadata of the specified folder.
1286  
1287  
1288 =head2 GetFolderPath
1289  
1290 =over
1291  
1292 =item FolderId => Str
1293  
1294 =item [AuthenticationToken => Str]
1295  
1296 =item [Fields => Str]
1297  
1298 =item [Limit => Int]
1299  
1300 =item [Marker => Str]
1301  
1302  
1303 =back
1304  
1305 Each argument is described in detail in: L<Paws::WorkDocs::GetFolderPath>
1306  
1307 Returns: a L<Paws::WorkDocs::GetFolderPathResponse> instance
1308  
1309 Retrieves the path information (the hierarchy from the root folder) for
1310 the specified folder.
1311  
1312 By default, Amazon WorkDocs returns a maximum of 100 levels upwards
1313 from the requested folder and only includes the IDs of the parent
1314 folders in the path. You can limit the maximum number of levels. You
1315 can also request the parent folder names.
1316  
1317  
1318 =head2 GetResources
1319  
1320 =over
1321  
1322 =item [AuthenticationToken => Str]
1323  
1324 =item [CollectionType => Str]
1325  
1326 =item [Limit => Int]
1327  
1328 =item [Marker => Str]
1329  
1330 =item [UserId => Str]
1331  
1332  
1333 =back
1334  
1335 Each argument is described in detail in: L<Paws::WorkDocs::GetResources>
1336  
1337 Returns: a L<Paws::WorkDocs::GetResourcesResponse> instance
1338  
1339 Retrieves a collection of resources, including folders and documents.
1340 The only C<CollectionType> supported is C<SHARED_WITH_ME>.
1341  
1342  
1343 =head2 InitiateDocumentVersionUpload
1344  
1345 =over
1346  
1347 =item ParentFolderId => Str
1348  
1349 =item [AuthenticationToken => Str]
1350  
1351 =item [ContentCreatedTimestamp => Str]
1352  
1353 =item [ContentModifiedTimestamp => Str]
1354  
1355 =item [ContentType => Str]
1356  
1357 =item [DocumentSizeInBytes => Int]
1358  
1359 =item [Id => Str]
1360  
1361 =item [Name => Str]
1362  
1363  
1364 =back
1365  
1366 Each argument is described in detail in: L<Paws::WorkDocs::InitiateDocumentVersionUpload>
1367  
1368 Returns: a L<Paws::WorkDocs::InitiateDocumentVersionUploadResponse> instance
1369  
1370 Creates a new document object and version object.
1371  
1372 The client specifies the parent folder ID and name of the document to
1373 upload. The ID is optionally specified when creating a new version of
1374 an existing document. This is the first step to upload a document.
1375 Next, upload the document to the URL returned from the call, and then
1376 call UpdateDocumentVersion.
1377  
1378 To cancel the document upload, call AbortDocumentVersionUpload.
1379  
1380  
1381 =head2 RemoveAllResourcePermissions
1382  
1383 =over
1384  
1385 =item ResourceId => Str
1386  
1387 =item [AuthenticationToken => Str]
1388  
1389  
1390 =back
1391  
1392 Each argument is described in detail in: L<Paws::WorkDocs::RemoveAllResourcePermissions>
1393  
1394 Returns: nothing
1395  
1396 Removes all the permissions from the specified resource.
1397  
1398  
1399 =head2 RemoveResourcePermission
1400  
1401 =over
1402  
1403 =item PrincipalId => Str
1404  
1405 =item ResourceId => Str
1406  
1407 =item [AuthenticationToken => Str]
1408  
1409 =item [PrincipalType => Str]
1410  
1411  
1412 =back
1413  
1414 Each argument is described in detail in: L<Paws::WorkDocs::RemoveResourcePermission>
1415  
1416 Returns: nothing
1417  
1418 Removes the permission for the specified principal from the specified
1419 resource.
1420  
1421  
1422 =head2 UpdateDocument
1423  
1424 =over
1425  
1426 =item DocumentId => Str
1427  
1428 =item [AuthenticationToken => Str]
1429  
1430 =item [Name => Str]
1431  
1432 =item [ParentFolderId => Str]
1433  
1434 =item [ResourceState => Str]
1435  
1436  
1437 =back
1438  
1439 Each argument is described in detail in: L<Paws::WorkDocs::UpdateDocument>
1440  
1441 Returns: nothing
1442  
1443 Updates the specified attributes of a document. The user must have
1444 access to both the document and its parent folder, if applicable.
1445  
1446  
1447 =head2 UpdateDocumentVersion
1448  
1449 =over
1450  
1451 =item DocumentId => Str
1452  
1453 =item VersionId => Str
1454  
1455 =item [AuthenticationToken => Str]
1456  
1457 =item [VersionStatus => Str]
1458  
1459  
1460 =back
1461  
1462 Each argument is described in detail in: L<Paws::WorkDocs::UpdateDocumentVersion>
1463  
1464 Returns: nothing
1465  
1466 Changes the status of the document version to ACTIVE.
1467  
1468 Amazon WorkDocs also sets its document container to ACTIVE. This is the
1469 last step in a document upload, after the client uploads the document
1470 to an S3-presigned URL returned by InitiateDocumentVersionUpload.
1471  
1472  
1473 =head2 UpdateFolder
1474  
1475 =over
1476  
1477 =item FolderId => Str
1478  
1479 =item [AuthenticationToken => Str]
1480  
1481 =item [Name => Str]
1482  
1483 =item [ParentFolderId => Str]
1484  
1485 =item [ResourceState => Str]
1486  
1487  
1488 =back
1489  
1490 Each argument is described in detail in: L<Paws::WorkDocs::UpdateFolder>
1491  
1492 Returns: nothing
1493  
1494 Updates the specified attributes of the specified folder. The user must
1495 have access to both the folder and its parent folder, if applicable.
1496  
1497  
1498 =head2 UpdateUser
1499  
1500 =over
1501  
1502 =item UserId => Str
1503  
1504 =item [AuthenticationToken => Str]
1505  
1506 =item [GivenName => Str]
1507  
1508 =item [GrantPoweruserPrivileges => Str]
1509  
1510 =item [Locale => Str]
1511  
1512 =item [StorageRule => L<Paws::WorkDocs::StorageRuleType>]
1513  
1514 =item [Surname => Str]
1515  
1516 =item [TimeZoneId => Str]
1517  
1518 =item [Type => Str]
1519  
1520  
1521 =back
1522  
1523 Each argument is described in detail in: L<Paws::WorkDocs::UpdateUser>
1524  
1525 Returns: a L<Paws::WorkDocs::UpdateUserResponse> instance
1526  
1527 Updates the specified attributes of the specified user, and grants or
1528 revokes administrative privileges to the Amazon WorkDocs site.
1529  
1530  
1531  
1532  
1533 =head1 PAGINATORS
1534  
1535 Paginator methods are helpers that repetively call methods that return partial results
1536  
1537 =head2 DescribeAllActivities(sub { },[ActivityTypes => Str, AuthenticationToken => Str, EndTime => Str, IncludeIndirectActivities => Bool, Limit => Int, Marker => Str, OrganizationId => Str, ResourceId => Str, StartTime => Str, UserId => Str])
1538  
1539 =head2 DescribeAllActivities([ActivityTypes => Str, AuthenticationToken => Str, EndTime => Str, IncludeIndirectActivities => Bool, Limit => Int, Marker => Str, OrganizationId => Str, ResourceId => Str, StartTime => Str, UserId => Str])
1540  
1541  
1542 If passed a sub as first parameter, it will call the sub for each element found in :
1543  
1544 - UserActivities, passing the object as the first parameter, and the string 'UserActivities' as the second parameter
1545  
1546 If not, it will return a a L<Paws::WorkDocs::DescribeActivitiesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1547  
1548  
1549 =head2 DescribeAllComments(sub { },DocumentId => Str, VersionId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str])
1550  
1551 =head2 DescribeAllComments(DocumentId => Str, VersionId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str])
1552  
1553  
1554 If passed a sub as first parameter, it will call the sub for each element found in :
1555  
1556 - Comments, passing the object as the first parameter, and the string 'Comments' as the second parameter
1557  
1558 If not, it will return a a L<Paws::WorkDocs::DescribeCommentsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1559  
1560  
1561 =head2 DescribeAllDocumentVersions(sub { },DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str])
1562  
1563 =head2 DescribeAllDocumentVersions(DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str])
1564  
1565  
1566 If passed a sub as first parameter, it will call the sub for each element found in :
1567  
1568 - DocumentVersions, passing the object as the first parameter, and the string 'DocumentVersions' as the second parameter
1569  
1570 If not, it will return a a L<Paws::WorkDocs::DescribeDocumentVersionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1571  
1572  
1573 =head2 DescribeAllFolderContents(sub { },FolderId => Str, [AuthenticationToken => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, Sort => Str, Type => Str])
1574  
1575 =head2 DescribeAllFolderContents(FolderId => Str, [AuthenticationToken => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, Sort => Str, Type => Str])
1576  
1577  
1578 If passed a sub as first parameter, it will call the sub for each element found in :
1579  
1580 - Folders, passing the object as the first parameter, and the string 'Folders' as the second parameter
1581  
1582 - Documents, passing the object as the first parameter, and the string 'Documents' as the second parameter
1583  
1584 If not, it will return a a L<Paws::WorkDocs::DescribeFolderContentsResponse> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1585  
1586  
1587 =head2 DescribeAllGroups(sub { },SearchQuery => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str, OrganizationId => Str])
1588  
1589 =head2 DescribeAllGroups(SearchQuery => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str, OrganizationId => Str])
1590  
1591  
1592 If passed a sub as first parameter, it will call the sub for each element found in :
1593  
1594 - Groups, passing the object as the first parameter, and the string 'Groups' as the second parameter
1595  
1596 If not, it will return a a L<Paws::WorkDocs::DescribeGroupsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1597  
1598  
1599 =head2 DescribeAllNotificationSubscriptions(sub { },OrganizationId => Str, [Limit => Int, Marker => Str])
1600  
1601 =head2 DescribeAllNotificationSubscriptions(OrganizationId => Str, [Limit => Int, Marker => Str])
1602  
1603  
1604 If passed a sub as first parameter, it will call the sub for each element found in :
1605  
1606 - Subscriptions, passing the object as the first parameter, and the string 'Subscriptions' as the second parameter
1607  
1608 If not, it will return a a L<Paws::WorkDocs::DescribeNotificationSubscriptionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1609  
1610  
1611 =head2 DescribeAllResourcePermissions(sub { },ResourceId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str, PrincipalId => Str])
1612  
1613 =head2 DescribeAllResourcePermissions(ResourceId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str, PrincipalId => Str])
1614  
1615  
1616 If passed a sub as first parameter, it will call the sub for each element found in :
1617  
1618 - Principals, passing the object as the first parameter, and the string 'Principals' as the second parameter
1619  
1620 If not, it will return a a L<Paws::WorkDocs::DescribeResourcePermissionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1621  
1622  
1623 =head2 DescribeAllRootFolders(sub { },AuthenticationToken => Str, [Limit => Int, Marker => Str])
1624  
1625 =head2 DescribeAllRootFolders(AuthenticationToken => Str, [Limit => Int, Marker => Str])
1626  
1627  
1628 If passed a sub as first parameter, it will call the sub for each element found in :
1629  
1630 - Folders, passing the object as the first parameter, and the string 'Folders' as the second parameter
1631  
1632 If not, it will return a a L<Paws::WorkDocs::DescribeRootFoldersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1633  
1634  
1635 =head2 DescribeAllUsers(sub { },[AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, OrganizationId => Str, Query => Str, Sort => Str, UserIds => Str])
1636  
1637 =head2 DescribeAllUsers([AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, OrganizationId => Str, Query => Str, Sort => Str, UserIds => Str])
1638  
1639  
1640 If passed a sub as first parameter, it will call the sub for each element found in :
1641  
1642 - Users, passing the object as the first parameter, and the string 'Users' as the second parameter
1643  
1644 If not, it will return a a L<Paws::WorkDocs::DescribeUsersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1645  
1646  
1647  
1648  
1649  
1650 =head1 SEE ALSO
1651  
1652 This service class forms part of L<Paws>
1653  
1654 =head1 BUGS and CONTRIBUTIONS
1655  
1656 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1657  
1658 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1659  
1660 =cut
1661