File Coverage

blib/lib/Paws/WorkDocs.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WorkDocs;
2 1     1   6428 use Moose;
  1         3  
  1         11  
3             sub service { 'workdocs' }
4             sub version { '2016-05-01' }
5             sub flattened_arrays { 0 }
6             has max_attempts => (is => 'ro', isa => 'Int', default => 5);
7             has retry => (is => 'ro', isa => 'HashRef', default => sub {
8             { base => 'rand', type => 'exponential', growth_factor => 2 }
9             });
10             has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
11             ] });
12              
13             with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller', 'Paws::Net::RestJsonResponse';
14              
15            
16             sub AbortDocumentVersionUpload {
17             my $self = shift;
18             my $call_object = $self->new_with_coercions('Paws::WorkDocs::AbortDocumentVersionUpload', @_);
19             return $self->caller->do_call($self, $call_object);
20             }
21             sub ActivateUser {
22             my $self = shift;
23             my $call_object = $self->new_with_coercions('Paws::WorkDocs::ActivateUser', @_);
24             return $self->caller->do_call($self, $call_object);
25             }
26             sub AddResourcePermissions {
27             my $self = shift;
28             my $call_object = $self->new_with_coercions('Paws::WorkDocs::AddResourcePermissions', @_);
29             return $self->caller->do_call($self, $call_object);
30             }
31             sub CreateComment {
32             my $self = shift;
33             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateComment', @_);
34             return $self->caller->do_call($self, $call_object);
35             }
36             sub CreateCustomMetadata {
37             my $self = shift;
38             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateCustomMetadata', @_);
39             return $self->caller->do_call($self, $call_object);
40             }
41             sub CreateFolder {
42             my $self = shift;
43             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateFolder', @_);
44             return $self->caller->do_call($self, $call_object);
45             }
46             sub CreateLabels {
47             my $self = shift;
48             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateLabels', @_);
49             return $self->caller->do_call($self, $call_object);
50             }
51             sub CreateNotificationSubscription {
52             my $self = shift;
53             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateNotificationSubscription', @_);
54             return $self->caller->do_call($self, $call_object);
55             }
56             sub CreateUser {
57             my $self = shift;
58             my $call_object = $self->new_with_coercions('Paws::WorkDocs::CreateUser', @_);
59             return $self->caller->do_call($self, $call_object);
60             }
61             sub DeactivateUser {
62             my $self = shift;
63             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeactivateUser', @_);
64             return $self->caller->do_call($self, $call_object);
65             }
66             sub DeleteComment {
67             my $self = shift;
68             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteComment', @_);
69             return $self->caller->do_call($self, $call_object);
70             }
71             sub DeleteCustomMetadata {
72             my $self = shift;
73             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteCustomMetadata', @_);
74             return $self->caller->do_call($self, $call_object);
75             }
76             sub DeleteDocument {
77             my $self = shift;
78             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteDocument', @_);
79             return $self->caller->do_call($self, $call_object);
80             }
81             sub DeleteFolder {
82             my $self = shift;
83             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteFolder', @_);
84             return $self->caller->do_call($self, $call_object);
85             }
86             sub DeleteFolderContents {
87             my $self = shift;
88             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteFolderContents', @_);
89             return $self->caller->do_call($self, $call_object);
90             }
91             sub DeleteLabels {
92             my $self = shift;
93             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteLabels', @_);
94             return $self->caller->do_call($self, $call_object);
95             }
96             sub DeleteNotificationSubscription {
97             my $self = shift;
98             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteNotificationSubscription', @_);
99             return $self->caller->do_call($self, $call_object);
100             }
101             sub DeleteUser {
102             my $self = shift;
103             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DeleteUser', @_);
104             return $self->caller->do_call($self, $call_object);
105             }
106             sub DescribeActivities {
107             my $self = shift;
108             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeActivities', @_);
109             return $self->caller->do_call($self, $call_object);
110             }
111             sub DescribeComments {
112             my $self = shift;
113             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeComments', @_);
114             return $self->caller->do_call($self, $call_object);
115             }
116             sub DescribeDocumentVersions {
117             my $self = shift;
118             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeDocumentVersions', @_);
119             return $self->caller->do_call($self, $call_object);
120             }
121             sub DescribeFolderContents {
122             my $self = shift;
123             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeFolderContents', @_);
124             return $self->caller->do_call($self, $call_object);
125             }
126             sub DescribeNotificationSubscriptions {
127             my $self = shift;
128             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeNotificationSubscriptions', @_);
129             return $self->caller->do_call($self, $call_object);
130             }
131             sub DescribeResourcePermissions {
132             my $self = shift;
133             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeResourcePermissions', @_);
134             return $self->caller->do_call($self, $call_object);
135             }
136             sub DescribeRootFolders {
137             my $self = shift;
138             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeRootFolders', @_);
139             return $self->caller->do_call($self, $call_object);
140             }
141             sub DescribeUsers {
142             my $self = shift;
143             my $call_object = $self->new_with_coercions('Paws::WorkDocs::DescribeUsers', @_);
144             return $self->caller->do_call($self, $call_object);
145             }
146             sub GetCurrentUser {
147             my $self = shift;
148             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetCurrentUser', @_);
149             return $self->caller->do_call($self, $call_object);
150             }
151             sub GetDocument {
152             my $self = shift;
153             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocument', @_);
154             return $self->caller->do_call($self, $call_object);
155             }
156             sub GetDocumentPath {
157             my $self = shift;
158             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocumentPath', @_);
159             return $self->caller->do_call($self, $call_object);
160             }
161             sub GetDocumentVersion {
162             my $self = shift;
163             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetDocumentVersion', @_);
164             return $self->caller->do_call($self, $call_object);
165             }
166             sub GetFolder {
167             my $self = shift;
168             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetFolder', @_);
169             return $self->caller->do_call($self, $call_object);
170             }
171             sub GetFolderPath {
172             my $self = shift;
173             my $call_object = $self->new_with_coercions('Paws::WorkDocs::GetFolderPath', @_);
174             return $self->caller->do_call($self, $call_object);
175             }
176             sub InitiateDocumentVersionUpload {
177             my $self = shift;
178             my $call_object = $self->new_with_coercions('Paws::WorkDocs::InitiateDocumentVersionUpload', @_);
179             return $self->caller->do_call($self, $call_object);
180             }
181             sub RemoveAllResourcePermissions {
182             my $self = shift;
183             my $call_object = $self->new_with_coercions('Paws::WorkDocs::RemoveAllResourcePermissions', @_);
184             return $self->caller->do_call($self, $call_object);
185             }
186             sub RemoveResourcePermission {
187             my $self = shift;
188             my $call_object = $self->new_with_coercions('Paws::WorkDocs::RemoveResourcePermission', @_);
189             return $self->caller->do_call($self, $call_object);
190             }
191             sub UpdateDocument {
192             my $self = shift;
193             my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateDocument', @_);
194             return $self->caller->do_call($self, $call_object);
195             }
196             sub UpdateDocumentVersion {
197             my $self = shift;
198             my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateDocumentVersion', @_);
199             return $self->caller->do_call($self, $call_object);
200             }
201             sub UpdateFolder {
202             my $self = shift;
203             my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateFolder', @_);
204             return $self->caller->do_call($self, $call_object);
205             }
206             sub UpdateUser {
207             my $self = shift;
208             my $call_object = $self->new_with_coercions('Paws::WorkDocs::UpdateUser', @_);
209             return $self->caller->do_call($self, $call_object);
210             }
211            
212             sub DescribeAllDocumentVersions {
213             my $self = shift;
214              
215             my $callback = shift @_ if (ref($_[0]) eq 'CODE');
216             my $result = $self->DescribeDocumentVersions(@_);
217             my $next_result = $result;
218              
219             if (not defined $callback) {
220             while ($next_result->Marker) {
221             $next_result = $self->DescribeDocumentVersions(@_, Marker => $next_result->Marker);
222             push @{ $result->DocumentVersions }, @{ $next_result->DocumentVersions };
223             }
224             return $result;
225             } else {
226             while ($result->Marker) {
227             $callback->($_ => 'DocumentVersions') foreach (@{ $result->DocumentVersions });
228             $result = $self->DescribeDocumentVersions(@_, Marker => $result->Marker);
229             }
230             $callback->($_ => 'DocumentVersions') foreach (@{ $result->DocumentVersions });
231             }
232              
233             return undef
234             }
235             sub DescribeAllFolderContents {
236             my $self = shift;
237              
238             my $callback = shift @_ if (ref($_[0]) eq 'CODE');
239             my $result = $self->DescribeFolderContents(@_);
240             my $next_result = $result;
241              
242             if (not defined $callback) {
243             while ($next_result->Marker) {
244             $next_result = $self->DescribeFolderContents(@_, Marker => $next_result->Marker);
245             push @{ $result->Folders }, @{ $next_result->Folders };
246             push @{ $result->Documents }, @{ $next_result->Documents };
247             }
248             return $result;
249             } else {
250             while ($result->Marker) {
251             $callback->($_ => 'Folders') foreach (@{ $result->Folders });
252             $callback->($_ => 'Documents') foreach (@{ $result->Documents });
253             $result = $self->DescribeFolderContents(@_, Marker => $result->Marker);
254             }
255             $callback->($_ => 'Folders') foreach (@{ $result->Folders });
256             $callback->($_ => 'Documents') foreach (@{ $result->Documents });
257             }
258              
259             return undef
260             }
261             sub DescribeAllUsers {
262             my $self = shift;
263              
264             my $callback = shift @_ if (ref($_[0]) eq 'CODE');
265             my $result = $self->DescribeUsers(@_);
266             my $next_result = $result;
267              
268             if (not defined $callback) {
269             while ($next_result->Marker) {
270             $next_result = $self->DescribeUsers(@_, Marker => $next_result->Marker);
271             push @{ $result->Users }, @{ $next_result->Users };
272             }
273             return $result;
274             } else {
275             while ($result->Marker) {
276             $callback->($_ => 'Users') foreach (@{ $result->Users });
277             $result = $self->DescribeUsers(@_, Marker => $result->Marker);
278             }
279             $callback->($_ => 'Users') foreach (@{ $result->Users });
280             }
281              
282             return undef
283             }
284              
285              
286             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 DescribeNotificationSubscriptions DescribeResourcePermissions DescribeRootFolders DescribeUsers GetCurrentUser GetDocument GetDocumentPath GetDocumentVersion GetFolder GetFolderPath InitiateDocumentVersionUpload RemoveAllResourcePermissions RemoveResourcePermission UpdateDocument UpdateDocumentVersion UpdateFolder UpdateUser / }
287              
288             1;
289              
290             ### main pod documentation begin ###
291              
292             =head1 NAME
293              
294             Paws::WorkDocs - Perl Interface to AWS Amazon WorkDocs
295              
296             =head1 SYNOPSIS
297              
298             use Paws;
299              
300             my $obj = Paws->service('WorkDocs');
301             my $res = $obj->Method(
302             Arg1 => $val1,
303             Arg2 => [ 'V1', 'V2' ],
304             # if Arg3 is an object, the HashRef will be used as arguments to the constructor
305             # of the arguments type
306             Arg3 => { Att1 => 'Val1' },
307             # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
308             # the constructor of the arguments type
309             Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
310             );
311              
312             =head1 DESCRIPTION
313              
314             The WorkDocs API is designed for the following use cases:
315              
316             =over
317              
318             =item *
319              
320             File Migration: File migration applications are supported for users who
321             want to migrate their files from an on-premise or off-premise file
322             system or service. Users can insert files into a user directory
323             structure, as well as allow for basic metadata changes, such as
324             modifications to the permissions of files.
325              
326             =item *
327              
328             Security: Support security applications are supported for users who
329             have additional security needs, such as anti-virus or data loss
330             prevention. The APIs, in conjunction with Amazon CloudTrail, allow
331             these applications to detect when changes occur in Amazon WorkDocs, so
332             the application can take the necessary actions and replace the target
333             file. The application can also choose to email the user if the target
334             file violates the policy.
335              
336             =item *
337              
338             eDiscovery/Analytics: General administrative applications are
339             supported, such as eDiscovery and analytics. These applications can
340             choose to mimic and/or record the actions in an Amazon WorkDocs site,
341             in conjunction with Amazon CloudTrails, to replicate data for
342             eDiscovery, backup, or analytical applications.
343              
344             =back
345              
346             All Amazon WorkDocs APIs are Amazon authenticated, certificate-signed
347             APIs. They not only require the use of the AWS SDK, but also allow for
348             the exclusive use of IAM users and roles to help facilitate access,
349             trust, and permission policies. By creating a role and allowing an IAM
350             user to access the Amazon WorkDocs site, the IAM user gains full
351             administrative visibility into the entire Amazon WorkDocs site (or as
352             set in the IAM policy). This includes, but is not limited to, the
353             ability to modify file permissions and upload any file to any user.
354             This allows developers to perform the three use cases above, as well as
355             give users the ability to grant access on a selective basis using the
356             IAM model.
357              
358             =head1 METHODS
359              
360             =head2 AbortDocumentVersionUpload(DocumentId => Str, VersionId => Str, [AuthenticationToken => Str])
361              
362             Each argument is described in detail in: L<Paws::WorkDocs::AbortDocumentVersionUpload>
363              
364             Returns: nothing
365              
366             Aborts the upload of the specified document version that was previously
367             initiated by InitiateDocumentVersionUpload. The client should make this
368             call only when it no longer intends to upload the document version, or
369             fails to do so.
370              
371              
372             =head2 ActivateUser(UserId => Str, [AuthenticationToken => Str])
373              
374             Each argument is described in detail in: L<Paws::WorkDocs::ActivateUser>
375              
376             Returns: a L<Paws::WorkDocs::ActivateUserResponse> instance
377              
378             Activates the specified user. Only active users can access Amazon
379             WorkDocs.
380              
381              
382             =head2 AddResourcePermissions(Principals => ArrayRef[L<Paws::WorkDocs::SharePrincipal>], ResourceId => Str, [AuthenticationToken => Str])
383              
384             Each argument is described in detail in: L<Paws::WorkDocs::AddResourcePermissions>
385              
386             Returns: a L<Paws::WorkDocs::AddResourcePermissionsResponse> instance
387              
388             Creates a set of permissions for the specified folder or document. The
389             resource permissions are overwritten if the principals already have
390             different permissions.
391              
392              
393             =head2 CreateComment(DocumentId => Str, Text => Str, VersionId => Str, [AuthenticationToken => Str, NotifyCollaborators => Bool, ParentId => Str, ThreadId => Str, Visibility => Str])
394              
395             Each argument is described in detail in: L<Paws::WorkDocs::CreateComment>
396              
397             Returns: a L<Paws::WorkDocs::CreateCommentResponse> instance
398              
399             Adds a new comment to the specified document version.
400              
401              
402             =head2 CreateCustomMetadata(CustomMetadata => L<Paws::WorkDocs::CustomMetadataMap>, ResourceId => Str, [AuthenticationToken => Str, VersionId => Str])
403              
404             Each argument is described in detail in: L<Paws::WorkDocs::CreateCustomMetadata>
405              
406             Returns: a L<Paws::WorkDocs::CreateCustomMetadataResponse> instance
407              
408             Adds one or more custom properties to the specified resource (a folder,
409             document, or version).
410              
411              
412             =head2 CreateFolder(ParentFolderId => Str, [AuthenticationToken => Str, Name => Str])
413              
414             Each argument is described in detail in: L<Paws::WorkDocs::CreateFolder>
415              
416             Returns: a L<Paws::WorkDocs::CreateFolderResponse> instance
417              
418             Creates a folder with the specified name and parent folder.
419              
420              
421             =head2 CreateLabels(Labels => ArrayRef[Str|Undef], ResourceId => Str, [AuthenticationToken => Str])
422              
423             Each argument is described in detail in: L<Paws::WorkDocs::CreateLabels>
424              
425             Returns: a L<Paws::WorkDocs::CreateLabelsResponse> instance
426              
427             Adds the specified list of labels to the given resource (a document or
428             folder)
429              
430              
431             =head2 CreateNotificationSubscription(Endpoint => Str, OrganizationId => Str, Protocol => Str, SubscriptionType => Str)
432              
433             Each argument is described in detail in: L<Paws::WorkDocs::CreateNotificationSubscription>
434              
435             Returns: a L<Paws::WorkDocs::CreateNotificationSubscriptionResponse> instance
436              
437             Configure WorkDocs to use Amazon SNS notifications.
438              
439             The endpoint receives a confirmation message, and must confirm the
440             subscription. For more information, see Confirm the Subscription in the
441             I<Amazon Simple Notification Service Developer Guide>.
442              
443              
444             =head2 CreateUser(GivenName => Str, Password => Str, Surname => Str, Username => Str, [AuthenticationToken => Str, EmailAddress => Str, OrganizationId => Str, StorageRule => L<Paws::WorkDocs::StorageRuleType>, TimeZoneId => Str])
445              
446             Each argument is described in detail in: L<Paws::WorkDocs::CreateUser>
447              
448             Returns: a L<Paws::WorkDocs::CreateUserResponse> instance
449              
450             Creates a user in a Simple AD or Microsoft AD directory. The status of
451             a newly created user is "ACTIVE". New users can access Amazon WorkDocs.
452              
453              
454             =head2 DeactivateUser(UserId => Str, [AuthenticationToken => Str])
455              
456             Each argument is described in detail in: L<Paws::WorkDocs::DeactivateUser>
457              
458             Returns: nothing
459              
460             Deactivates the specified user, which revokes the user's access to
461             Amazon WorkDocs.
462              
463              
464             =head2 DeleteComment(CommentId => Str, DocumentId => Str, VersionId => Str, [AuthenticationToken => Str])
465              
466             Each argument is described in detail in: L<Paws::WorkDocs::DeleteComment>
467              
468             Returns: nothing
469              
470             Deletes the specified comment from the document version.
471              
472              
473             =head2 DeleteCustomMetadata(ResourceId => Str, [AuthenticationToken => Str, DeleteAll => Bool, Keys => ArrayRef[Str|Undef], VersionId => Str])
474              
475             Each argument is described in detail in: L<Paws::WorkDocs::DeleteCustomMetadata>
476              
477             Returns: a L<Paws::WorkDocs::DeleteCustomMetadataResponse> instance
478              
479             Deletes custom metadata from the specified resource.
480              
481              
482             =head2 DeleteDocument(DocumentId => Str, [AuthenticationToken => Str])
483              
484             Each argument is described in detail in: L<Paws::WorkDocs::DeleteDocument>
485              
486             Returns: nothing
487              
488             Permanently deletes the specified document and its associated metadata.
489              
490              
491             =head2 DeleteFolder(FolderId => Str, [AuthenticationToken => Str])
492              
493             Each argument is described in detail in: L<Paws::WorkDocs::DeleteFolder>
494              
495             Returns: nothing
496              
497             Permanently deletes the specified folder and its contents.
498              
499              
500             =head2 DeleteFolderContents(FolderId => Str, [AuthenticationToken => Str])
501              
502             Each argument is described in detail in: L<Paws::WorkDocs::DeleteFolderContents>
503              
504             Returns: nothing
505              
506             Deletes the contents of the specified folder.
507              
508              
509             =head2 DeleteLabels(ResourceId => Str, [AuthenticationToken => Str, DeleteAll => Bool, Labels => ArrayRef[Str|Undef]])
510              
511             Each argument is described in detail in: L<Paws::WorkDocs::DeleteLabels>
512              
513             Returns: a L<Paws::WorkDocs::DeleteLabelsResponse> instance
514              
515             Deletes the specified list of labels from a resource.
516              
517              
518             =head2 DeleteNotificationSubscription(OrganizationId => Str, SubscriptionId => Str)
519              
520             Each argument is described in detail in: L<Paws::WorkDocs::DeleteNotificationSubscription>
521              
522             Returns: nothing
523              
524             Deletes the specified subscription from the specified organization.
525              
526              
527             =head2 DeleteUser(UserId => Str, [AuthenticationToken => Str])
528              
529             Each argument is described in detail in: L<Paws::WorkDocs::DeleteUser>
530              
531             Returns: nothing
532              
533             Deletes the specified user from a Simple AD or Microsoft AD directory.
534              
535              
536             =head2 DescribeActivities([AuthenticationToken => Str, EndTime => Str, Limit => Int, Marker => Str, OrganizationId => Str, StartTime => Str, UserId => Str])
537              
538             Each argument is described in detail in: L<Paws::WorkDocs::DescribeActivities>
539              
540             Returns: a L<Paws::WorkDocs::DescribeActivitiesResponse> instance
541              
542             Describes the user activities in a specified time period.
543              
544              
545             =head2 DescribeComments(DocumentId => Str, VersionId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str])
546              
547             Each argument is described in detail in: L<Paws::WorkDocs::DescribeComments>
548              
549             Returns: a L<Paws::WorkDocs::DescribeCommentsResponse> instance
550              
551             List all the comments for the specified document version.
552              
553              
554             =head2 DescribeDocumentVersions(DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str])
555              
556             Each argument is described in detail in: L<Paws::WorkDocs::DescribeDocumentVersions>
557              
558             Returns: a L<Paws::WorkDocs::DescribeDocumentVersionsResponse> instance
559              
560             Retrieves the document versions for the specified document.
561              
562             By default, only active versions are returned.
563              
564              
565             =head2 DescribeFolderContents(FolderId => Str, [AuthenticationToken => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, Sort => Str, Type => Str])
566              
567             Each argument is described in detail in: L<Paws::WorkDocs::DescribeFolderContents>
568              
569             Returns: a L<Paws::WorkDocs::DescribeFolderContentsResponse> instance
570              
571             Describes the contents of the specified folder, including its documents
572             and subfolders.
573              
574             By default, Amazon WorkDocs returns the first 100 active document and
575             folder metadata items. If there are more results, the response includes
576             a marker that you can use to request the next set of results. You can
577             also request initialized documents.
578              
579              
580             =head2 DescribeNotificationSubscriptions(OrganizationId => Str, [Limit => Int, Marker => Str])
581              
582             Each argument is described in detail in: L<Paws::WorkDocs::DescribeNotificationSubscriptions>
583              
584             Returns: a L<Paws::WorkDocs::DescribeNotificationSubscriptionsResponse> instance
585              
586             Lists the specified notification subscriptions.
587              
588              
589             =head2 DescribeResourcePermissions(ResourceId => Str, [AuthenticationToken => Str, Limit => Int, Marker => Str])
590              
591             Each argument is described in detail in: L<Paws::WorkDocs::DescribeResourcePermissions>
592              
593             Returns: a L<Paws::WorkDocs::DescribeResourcePermissionsResponse> instance
594              
595             Describes the permissions of a specified resource.
596              
597              
598             =head2 DescribeRootFolders(AuthenticationToken => Str, [Limit => Int, Marker => Str])
599              
600             Each argument is described in detail in: L<Paws::WorkDocs::DescribeRootFolders>
601              
602             Returns: a L<Paws::WorkDocs::DescribeRootFoldersResponse> instance
603              
604             Describes the current user's special folders; the C<RootFolder> and the
605             C<RecyleBin>. C<RootFolder> is the root of user's files and folders and
606             C<RecyleBin> is the root of recycled items. This is not a valid action
607             for SigV4 (administrative API) clients.
608              
609              
610             =head2 DescribeUsers([AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, OrganizationId => Str, Query => Str, Sort => Str, UserIds => Str])
611              
612             Each argument is described in detail in: L<Paws::WorkDocs::DescribeUsers>
613              
614             Returns: a L<Paws::WorkDocs::DescribeUsersResponse> instance
615              
616             Describes the specified users. You can describe all users or filter the
617             results (for example, by status or organization).
618              
619             By default, Amazon WorkDocs returns the first 24 active or pending
620             users. If there are more results, the response includes a marker that
621             you can use to request the next set of results.
622              
623              
624             =head2 GetCurrentUser(AuthenticationToken => Str)
625              
626             Each argument is described in detail in: L<Paws::WorkDocs::GetCurrentUser>
627              
628             Returns: a L<Paws::WorkDocs::GetCurrentUserResponse> instance
629              
630             Retrieves details of the current user for whom the authentication token
631             was generated. This is not a valid action for SigV4 (administrative
632             API) clients.
633              
634              
635             =head2 GetDocument(DocumentId => Str, [AuthenticationToken => Str, IncludeCustomMetadata => Bool])
636              
637             Each argument is described in detail in: L<Paws::WorkDocs::GetDocument>
638              
639             Returns: a L<Paws::WorkDocs::GetDocumentResponse> instance
640              
641             Retrieves details of a document.
642              
643              
644             =head2 GetDocumentPath(DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Limit => Int, Marker => Str])
645              
646             Each argument is described in detail in: L<Paws::WorkDocs::GetDocumentPath>
647              
648             Returns: a L<Paws::WorkDocs::GetDocumentPathResponse> instance
649              
650             Retrieves the path information (the hierarchy from the root folder) for
651             the requested document.
652              
653             By default, Amazon WorkDocs returns a maximum of 100 levels upwards
654             from the requested document and only includes the IDs of the parent
655             folders in the path. You can limit the maximum number of levels. You
656             can also request the names of the parent folders.
657              
658              
659             =head2 GetDocumentVersion(DocumentId => Str, VersionId => Str, [AuthenticationToken => Str, Fields => Str, IncludeCustomMetadata => Bool])
660              
661             Each argument is described in detail in: L<Paws::WorkDocs::GetDocumentVersion>
662              
663             Returns: a L<Paws::WorkDocs::GetDocumentVersionResponse> instance
664              
665             Retrieves version metadata for the specified document.
666              
667              
668             =head2 GetFolder(FolderId => Str, [AuthenticationToken => Str, IncludeCustomMetadata => Bool])
669              
670             Each argument is described in detail in: L<Paws::WorkDocs::GetFolder>
671              
672             Returns: a L<Paws::WorkDocs::GetFolderResponse> instance
673              
674             Retrieves the metadata of the specified folder.
675              
676              
677             =head2 GetFolderPath(FolderId => Str, [AuthenticationToken => Str, Fields => Str, Limit => Int, Marker => Str])
678              
679             Each argument is described in detail in: L<Paws::WorkDocs::GetFolderPath>
680              
681             Returns: a L<Paws::WorkDocs::GetFolderPathResponse> instance
682              
683             Retrieves the path information (the hierarchy from the root folder) for
684             the specified folder.
685              
686             By default, Amazon WorkDocs returns a maximum of 100 levels upwards
687             from the requested folder and only includes the IDs of the parent
688             folders in the path. You can limit the maximum number of levels. You
689             can also request the parent folder names.
690              
691              
692             =head2 InitiateDocumentVersionUpload(ParentFolderId => Str, [AuthenticationToken => Str, ContentCreatedTimestamp => Str, ContentModifiedTimestamp => Str, ContentType => Str, DocumentSizeInBytes => Int, Id => Str, Name => Str])
693              
694             Each argument is described in detail in: L<Paws::WorkDocs::InitiateDocumentVersionUpload>
695              
696             Returns: a L<Paws::WorkDocs::InitiateDocumentVersionUploadResponse> instance
697              
698             Creates a new document object and version object.
699              
700             The client specifies the parent folder ID and name of the document to
701             upload. The ID is optionally specified when creating a new version of
702             an existing document. This is the first step to upload a document.
703             Next, upload the document to the URL returned from the call, and then
704             call UpdateDocumentVersion.
705              
706             To cancel the document upload, call AbortDocumentVersionUpload.
707              
708              
709             =head2 RemoveAllResourcePermissions(ResourceId => Str, [AuthenticationToken => Str])
710              
711             Each argument is described in detail in: L<Paws::WorkDocs::RemoveAllResourcePermissions>
712              
713             Returns: nothing
714              
715             Removes all the permissions from the specified resource.
716              
717              
718             =head2 RemoveResourcePermission(PrincipalId => Str, ResourceId => Str, [AuthenticationToken => Str, PrincipalType => Str])
719              
720             Each argument is described in detail in: L<Paws::WorkDocs::RemoveResourcePermission>
721              
722             Returns: nothing
723              
724             Removes the permission for the specified principal from the specified
725             resource.
726              
727              
728             =head2 UpdateDocument(DocumentId => Str, [AuthenticationToken => Str, Name => Str, ParentFolderId => Str, ResourceState => Str])
729              
730             Each argument is described in detail in: L<Paws::WorkDocs::UpdateDocument>
731              
732             Returns: nothing
733              
734             Updates the specified attributes of a document. The user must have
735             access to both the document and its parent folder, if applicable.
736              
737              
738             =head2 UpdateDocumentVersion(DocumentId => Str, VersionId => Str, [AuthenticationToken => Str, VersionStatus => Str])
739              
740             Each argument is described in detail in: L<Paws::WorkDocs::UpdateDocumentVersion>
741              
742             Returns: nothing
743              
744             Changes the status of the document version to ACTIVE.
745              
746             Amazon WorkDocs also sets its document container to ACTIVE. This is the
747             last step in a document upload, after the client uploads the document
748             to an S3-presigned URL returned by InitiateDocumentVersionUpload.
749              
750              
751             =head2 UpdateFolder(FolderId => Str, [AuthenticationToken => Str, Name => Str, ParentFolderId => Str, ResourceState => Str])
752              
753             Each argument is described in detail in: L<Paws::WorkDocs::UpdateFolder>
754              
755             Returns: nothing
756              
757             Updates the specified attributes of the specified folder. The user must
758             have access to both the folder and its parent folder, if applicable.
759              
760              
761             =head2 UpdateUser(UserId => Str, [AuthenticationToken => Str, GivenName => Str, Locale => Str, StorageRule => L<Paws::WorkDocs::StorageRuleType>, Surname => Str, TimeZoneId => Str, Type => Str])
762              
763             Each argument is described in detail in: L<Paws::WorkDocs::UpdateUser>
764              
765             Returns: a L<Paws::WorkDocs::UpdateUserResponse> instance
766              
767             Updates the specified attributes of the specified user, and grants or
768             revokes administrative privileges to the Amazon WorkDocs site.
769              
770              
771              
772              
773             =head1 PAGINATORS
774              
775             Paginator methods are helpers that repetively call methods that return partial results
776              
777             =head2 DescribeAllDocumentVersions(sub { },DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str])
778              
779             =head2 DescribeAllDocumentVersions(DocumentId => Str, [AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str])
780              
781              
782             If passed a sub as first parameter, it will call the sub for each element found in :
783              
784             - DocumentVersions, passing the object as the first parameter, and the string 'DocumentVersions' as the second parameter
785              
786             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.
787              
788              
789             =head2 DescribeAllFolderContents(sub { },FolderId => Str, [AuthenticationToken => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, Sort => Str, Type => Str])
790              
791             =head2 DescribeAllFolderContents(FolderId => Str, [AuthenticationToken => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, Sort => Str, Type => Str])
792              
793              
794             If passed a sub as first parameter, it will call the sub for each element found in :
795              
796             - Folders, passing the object as the first parameter, and the string 'Folders' as the second parameter
797              
798             - Documents, passing the object as the first parameter, and the string 'Documents' as the second parameter
799              
800             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.
801              
802              
803             =head2 DescribeAllUsers(sub { },[AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, OrganizationId => Str, Query => Str, Sort => Str, UserIds => Str])
804              
805             =head2 DescribeAllUsers([AuthenticationToken => Str, Fields => Str, Include => Str, Limit => Int, Marker => Str, Order => Str, OrganizationId => Str, Query => Str, Sort => Str, UserIds => Str])
806              
807              
808             If passed a sub as first parameter, it will call the sub for each element found in :
809              
810             - Users, passing the object as the first parameter, and the string 'Users' as the second parameter
811              
812             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.
813              
814              
815              
816              
817              
818             =head1 SEE ALSO
819              
820             This service class forms part of L<Paws>
821              
822             =head1 BUGS and CONTRIBUTIONS
823              
824             The source code is located here: https://github.com/pplu/aws-sdk-perl
825              
826             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
827              
828             =cut
829