aws-sdk-workdocs 1.0.0.rc5 → 1.0.0.rc6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 461ee2432b55fa1727c64dd8c346ca6bd7d647cc
4
- data.tar.gz: 5407d8f6bef598cfedb9c0f38c4c5b7e3f40fee8
3
+ metadata.gz: 1f3dbe7e9a2da9a51ba1b5a06e18b07082faea12
4
+ data.tar.gz: a019fdb2dc560e2afd39bfec493e5c560c786d1f
5
5
  SHA512:
6
- metadata.gz: 1e1a98b2719cc868ce7316ea178dab294849781f499baab6144671e70a0c94558cd7e69da0c23523e39e91bebe045726b8b7b18fa3e20f3b2f7d520ea9da1ecc
7
- data.tar.gz: 60fbaa6b2f3c264c40f2c281543b1048b00f1ccc27c54ef99a47512d93a54f87b6418821d0604f1569e80b48b343c023820779d746f84155e8ed20dc168b64ed
6
+ metadata.gz: a1ae68fa15f8f55c23772fbae1df2fd058a5702325258a6f24282676ff3b056164b01b4320bb575a9e64725d0edbc82735f789f2e148e3b00af0123b562b2d35
7
+ data.tar.gz: b077df4cd052bdbaea8f163ab3bd3ebe9c127ec7c14fa2187c794cdc1f813df142c59ba014ac1636d31494f9c89710e7a21fd0f19c223e47d20fe45d4df2cda8
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-workdocs/customizations'
42
42
  # @service
43
43
  module Aws::WorkDocs
44
44
 
45
- GEM_VERSION = '1.0.0.rc5'
45
+ GEM_VERSION = '1.0.0.rc6'
46
46
 
47
47
  end
@@ -147,8 +147,13 @@ module Aws::WorkDocs
147
147
 
148
148
  # Aborts the upload of the specified document version that was
149
149
  # previously initiated by InitiateDocumentVersionUpload. The client
150
- # should make this call only when it no longer intends or fails to
151
- # upload the document version.
150
+ # should make this call only when it no longer intends to upload the
151
+ # document version, or fails to do so.
152
+ #
153
+ # @option params [String] :authentication_token
154
+ # Amazon WorkDocs authentication token. This field should not be set
155
+ # when using administrative API actions, as in accessing the API using
156
+ # AWS credentials.
152
157
  #
153
158
  # @option params [required, String] :document_id
154
159
  # The ID of the document.
@@ -161,6 +166,7 @@ module Aws::WorkDocs
161
166
  # @example Request syntax with placeholder values
162
167
  #
163
168
  # resp = client.abort_document_version_upload({
169
+ # authentication_token: "AuthenticationHeaderType",
164
170
  # document_id: "ResourceIdType", # required
165
171
  # version_id: "DocumentVersionIdType", # required
166
172
  # })
@@ -180,6 +186,11 @@ module Aws::WorkDocs
180
186
  # @option params [required, String] :user_id
181
187
  # The ID of the user.
182
188
  #
189
+ # @option params [String] :authentication_token
190
+ # Amazon WorkDocs authentication token. This field should not be set
191
+ # when using administrative API actions, as in accessing the API using
192
+ # AWS credentials.
193
+ #
183
194
  # @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
184
195
  #
185
196
  # * {Types::ActivateUserResponse#user #user} => Types::User
@@ -188,6 +199,7 @@ module Aws::WorkDocs
188
199
  #
189
200
  # resp = client.activate_user({
190
201
  # user_id: "IdType", # required
202
+ # authentication_token: "AuthenticationHeaderType",
191
203
  # })
192
204
  #
193
205
  # @example Response structure
@@ -223,6 +235,11 @@ module Aws::WorkDocs
223
235
  # resource permissions are overwritten if the principals already have
224
236
  # different permissions.
225
237
  #
238
+ # @option params [String] :authentication_token
239
+ # Amazon WorkDocs authentication token. This field should not be set
240
+ # when using administrative API actions, as in accessing the API using
241
+ # AWS credentials.
242
+ #
226
243
  # @option params [required, String] :resource_id
227
244
  # The ID of the resource.
228
245
  #
@@ -236,6 +253,7 @@ module Aws::WorkDocs
236
253
  # @example Request syntax with placeholder values
237
254
  #
238
255
  # resp = client.add_resource_permissions({
256
+ # authentication_token: "AuthenticationHeaderType",
239
257
  # resource_id: "ResourceIdType", # required
240
258
  # principals: [ # required
241
259
  # {
@@ -264,8 +282,139 @@ module Aws::WorkDocs
264
282
  req.send_request(options)
265
283
  end
266
284
 
285
+ # Adds a new comment to the specified document version.
286
+ #
287
+ # @option params [String] :authentication_token
288
+ # Amazon WorkDocs authentication token. This field should not be set
289
+ # when using administrative API actions, as in accessing the API using
290
+ # AWS credentials.
291
+ #
292
+ # @option params [required, String] :document_id
293
+ # The ID of the document.
294
+ #
295
+ # @option params [required, String] :version_id
296
+ # The ID of the document version.
297
+ #
298
+ # @option params [String] :parent_id
299
+ # The ID of the parent comment.
300
+ #
301
+ # @option params [String] :thread_id
302
+ # The ID of the root comment in the thread.
303
+ #
304
+ # @option params [required, String] :text
305
+ # The text of the comment.
306
+ #
307
+ # @option params [String] :visibility
308
+ # The visibility of the comment. Options are either PRIVATE, where the
309
+ # comment is visible only to the comment author and document owner and
310
+ # co-owners, or PUBLIC, where the comment is visible to document owners,
311
+ # co-owners, and contributors.
312
+ #
313
+ # @option params [Boolean] :notify_collaborators
314
+ # Set this parameter to TRUE to send an email out to the document
315
+ # collaborators after the comment is created.
316
+ #
317
+ # @return [Types::CreateCommentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
318
+ #
319
+ # * {Types::CreateCommentResponse#comment #comment} => Types::Comment
320
+ #
321
+ # @example Request syntax with placeholder values
322
+ #
323
+ # resp = client.create_comment({
324
+ # authentication_token: "AuthenticationHeaderType",
325
+ # document_id: "ResourceIdType", # required
326
+ # version_id: "DocumentVersionIdType", # required
327
+ # parent_id: "CommentIdType",
328
+ # thread_id: "CommentIdType",
329
+ # text: "CommentTextType", # required
330
+ # visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
331
+ # notify_collaborators: false,
332
+ # })
333
+ #
334
+ # @example Response structure
335
+ #
336
+ # resp.comment.comment_id #=> String
337
+ # resp.comment.parent_id #=> String
338
+ # resp.comment.thread_id #=> String
339
+ # resp.comment.text #=> String
340
+ # resp.comment.contributor.id #=> String
341
+ # resp.comment.contributor.username #=> String
342
+ # resp.comment.contributor.email_address #=> String
343
+ # resp.comment.contributor.given_name #=> String
344
+ # resp.comment.contributor.surname #=> String
345
+ # resp.comment.contributor.organization_id #=> String
346
+ # resp.comment.contributor.root_folder_id #=> String
347
+ # resp.comment.contributor.recycle_bin_folder_id #=> String
348
+ # resp.comment.contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
349
+ # resp.comment.contributor.type #=> String, one of "USER", "ADMIN"
350
+ # resp.comment.contributor.created_timestamp #=> Time
351
+ # resp.comment.contributor.modified_timestamp #=> Time
352
+ # resp.comment.contributor.time_zone_id #=> String
353
+ # resp.comment.contributor.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
354
+ # resp.comment.contributor.storage.storage_utilized_in_bytes #=> Integer
355
+ # resp.comment.contributor.storage.storage_rule.storage_allocated_in_bytes #=> Integer
356
+ # resp.comment.contributor.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"
357
+ # resp.comment.created_timestamp #=> Time
358
+ # resp.comment.status #=> String, one of "DRAFT", "PUBLISHED", "DELETED"
359
+ # resp.comment.visibility #=> String, one of "PUBLIC", "PRIVATE"
360
+ # resp.comment.recipient_id #=> String
361
+ #
362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateComment AWS API Documentation
363
+ #
364
+ # @overload create_comment(params = {})
365
+ # @param [Hash] params ({})
366
+ def create_comment(params = {}, options = {})
367
+ req = build_request(:create_comment, params)
368
+ req.send_request(options)
369
+ end
370
+
371
+ # Adds one or more custom properties to the specified resource (a
372
+ # folder, document, or version).
373
+ #
374
+ # @option params [String] :authentication_token
375
+ # Amazon WorkDocs authentication token. This field should not be set
376
+ # when using administrative API actions, as in accessing the API using
377
+ # AWS credentials.
378
+ #
379
+ # @option params [required, String] :resource_id
380
+ # The ID of the resource.
381
+ #
382
+ # @option params [String] :version_id
383
+ # The ID of the version, if the custom metadata is being added to a
384
+ # document version.
385
+ #
386
+ # @option params [required, Hash<String,String>] :custom_metadata
387
+ # Custom metadata in the form of name-value pairs.
388
+ #
389
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
390
+ #
391
+ # @example Request syntax with placeholder values
392
+ #
393
+ # resp = client.create_custom_metadata({
394
+ # authentication_token: "AuthenticationHeaderType",
395
+ # resource_id: "ResourceIdType", # required
396
+ # version_id: "DocumentVersionIdType",
397
+ # custom_metadata: { # required
398
+ # "CustomMetadataKeyType" => "CustomMetadataValueType",
399
+ # },
400
+ # })
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadata AWS API Documentation
403
+ #
404
+ # @overload create_custom_metadata(params = {})
405
+ # @param [Hash] params ({})
406
+ def create_custom_metadata(params = {}, options = {})
407
+ req = build_request(:create_custom_metadata, params)
408
+ req.send_request(options)
409
+ end
410
+
267
411
  # Creates a folder with the specified name and parent folder.
268
412
  #
413
+ # @option params [String] :authentication_token
414
+ # Amazon WorkDocs authentication token. This field should not be set
415
+ # when using administrative API actions, as in accessing the API using
416
+ # AWS credentials.
417
+ #
269
418
  # @option params [String] :name
270
419
  # The name of the new folder.
271
420
  #
@@ -279,6 +428,7 @@ module Aws::WorkDocs
279
428
  # @example Request syntax with placeholder values
280
429
  #
281
430
  # resp = client.create_folder({
431
+ # authentication_token: "AuthenticationHeaderType",
282
432
  # name: "ResourceNameType",
283
433
  # parent_folder_id: "ResourceIdType", # required
284
434
  # })
@@ -293,6 +443,10 @@ module Aws::WorkDocs
293
443
  # resp.metadata.modified_timestamp #=> Time
294
444
  # resp.metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
295
445
  # resp.metadata.signature #=> String
446
+ # resp.metadata.labels #=> Array
447
+ # resp.metadata.labels[0] #=> String
448
+ # resp.metadata.size #=> Integer
449
+ # resp.metadata.latest_version_size #=> Integer
296
450
  #
297
451
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolder AWS API Documentation
298
452
  #
@@ -303,6 +457,39 @@ module Aws::WorkDocs
303
457
  req.send_request(options)
304
458
  end
305
459
 
460
+ # Adds the specified list of labels to the given resource (a document or
461
+ # folder)
462
+ #
463
+ # @option params [required, String] :resource_id
464
+ # The ID of the resource.
465
+ #
466
+ # @option params [required, Array<String>] :labels
467
+ # List of labels to add to the resource.
468
+ #
469
+ # @option params [String] :authentication_token
470
+ # Amazon WorkDocs authentication token. This field should not be set
471
+ # when using administrative API actions, as in accessing the API using
472
+ # AWS credentials.
473
+ #
474
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
475
+ #
476
+ # @example Request syntax with placeholder values
477
+ #
478
+ # resp = client.create_labels({
479
+ # resource_id: "ResourceIdType", # required
480
+ # labels: ["Label"], # required
481
+ # authentication_token: "AuthenticationHeaderType",
482
+ # })
483
+ #
484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabels AWS API Documentation
485
+ #
486
+ # @overload create_labels(params = {})
487
+ # @param [Hash] params ({})
488
+ def create_labels(params = {}, options = {})
489
+ req = build_request(:create_labels, params)
490
+ req.send_request(options)
491
+ end
492
+
306
493
  # Configure WorkDocs to use Amazon SNS notifications.
307
494
  #
308
495
  # The endpoint receives a confirmation message, and must confirm the
@@ -365,6 +552,9 @@ module Aws::WorkDocs
365
552
  # @option params [required, String] :username
366
553
  # The login name of the user.
367
554
  #
555
+ # @option params [String] :email_address
556
+ # The email address of the user.
557
+ #
368
558
  # @option params [required, String] :given_name
369
559
  # The given name of the user.
370
560
  #
@@ -380,6 +570,11 @@ module Aws::WorkDocs
380
570
  # @option params [Types::StorageRuleType] :storage_rule
381
571
  # The amount of storage for the user.
382
572
  #
573
+ # @option params [String] :authentication_token
574
+ # Amazon WorkDocs authentication token. This field should not be set
575
+ # when using administrative API actions, as in accessing the API using
576
+ # AWS credentials.
577
+ #
383
578
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
384
579
  #
385
580
  # * {Types::CreateUserResponse#user #user} => Types::User
@@ -389,6 +584,7 @@ module Aws::WorkDocs
389
584
  # resp = client.create_user({
390
585
  # organization_id: "IdType",
391
586
  # username: "UsernameType", # required
587
+ # email_address: "EmailAddressType",
392
588
  # given_name: "UserAttributeValueType", # required
393
589
  # surname: "UserAttributeValueType", # required
394
590
  # password: "PasswordType", # required
@@ -397,6 +593,7 @@ module Aws::WorkDocs
397
593
  # storage_allocated_in_bytes: 1,
398
594
  # storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
399
595
  # },
596
+ # authentication_token: "AuthenticationHeaderType",
400
597
  # })
401
598
  #
402
599
  # @example Response structure
@@ -434,12 +631,18 @@ module Aws::WorkDocs
434
631
  # @option params [required, String] :user_id
435
632
  # The ID of the user.
436
633
  #
634
+ # @option params [String] :authentication_token
635
+ # Amazon WorkDocs authentication token. This field should not be set
636
+ # when using administrative API actions, as in accessing the API using
637
+ # AWS credentials.
638
+ #
437
639
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
438
640
  #
439
641
  # @example Request syntax with placeholder values
440
642
  #
441
643
  # resp = client.deactivate_user({
442
644
  # user_id: "IdType", # required
645
+ # authentication_token: "AuthenticationHeaderType",
443
646
  # })
444
647
  #
445
648
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUser AWS API Documentation
@@ -451,9 +654,92 @@ module Aws::WorkDocs
451
654
  req.send_request(options)
452
655
  end
453
656
 
657
+ # Deletes the specified comment from the document version.
658
+ #
659
+ # @option params [String] :authentication_token
660
+ # Amazon WorkDocs authentication token. This field should not be set
661
+ # when using administrative API actions, as in accessing the API using
662
+ # AWS credentials.
663
+ #
664
+ # @option params [required, String] :document_id
665
+ # The ID of the document.
666
+ #
667
+ # @option params [required, String] :version_id
668
+ # The ID of the document version.
669
+ #
670
+ # @option params [required, String] :comment_id
671
+ # The ID of the comment.
672
+ #
673
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
674
+ #
675
+ # @example Request syntax with placeholder values
676
+ #
677
+ # resp = client.delete_comment({
678
+ # authentication_token: "AuthenticationHeaderType",
679
+ # document_id: "ResourceIdType", # required
680
+ # version_id: "DocumentVersionIdType", # required
681
+ # comment_id: "CommentIdType", # required
682
+ # })
683
+ #
684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteComment AWS API Documentation
685
+ #
686
+ # @overload delete_comment(params = {})
687
+ # @param [Hash] params ({})
688
+ def delete_comment(params = {}, options = {})
689
+ req = build_request(:delete_comment, params)
690
+ req.send_request(options)
691
+ end
692
+
693
+ # Deletes custom metadata from the specified resource.
694
+ #
695
+ # @option params [String] :authentication_token
696
+ # Amazon WorkDocs authentication token. This field should not be set
697
+ # when using administrative API actions, as in accessing the API using
698
+ # AWS credentials.
699
+ #
700
+ # @option params [required, String] :resource_id
701
+ # The ID of the resource, either a document or folder.
702
+ #
703
+ # @option params [String] :version_id
704
+ # The ID of the version, if the custom metadata is being deleted from a
705
+ # document version.
706
+ #
707
+ # @option params [Array<String>] :keys
708
+ # List of properties to remove.
709
+ #
710
+ # @option params [Boolean] :delete_all
711
+ # Flag to indicate removal of all custom metadata properties from the
712
+ # specified resource.
713
+ #
714
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
715
+ #
716
+ # @example Request syntax with placeholder values
717
+ #
718
+ # resp = client.delete_custom_metadata({
719
+ # authentication_token: "AuthenticationHeaderType",
720
+ # resource_id: "ResourceIdType", # required
721
+ # version_id: "DocumentVersionIdType",
722
+ # keys: ["CustomMetadataKeyType"],
723
+ # delete_all: false,
724
+ # })
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata AWS API Documentation
727
+ #
728
+ # @overload delete_custom_metadata(params = {})
729
+ # @param [Hash] params ({})
730
+ def delete_custom_metadata(params = {}, options = {})
731
+ req = build_request(:delete_custom_metadata, params)
732
+ req.send_request(options)
733
+ end
734
+
454
735
  # Permanently deletes the specified document and its associated
455
736
  # metadata.
456
737
  #
738
+ # @option params [String] :authentication_token
739
+ # Amazon WorkDocs authentication token. This field should not be set
740
+ # when using administrative API actions, as in accessing the API using
741
+ # AWS credentials.
742
+ #
457
743
  # @option params [required, String] :document_id
458
744
  # The ID of the document.
459
745
  #
@@ -462,6 +748,7 @@ module Aws::WorkDocs
462
748
  # @example Request syntax with placeholder values
463
749
  #
464
750
  # resp = client.delete_document({
751
+ # authentication_token: "AuthenticationHeaderType",
465
752
  # document_id: "ResourceIdType", # required
466
753
  # })
467
754
  #
@@ -476,6 +763,11 @@ module Aws::WorkDocs
476
763
 
477
764
  # Permanently deletes the specified folder and its contents.
478
765
  #
766
+ # @option params [String] :authentication_token
767
+ # Amazon WorkDocs authentication token. This field should not be set
768
+ # when using administrative API actions, as in accessing the API using
769
+ # AWS credentials.
770
+ #
479
771
  # @option params [required, String] :folder_id
480
772
  # The ID of the folder.
481
773
  #
@@ -484,6 +776,7 @@ module Aws::WorkDocs
484
776
  # @example Request syntax with placeholder values
485
777
  #
486
778
  # resp = client.delete_folder({
779
+ # authentication_token: "AuthenticationHeaderType",
487
780
  # folder_id: "ResourceIdType", # required
488
781
  # })
489
782
  #
@@ -498,6 +791,11 @@ module Aws::WorkDocs
498
791
 
499
792
  # Deletes the contents of the specified folder.
500
793
  #
794
+ # @option params [String] :authentication_token
795
+ # Amazon WorkDocs authentication token. This field should not be set
796
+ # when using administrative API actions, as in accessing the API using
797
+ # AWS credentials.
798
+ #
501
799
  # @option params [required, String] :folder_id
502
800
  # The ID of the folder.
503
801
  #
@@ -506,6 +804,7 @@ module Aws::WorkDocs
506
804
  # @example Request syntax with placeholder values
507
805
  #
508
806
  # resp = client.delete_folder_contents({
807
+ # authentication_token: "AuthenticationHeaderType",
509
808
  # folder_id: "ResourceIdType", # required
510
809
  # })
511
810
  #
@@ -518,6 +817,42 @@ module Aws::WorkDocs
518
817
  req.send_request(options)
519
818
  end
520
819
 
820
+ # Deletes the specified list of labels from a resource.
821
+ #
822
+ # @option params [required, String] :resource_id
823
+ # The ID of the resource.
824
+ #
825
+ # @option params [String] :authentication_token
826
+ # Amazon WorkDocs authentication token. This field should not be set
827
+ # when using administrative API actions, as in accessing the API using
828
+ # AWS credentials.
829
+ #
830
+ # @option params [Array<String>] :labels
831
+ # List of labels to delete from the resource.
832
+ #
833
+ # @option params [Boolean] :delete_all
834
+ # Flag to request removal of all labels from the specified resource.
835
+ #
836
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
837
+ #
838
+ # @example Request syntax with placeholder values
839
+ #
840
+ # resp = client.delete_labels({
841
+ # resource_id: "ResourceIdType", # required
842
+ # authentication_token: "AuthenticationHeaderType",
843
+ # labels: ["Label"],
844
+ # delete_all: false,
845
+ # })
846
+ #
847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabels AWS API Documentation
848
+ #
849
+ # @overload delete_labels(params = {})
850
+ # @param [Hash] params ({})
851
+ def delete_labels(params = {}, options = {})
852
+ req = build_request(:delete_labels, params)
853
+ req.send_request(options)
854
+ end
855
+
521
856
  # Deletes the specified subscription from the specified organization.
522
857
  #
523
858
  # @option params [required, String] :subscription_id
@@ -546,6 +881,11 @@ module Aws::WorkDocs
546
881
 
547
882
  # Deletes the specified user from a Simple AD or Microsoft AD directory.
548
883
  #
884
+ # @option params [String] :authentication_token
885
+ # Amazon WorkDocs authentication token. This field should not be set
886
+ # when using administrative API actions, as in accessing the API using
887
+ # AWS credentials.
888
+ #
549
889
  # @option params [required, String] :user_id
550
890
  # The ID of the user.
551
891
  #
@@ -554,6 +894,7 @@ module Aws::WorkDocs
554
894
  # @example Request syntax with placeholder values
555
895
  #
556
896
  # resp = client.delete_user({
897
+ # authentication_token: "AuthenticationHeaderType",
557
898
  # user_id: "IdType", # required
558
899
  # })
559
900
  #
@@ -566,10 +907,213 @@ module Aws::WorkDocs
566
907
  req.send_request(options)
567
908
  end
568
909
 
910
+ # Describes the user activities in a specified time period.
911
+ #
912
+ # @option params [String] :authentication_token
913
+ # Amazon WorkDocs authentication token. This field should not be set
914
+ # when using administrative API actions, as in accessing the API using
915
+ # AWS credentials.
916
+ #
917
+ # @option params [Time,DateTime,Date,Integer,String] :start_time
918
+ # The timestamp that determines the starting time of the activities; the
919
+ # response includes the activities performed after the specified
920
+ # timestamp.
921
+ #
922
+ # @option params [Time,DateTime,Date,Integer,String] :end_time
923
+ # The timestamp that determines the end time of the activities; the
924
+ # response includes the activities performed before the specified
925
+ # timestamp.
926
+ #
927
+ # @option params [String] :organization_id
928
+ # The ID of the organization. This is a mandatory parameter when using
929
+ # administrative API (SigV4) requests.
930
+ #
931
+ # @option params [String] :user_id
932
+ # The ID of the user who performed the action. The response includes
933
+ # activities pertaining to this user. This is an optional parameter and
934
+ # is only applicable for administrative API (SigV4) requests.
935
+ #
936
+ # @option params [Integer] :limit
937
+ # The maximum number of items to return.
938
+ #
939
+ # @option params [String] :marker
940
+ # The marker for the next set of results. (You received this marker from
941
+ # a previous call.)
942
+ #
943
+ # @return [Types::DescribeActivitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
944
+ #
945
+ # * {Types::DescribeActivitiesResponse#user_activities #user_activities} => Array&lt;Types::Activity&gt;
946
+ # * {Types::DescribeActivitiesResponse#marker #marker} => String
947
+ #
948
+ # @example Request syntax with placeholder values
949
+ #
950
+ # resp = client.describe_activities({
951
+ # authentication_token: "AuthenticationHeaderType",
952
+ # start_time: Time.now,
953
+ # end_time: Time.now,
954
+ # organization_id: "IdType",
955
+ # user_id: "IdType",
956
+ # limit: 1,
957
+ # marker: "MarkerType",
958
+ # })
959
+ #
960
+ # @example Response structure
961
+ #
962
+ # resp.user_activities #=> Array
963
+ # resp.user_activities[0].type #=> String, one of "DOCUMENT_CHECKED_IN", "DOCUMENT_CHECKED_OUT", "DOCUMENT_RENAMED", "DOCUMENT_VERSION_UPLOADED", "DOCUMENT_VERSION_DELETED", "DOCUMENT_RECYCLED", "DOCUMENT_RESTORED", "DOCUMENT_REVERTED", "DOCUMENT_SHARED", "DOCUMENT_UNSHARED", "DOCUMENT_SHARE_PERMISSION_CHANGED", "DOCUMENT_SHAREABLE_LINK_CREATED", "DOCUMENT_SHAREABLE_LINK_REMOVED", "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED", "DOCUMENT_MOVED", "DOCUMENT_COMMENT_ADDED", "DOCUMENT_COMMENT_DELETED", "DOCUMENT_ANNOTATION_ADDED", "DOCUMENT_ANNOTATION_DELETED", "FOLDER_CREATED", "FOLDER_DELETED", "FOLDER_RENAMED", "FOLDER_RECYCLED", "FOLDER_RESTORED", "FOLDER_SHARED", "FOLDER_UNSHARED", "FOLDER_SHARE_PERMISSION_CHANGED", "FOLDER_SHAREABLE_LINK_CREATED", "FOLDER_SHAREABLE_LINK_REMOVED", "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED", "FOLDER_MOVED"
964
+ # resp.user_activities[0].time_stamp #=> Time
965
+ # resp.user_activities[0].organization_id #=> String
966
+ # resp.user_activities[0].initiator.id #=> String
967
+ # resp.user_activities[0].initiator.username #=> String
968
+ # resp.user_activities[0].initiator.given_name #=> String
969
+ # resp.user_activities[0].initiator.surname #=> String
970
+ # resp.user_activities[0].initiator.email_address #=> String
971
+ # resp.user_activities[0].participants.users #=> Array
972
+ # resp.user_activities[0].participants.users[0].id #=> String
973
+ # resp.user_activities[0].participants.users[0].username #=> String
974
+ # resp.user_activities[0].participants.users[0].given_name #=> String
975
+ # resp.user_activities[0].participants.users[0].surname #=> String
976
+ # resp.user_activities[0].participants.users[0].email_address #=> String
977
+ # resp.user_activities[0].participants.groups #=> Array
978
+ # resp.user_activities[0].participants.groups[0].id #=> String
979
+ # resp.user_activities[0].participants.groups[0].name #=> String
980
+ # resp.user_activities[0].resource_metadata.type #=> String, one of "FOLDER", "DOCUMENT"
981
+ # resp.user_activities[0].resource_metadata.name #=> String
982
+ # resp.user_activities[0].resource_metadata.original_name #=> String
983
+ # resp.user_activities[0].resource_metadata.id #=> String
984
+ # resp.user_activities[0].resource_metadata.version_id #=> String
985
+ # resp.user_activities[0].resource_metadata.owner.id #=> String
986
+ # resp.user_activities[0].resource_metadata.owner.username #=> String
987
+ # resp.user_activities[0].resource_metadata.owner.given_name #=> String
988
+ # resp.user_activities[0].resource_metadata.owner.surname #=> String
989
+ # resp.user_activities[0].resource_metadata.owner.email_address #=> String
990
+ # resp.user_activities[0].resource_metadata.parent_id #=> String
991
+ # resp.user_activities[0].original_parent.type #=> String, one of "FOLDER", "DOCUMENT"
992
+ # resp.user_activities[0].original_parent.name #=> String
993
+ # resp.user_activities[0].original_parent.original_name #=> String
994
+ # resp.user_activities[0].original_parent.id #=> String
995
+ # resp.user_activities[0].original_parent.version_id #=> String
996
+ # resp.user_activities[0].original_parent.owner.id #=> String
997
+ # resp.user_activities[0].original_parent.owner.username #=> String
998
+ # resp.user_activities[0].original_parent.owner.given_name #=> String
999
+ # resp.user_activities[0].original_parent.owner.surname #=> String
1000
+ # resp.user_activities[0].original_parent.owner.email_address #=> String
1001
+ # resp.user_activities[0].original_parent.parent_id #=> String
1002
+ # resp.user_activities[0].comment_metadata.comment_id #=> String
1003
+ # resp.user_activities[0].comment_metadata.contributor.id #=> String
1004
+ # resp.user_activities[0].comment_metadata.contributor.username #=> String
1005
+ # resp.user_activities[0].comment_metadata.contributor.email_address #=> String
1006
+ # resp.user_activities[0].comment_metadata.contributor.given_name #=> String
1007
+ # resp.user_activities[0].comment_metadata.contributor.surname #=> String
1008
+ # resp.user_activities[0].comment_metadata.contributor.organization_id #=> String
1009
+ # resp.user_activities[0].comment_metadata.contributor.root_folder_id #=> String
1010
+ # resp.user_activities[0].comment_metadata.contributor.recycle_bin_folder_id #=> String
1011
+ # resp.user_activities[0].comment_metadata.contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
1012
+ # resp.user_activities[0].comment_metadata.contributor.type #=> String, one of "USER", "ADMIN"
1013
+ # resp.user_activities[0].comment_metadata.contributor.created_timestamp #=> Time
1014
+ # resp.user_activities[0].comment_metadata.contributor.modified_timestamp #=> Time
1015
+ # resp.user_activities[0].comment_metadata.contributor.time_zone_id #=> String
1016
+ # resp.user_activities[0].comment_metadata.contributor.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
1017
+ # resp.user_activities[0].comment_metadata.contributor.storage.storage_utilized_in_bytes #=> Integer
1018
+ # resp.user_activities[0].comment_metadata.contributor.storage.storage_rule.storage_allocated_in_bytes #=> Integer
1019
+ # resp.user_activities[0].comment_metadata.contributor.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"
1020
+ # resp.user_activities[0].comment_metadata.created_timestamp #=> Time
1021
+ # resp.user_activities[0].comment_metadata.comment_status #=> String, one of "DRAFT", "PUBLISHED", "DELETED"
1022
+ # resp.user_activities[0].comment_metadata.recipient_id #=> String
1023
+ # resp.marker #=> String
1024
+ #
1025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivities AWS API Documentation
1026
+ #
1027
+ # @overload describe_activities(params = {})
1028
+ # @param [Hash] params ({})
1029
+ def describe_activities(params = {}, options = {})
1030
+ req = build_request(:describe_activities, params)
1031
+ req.send_request(options)
1032
+ end
1033
+
1034
+ # List all the comments for the specified document version.
1035
+ #
1036
+ # @option params [String] :authentication_token
1037
+ # Amazon WorkDocs authentication token. This field should not be set
1038
+ # when using administrative API actions, as in accessing the API using
1039
+ # AWS credentials.
1040
+ #
1041
+ # @option params [required, String] :document_id
1042
+ # The ID of the document.
1043
+ #
1044
+ # @option params [required, String] :version_id
1045
+ # The ID of the document version.
1046
+ #
1047
+ # @option params [Integer] :limit
1048
+ # The maximum number of items to return.
1049
+ #
1050
+ # @option params [String] :marker
1051
+ # The marker for the next set of results. This marker was received from
1052
+ # a previous call.
1053
+ #
1054
+ # @return [Types::DescribeCommentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1055
+ #
1056
+ # * {Types::DescribeCommentsResponse#comments #comments} => Array&lt;Types::Comment&gt;
1057
+ # * {Types::DescribeCommentsResponse#marker #marker} => String
1058
+ #
1059
+ # @example Request syntax with placeholder values
1060
+ #
1061
+ # resp = client.describe_comments({
1062
+ # authentication_token: "AuthenticationHeaderType",
1063
+ # document_id: "ResourceIdType", # required
1064
+ # version_id: "DocumentVersionIdType", # required
1065
+ # limit: 1,
1066
+ # marker: "MarkerType",
1067
+ # })
1068
+ #
1069
+ # @example Response structure
1070
+ #
1071
+ # resp.comments #=> Array
1072
+ # resp.comments[0].comment_id #=> String
1073
+ # resp.comments[0].parent_id #=> String
1074
+ # resp.comments[0].thread_id #=> String
1075
+ # resp.comments[0].text #=> String
1076
+ # resp.comments[0].contributor.id #=> String
1077
+ # resp.comments[0].contributor.username #=> String
1078
+ # resp.comments[0].contributor.email_address #=> String
1079
+ # resp.comments[0].contributor.given_name #=> String
1080
+ # resp.comments[0].contributor.surname #=> String
1081
+ # resp.comments[0].contributor.organization_id #=> String
1082
+ # resp.comments[0].contributor.root_folder_id #=> String
1083
+ # resp.comments[0].contributor.recycle_bin_folder_id #=> String
1084
+ # resp.comments[0].contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
1085
+ # resp.comments[0].contributor.type #=> String, one of "USER", "ADMIN"
1086
+ # resp.comments[0].contributor.created_timestamp #=> Time
1087
+ # resp.comments[0].contributor.modified_timestamp #=> Time
1088
+ # resp.comments[0].contributor.time_zone_id #=> String
1089
+ # resp.comments[0].contributor.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
1090
+ # resp.comments[0].contributor.storage.storage_utilized_in_bytes #=> Integer
1091
+ # resp.comments[0].contributor.storage.storage_rule.storage_allocated_in_bytes #=> Integer
1092
+ # resp.comments[0].contributor.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"
1093
+ # resp.comments[0].created_timestamp #=> Time
1094
+ # resp.comments[0].status #=> String, one of "DRAFT", "PUBLISHED", "DELETED"
1095
+ # resp.comments[0].visibility #=> String, one of "PUBLIC", "PRIVATE"
1096
+ # resp.comments[0].recipient_id #=> String
1097
+ # resp.marker #=> String
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeComments AWS API Documentation
1100
+ #
1101
+ # @overload describe_comments(params = {})
1102
+ # @param [Hash] params ({})
1103
+ def describe_comments(params = {}, options = {})
1104
+ req = build_request(:describe_comments, params)
1105
+ req.send_request(options)
1106
+ end
1107
+
569
1108
  # Retrieves the document versions for the specified document.
570
1109
  #
571
1110
  # By default, only active versions are returned.
572
1111
  #
1112
+ # @option params [String] :authentication_token
1113
+ # Amazon WorkDocs authentication token. This field should not be set
1114
+ # when using administrative API actions, as in accessing the API using
1115
+ # AWS credentials.
1116
+ #
573
1117
  # @option params [required, String] :document_id
574
1118
  # The ID of the document.
575
1119
  #
@@ -596,6 +1140,7 @@ module Aws::WorkDocs
596
1140
  # @example Request syntax with placeholder values
597
1141
  #
598
1142
  # resp = client.describe_document_versions({
1143
+ # authentication_token: "AuthenticationHeaderType",
599
1144
  # document_id: "ResourceIdType", # required
600
1145
  # marker: "PageMarkerType",
601
1146
  # limit: 1,
@@ -633,13 +1178,18 @@ module Aws::WorkDocs
633
1178
  end
634
1179
 
635
1180
  # Describes the contents of the specified folder, including its
636
- # documents and sub-folders.
1181
+ # documents and subfolders.
637
1182
  #
638
1183
  # By default, Amazon WorkDocs returns the first 100 active document and
639
1184
  # folder metadata items. If there are more results, the response
640
1185
  # includes a marker that you can use to request the next set of results.
641
1186
  # You can also request initialized documents.
642
1187
  #
1188
+ # @option params [String] :authentication_token
1189
+ # Amazon WorkDocs authentication token. This field should not be set
1190
+ # when using administrative API actions, as in accessing the API using
1191
+ # AWS credentials.
1192
+ #
643
1193
  # @option params [required, String] :folder_id
644
1194
  # The ID of the folder.
645
1195
  #
@@ -653,8 +1203,8 @@ module Aws::WorkDocs
653
1203
  # The maximum number of items to return with this call.
654
1204
  #
655
1205
  # @option params [String] :marker
656
- # The marker for the next set of results. (You received this marker from
657
- # a previous call.)
1206
+ # The marker for the next set of results. This marker was received from
1207
+ # a previous call.
658
1208
  #
659
1209
  # @option params [String] :type
660
1210
  # The type of items.
@@ -672,6 +1222,7 @@ module Aws::WorkDocs
672
1222
  # @example Request syntax with placeholder values
673
1223
  #
674
1224
  # resp = client.describe_folder_contents({
1225
+ # authentication_token: "AuthenticationHeaderType",
675
1226
  # folder_id: "ResourceIdType", # required
676
1227
  # sort: "DATE", # accepts DATE, NAME
677
1228
  # order: "ASCENDING", # accepts ASCENDING, DESCENDING
@@ -692,6 +1243,10 @@ module Aws::WorkDocs
692
1243
  # resp.folders[0].modified_timestamp #=> Time
693
1244
  # resp.folders[0].resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
694
1245
  # resp.folders[0].signature #=> String
1246
+ # resp.folders[0].labels #=> Array
1247
+ # resp.folders[0].labels[0] #=> String
1248
+ # resp.folders[0].size #=> Integer
1249
+ # resp.folders[0].latest_version_size #=> Integer
695
1250
  # resp.documents #=> Array
696
1251
  # resp.documents[0].id #=> String
697
1252
  # resp.documents[0].creator_id #=> String
@@ -714,6 +1269,8 @@ module Aws::WorkDocs
714
1269
  # resp.documents[0].latest_version_metadata.source #=> Hash
715
1270
  # resp.documents[0].latest_version_metadata.source["DocumentSourceType"] #=> String
716
1271
  # resp.documents[0].resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
1272
+ # resp.documents[0].labels #=> Array
1273
+ # resp.documents[0].labels[0] #=> String
717
1274
  # resp.marker #=> String
718
1275
  #
719
1276
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContents AWS API Documentation
@@ -769,6 +1326,11 @@ module Aws::WorkDocs
769
1326
 
770
1327
  # Describes the permissions of a specified resource.
771
1328
  #
1329
+ # @option params [String] :authentication_token
1330
+ # Amazon WorkDocs authentication token. This field should not be set
1331
+ # when using administrative API actions, as in accessing the API using
1332
+ # AWS credentials.
1333
+ #
772
1334
  # @option params [required, String] :resource_id
773
1335
  # The ID of the resource.
774
1336
  #
@@ -787,6 +1349,7 @@ module Aws::WorkDocs
787
1349
  # @example Request syntax with placeholder values
788
1350
  #
789
1351
  # resp = client.describe_resource_permissions({
1352
+ # authentication_token: "AuthenticationHeaderType",
790
1353
  # resource_id: "ResourceIdType", # required
791
1354
  # limit: 1,
792
1355
  # marker: "PageMarkerType",
@@ -811,6 +1374,62 @@ module Aws::WorkDocs
811
1374
  req.send_request(options)
812
1375
  end
813
1376
 
1377
+ # Describes the current user's special folders; the `RootFolder` and
1378
+ # the `RecyleBin`. `RootFolder` is the root of user's files and folders
1379
+ # and `RecyleBin` is the root of recycled items. This is not a valid
1380
+ # action for SigV4 (administrative API) clients.
1381
+ #
1382
+ # @option params [required, String] :authentication_token
1383
+ # Amazon WorkDocs authentication token. This field should not be set
1384
+ # when using administrative API actions, as in accessing the API using
1385
+ # AWS credentials.
1386
+ #
1387
+ # @option params [Integer] :limit
1388
+ # The maximum number of items to return.
1389
+ #
1390
+ # @option params [String] :marker
1391
+ # The marker for the next set of results. (You received this marker from
1392
+ # a previous call.)
1393
+ #
1394
+ # @return [Types::DescribeRootFoldersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1395
+ #
1396
+ # * {Types::DescribeRootFoldersResponse#folders #folders} => Array&lt;Types::FolderMetadata&gt;
1397
+ # * {Types::DescribeRootFoldersResponse#marker #marker} => String
1398
+ #
1399
+ # @example Request syntax with placeholder values
1400
+ #
1401
+ # resp = client.describe_root_folders({
1402
+ # authentication_token: "AuthenticationHeaderType", # required
1403
+ # limit: 1,
1404
+ # marker: "PageMarkerType",
1405
+ # })
1406
+ #
1407
+ # @example Response structure
1408
+ #
1409
+ # resp.folders #=> Array
1410
+ # resp.folders[0].id #=> String
1411
+ # resp.folders[0].name #=> String
1412
+ # resp.folders[0].creator_id #=> String
1413
+ # resp.folders[0].parent_folder_id #=> String
1414
+ # resp.folders[0].created_timestamp #=> Time
1415
+ # resp.folders[0].modified_timestamp #=> Time
1416
+ # resp.folders[0].resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
1417
+ # resp.folders[0].signature #=> String
1418
+ # resp.folders[0].labels #=> Array
1419
+ # resp.folders[0].labels[0] #=> String
1420
+ # resp.folders[0].size #=> Integer
1421
+ # resp.folders[0].latest_version_size #=> Integer
1422
+ # resp.marker #=> String
1423
+ #
1424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFolders AWS API Documentation
1425
+ #
1426
+ # @overload describe_root_folders(params = {})
1427
+ # @param [Hash] params ({})
1428
+ def describe_root_folders(params = {}, options = {})
1429
+ req = build_request(:describe_root_folders, params)
1430
+ req.send_request(options)
1431
+ end
1432
+
814
1433
  # Describes the specified users. You can describe all users or filter
815
1434
  # the results (for example, by status or organization).
816
1435
  #
@@ -818,6 +1437,11 @@ module Aws::WorkDocs
818
1437
  # users. If there are more results, the response includes a marker that
819
1438
  # you can use to request the next set of results.
820
1439
  #
1440
+ # @option params [String] :authentication_token
1441
+ # Amazon WorkDocs authentication token. This field should not be set
1442
+ # when using administrative API actions, as in accessing the API using
1443
+ # AWS credentials.
1444
+ #
821
1445
  # @option params [String] :organization_id
822
1446
  # The ID of the organization.
823
1447
  #
@@ -856,6 +1480,7 @@ module Aws::WorkDocs
856
1480
  # @example Request syntax with placeholder values
857
1481
  #
858
1482
  # resp = client.describe_users({
1483
+ # authentication_token: "AuthenticationHeaderType",
859
1484
  # organization_id: "IdType",
860
1485
  # user_ids: "UserIdsType",
861
1486
  # query: "SearchQueryType",
@@ -899,19 +1524,76 @@ module Aws::WorkDocs
899
1524
  req.send_request(options)
900
1525
  end
901
1526
 
902
- # Retrieves the specified document object.
1527
+ # Retrieves details of the current user for whom the authentication
1528
+ # token was generated. This is not a valid action for SigV4
1529
+ # (administrative API) clients.
1530
+ #
1531
+ # @option params [required, String] :authentication_token
1532
+ # Amazon WorkDocs authentication token.
1533
+ #
1534
+ # @return [Types::GetCurrentUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1535
+ #
1536
+ # * {Types::GetCurrentUserResponse#user #user} => Types::User
1537
+ #
1538
+ # @example Request syntax with placeholder values
1539
+ #
1540
+ # resp = client.get_current_user({
1541
+ # authentication_token: "AuthenticationHeaderType", # required
1542
+ # })
1543
+ #
1544
+ # @example Response structure
1545
+ #
1546
+ # resp.user.id #=> String
1547
+ # resp.user.username #=> String
1548
+ # resp.user.email_address #=> String
1549
+ # resp.user.given_name #=> String
1550
+ # resp.user.surname #=> String
1551
+ # resp.user.organization_id #=> String
1552
+ # resp.user.root_folder_id #=> String
1553
+ # resp.user.recycle_bin_folder_id #=> String
1554
+ # resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
1555
+ # resp.user.type #=> String, one of "USER", "ADMIN"
1556
+ # resp.user.created_timestamp #=> Time
1557
+ # resp.user.modified_timestamp #=> Time
1558
+ # resp.user.time_zone_id #=> String
1559
+ # resp.user.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
1560
+ # resp.user.storage.storage_utilized_in_bytes #=> Integer
1561
+ # resp.user.storage.storage_rule.storage_allocated_in_bytes #=> Integer
1562
+ # resp.user.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"
1563
+ #
1564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUser AWS API Documentation
1565
+ #
1566
+ # @overload get_current_user(params = {})
1567
+ # @param [Hash] params ({})
1568
+ def get_current_user(params = {}, options = {})
1569
+ req = build_request(:get_current_user, params)
1570
+ req.send_request(options)
1571
+ end
1572
+
1573
+ # Retrieves details of a document.
1574
+ #
1575
+ # @option params [String] :authentication_token
1576
+ # Amazon WorkDocs authentication token. This field should not be set
1577
+ # when using administrative API actions, as in accessing the API using
1578
+ # AWS credentials.
903
1579
  #
904
1580
  # @option params [required, String] :document_id
905
- # The ID of the document object.
1581
+ # The ID of the document.
1582
+ #
1583
+ # @option params [Boolean] :include_custom_metadata
1584
+ # Set this to `TRUE` to include custom metadata in the response.
906
1585
  #
907
1586
  # @return [Types::GetDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
908
1587
  #
909
1588
  # * {Types::GetDocumentResponse#metadata #metadata} => Types::DocumentMetadata
1589
+ # * {Types::GetDocumentResponse#custom_metadata #custom_metadata} => Hash&lt;String,String&gt;
910
1590
  #
911
1591
  # @example Request syntax with placeholder values
912
1592
  #
913
1593
  # resp = client.get_document({
1594
+ # authentication_token: "AuthenticationHeaderType",
914
1595
  # document_id: "ResourceIdType", # required
1596
+ # include_custom_metadata: false,
915
1597
  # })
916
1598
  #
917
1599
  # @example Response structure
@@ -937,6 +1619,10 @@ module Aws::WorkDocs
937
1619
  # resp.metadata.latest_version_metadata.source #=> Hash
938
1620
  # resp.metadata.latest_version_metadata.source["DocumentSourceType"] #=> String
939
1621
  # resp.metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
1622
+ # resp.metadata.labels #=> Array
1623
+ # resp.metadata.labels[0] #=> String
1624
+ # resp.custom_metadata #=> Hash
1625
+ # resp.custom_metadata["CustomMetadataKeyType"] #=> String
940
1626
  #
941
1627
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocument AWS API Documentation
942
1628
  #
@@ -955,6 +1641,11 @@ module Aws::WorkDocs
955
1641
  # folders in the path. You can limit the maximum number of levels. You
956
1642
  # can also request the names of the parent folders.
957
1643
  #
1644
+ # @option params [String] :authentication_token
1645
+ # Amazon WorkDocs authentication token. This field should not be set
1646
+ # when using administrative API actions, as in accessing the API using
1647
+ # AWS credentials.
1648
+ #
958
1649
  # @option params [required, String] :document_id
959
1650
  # The ID of the document.
960
1651
  #
@@ -962,8 +1653,8 @@ module Aws::WorkDocs
962
1653
  # The maximum number of levels in the hierarchy to return.
963
1654
  #
964
1655
  # @option params [String] :fields
965
- # A comma-separated list of values. Specify "NAME" to include the
966
- # names of the parent folders.
1656
+ # A comma-separated list of values. Specify `NAME` to include the names
1657
+ # of the parent folders.
967
1658
  #
968
1659
  # @option params [String] :marker
969
1660
  # This value is not supported.
@@ -975,6 +1666,7 @@ module Aws::WorkDocs
975
1666
  # @example Request syntax with placeholder values
976
1667
  #
977
1668
  # resp = client.get_document_path({
1669
+ # authentication_token: "AuthenticationHeaderType",
978
1670
  # document_id: "IdType", # required
979
1671
  # limit: 1,
980
1672
  # fields: "FieldNamesType",
@@ -998,6 +1690,11 @@ module Aws::WorkDocs
998
1690
 
999
1691
  # Retrieves version metadata for the specified document.
1000
1692
  #
1693
+ # @option params [String] :authentication_token
1694
+ # Amazon WorkDocs authentication token. This field should not be set
1695
+ # when using administrative API actions, as in accessing the API using
1696
+ # AWS credentials.
1697
+ #
1001
1698
  # @option params [required, String] :document_id
1002
1699
  # The ID of the document.
1003
1700
  #
@@ -1008,16 +1705,22 @@ module Aws::WorkDocs
1008
1705
  # A comma-separated list of values. Specify "SOURCE" to include a URL
1009
1706
  # for the source document.
1010
1707
  #
1708
+ # @option params [Boolean] :include_custom_metadata
1709
+ # Set this to TRUE to include custom metadata in the response.
1710
+ #
1011
1711
  # @return [Types::GetDocumentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1012
1712
  #
1013
1713
  # * {Types::GetDocumentVersionResponse#metadata #metadata} => Types::DocumentVersionMetadata
1714
+ # * {Types::GetDocumentVersionResponse#custom_metadata #custom_metadata} => Hash&lt;String,String&gt;
1014
1715
  #
1015
1716
  # @example Request syntax with placeholder values
1016
1717
  #
1017
1718
  # resp = client.get_document_version({
1719
+ # authentication_token: "AuthenticationHeaderType",
1018
1720
  # document_id: "ResourceIdType", # required
1019
1721
  # version_id: "DocumentVersionIdType", # required
1020
1722
  # fields: "FieldNamesType",
1723
+ # include_custom_metadata: false,
1021
1724
  # })
1022
1725
  #
1023
1726
  # @example Response structure
@@ -1037,6 +1740,8 @@ module Aws::WorkDocs
1037
1740
  # resp.metadata.thumbnail["DocumentThumbnailType"] #=> String
1038
1741
  # resp.metadata.source #=> Hash
1039
1742
  # resp.metadata.source["DocumentSourceType"] #=> String
1743
+ # resp.custom_metadata #=> Hash
1744
+ # resp.custom_metadata["CustomMetadataKeyType"] #=> String
1040
1745
  #
1041
1746
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersion AWS API Documentation
1042
1747
  #
@@ -1049,17 +1754,28 @@ module Aws::WorkDocs
1049
1754
 
1050
1755
  # Retrieves the metadata of the specified folder.
1051
1756
  #
1757
+ # @option params [String] :authentication_token
1758
+ # Amazon WorkDocs authentication token. This field should not be set
1759
+ # when using administrative API actions, as in accessing the API using
1760
+ # AWS credentials.
1761
+ #
1052
1762
  # @option params [required, String] :folder_id
1053
1763
  # The ID of the folder.
1054
1764
  #
1765
+ # @option params [Boolean] :include_custom_metadata
1766
+ # Set to TRUE to include custom metadata in the response.
1767
+ #
1055
1768
  # @return [Types::GetFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1056
1769
  #
1057
1770
  # * {Types::GetFolderResponse#metadata #metadata} => Types::FolderMetadata
1771
+ # * {Types::GetFolderResponse#custom_metadata #custom_metadata} => Hash&lt;String,String&gt;
1058
1772
  #
1059
1773
  # @example Request syntax with placeholder values
1060
1774
  #
1061
1775
  # resp = client.get_folder({
1776
+ # authentication_token: "AuthenticationHeaderType",
1062
1777
  # folder_id: "ResourceIdType", # required
1778
+ # include_custom_metadata: false,
1063
1779
  # })
1064
1780
  #
1065
1781
  # @example Response structure
@@ -1072,6 +1788,12 @@ module Aws::WorkDocs
1072
1788
  # resp.metadata.modified_timestamp #=> Time
1073
1789
  # resp.metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
1074
1790
  # resp.metadata.signature #=> String
1791
+ # resp.metadata.labels #=> Array
1792
+ # resp.metadata.labels[0] #=> String
1793
+ # resp.metadata.size #=> Integer
1794
+ # resp.metadata.latest_version_size #=> Integer
1795
+ # resp.custom_metadata #=> Hash
1796
+ # resp.custom_metadata["CustomMetadataKeyType"] #=> String
1075
1797
  #
1076
1798
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolder AWS API Documentation
1077
1799
  #
@@ -1090,6 +1812,11 @@ module Aws::WorkDocs
1090
1812
  # folders in the path. You can limit the maximum number of levels. You
1091
1813
  # can also request the parent folder names.
1092
1814
  #
1815
+ # @option params [String] :authentication_token
1816
+ # Amazon WorkDocs authentication token. This field should not be set
1817
+ # when using administrative API actions, as in accessing the API using
1818
+ # AWS credentials.
1819
+ #
1093
1820
  # @option params [required, String] :folder_id
1094
1821
  # The ID of the folder.
1095
1822
  #
@@ -1110,6 +1837,7 @@ module Aws::WorkDocs
1110
1837
  # @example Request syntax with placeholder values
1111
1838
  #
1112
1839
  # resp = client.get_folder_path({
1840
+ # authentication_token: "AuthenticationHeaderType",
1113
1841
  # folder_id: "IdType", # required
1114
1842
  # limit: 1,
1115
1843
  # fields: "FieldNamesType",
@@ -1141,6 +1869,11 @@ module Aws::WorkDocs
1141
1869
  #
1142
1870
  # To cancel the document upload, call AbortDocumentVersionUpload.
1143
1871
  #
1872
+ # @option params [String] :authentication_token
1873
+ # Amazon WorkDocs authentication token. This field should not be set
1874
+ # when using administrative API actions, as in accessing the API using
1875
+ # AWS credentials.
1876
+ #
1144
1877
  # @option params [String] :id
1145
1878
  # The ID of the document.
1146
1879
  #
@@ -1171,6 +1904,7 @@ module Aws::WorkDocs
1171
1904
  # @example Request syntax with placeholder values
1172
1905
  #
1173
1906
  # resp = client.initiate_document_version_upload({
1907
+ # authentication_token: "AuthenticationHeaderType",
1174
1908
  # id: "ResourceIdType",
1175
1909
  # name: "ResourceNameType",
1176
1910
  # content_created_timestamp: Time.now,
@@ -1203,6 +1937,8 @@ module Aws::WorkDocs
1203
1937
  # resp.metadata.latest_version_metadata.source #=> Hash
1204
1938
  # resp.metadata.latest_version_metadata.source["DocumentSourceType"] #=> String
1205
1939
  # resp.metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
1940
+ # resp.metadata.labels #=> Array
1941
+ # resp.metadata.labels[0] #=> String
1206
1942
  # resp.upload_metadata.upload_url #=> String
1207
1943
  # resp.upload_metadata.signed_headers #=> Hash
1208
1944
  # resp.upload_metadata.signed_headers["HeaderNameType"] #=> String
@@ -1218,6 +1954,11 @@ module Aws::WorkDocs
1218
1954
 
1219
1955
  # Removes all the permissions from the specified resource.
1220
1956
  #
1957
+ # @option params [String] :authentication_token
1958
+ # Amazon WorkDocs authentication token. This field should not be set
1959
+ # when using administrative API actions, as in accessing the API using
1960
+ # AWS credentials.
1961
+ #
1221
1962
  # @option params [required, String] :resource_id
1222
1963
  # The ID of the resource.
1223
1964
  #
@@ -1226,6 +1967,7 @@ module Aws::WorkDocs
1226
1967
  # @example Request syntax with placeholder values
1227
1968
  #
1228
1969
  # resp = client.remove_all_resource_permissions({
1970
+ # authentication_token: "AuthenticationHeaderType",
1229
1971
  # resource_id: "ResourceIdType", # required
1230
1972
  # })
1231
1973
  #
@@ -1241,6 +1983,11 @@ module Aws::WorkDocs
1241
1983
  # Removes the permission for the specified principal from the specified
1242
1984
  # resource.
1243
1985
  #
1986
+ # @option params [String] :authentication_token
1987
+ # Amazon WorkDocs authentication token. This field should not be set
1988
+ # when using administrative API actions, as in accessing the API using
1989
+ # AWS credentials.
1990
+ #
1244
1991
  # @option params [required, String] :resource_id
1245
1992
  # The ID of the resource.
1246
1993
  #
@@ -1255,6 +2002,7 @@ module Aws::WorkDocs
1255
2002
  # @example Request syntax with placeholder values
1256
2003
  #
1257
2004
  # resp = client.remove_resource_permission({
2005
+ # authentication_token: "AuthenticationHeaderType",
1258
2006
  # resource_id: "ResourceIdType", # required
1259
2007
  # principal_id: "IdType", # required
1260
2008
  # principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
@@ -1269,9 +2017,13 @@ module Aws::WorkDocs
1269
2017
  req.send_request(options)
1270
2018
  end
1271
2019
 
1272
- # Updates the specified attributes of the specified document. The user
1273
- # must have access to both the document and its parent folder, if
1274
- # applicable.
2020
+ # Updates the specified attributes of a document. The user must have
2021
+ # access to both the document and its parent folder, if applicable.
2022
+ #
2023
+ # @option params [String] :authentication_token
2024
+ # Amazon WorkDocs authentication token. This field should not be set
2025
+ # when using administrative API actions, as in accessing the API using
2026
+ # AWS credentials.
1275
2027
  #
1276
2028
  # @option params [required, String] :document_id
1277
2029
  # The ID of the document.
@@ -1291,6 +2043,7 @@ module Aws::WorkDocs
1291
2043
  # @example Request syntax with placeholder values
1292
2044
  #
1293
2045
  # resp = client.update_document({
2046
+ # authentication_token: "AuthenticationHeaderType",
1294
2047
  # document_id: "ResourceIdType", # required
1295
2048
  # name: "ResourceNameType",
1296
2049
  # parent_folder_id: "ResourceIdType",
@@ -1313,6 +2066,11 @@ module Aws::WorkDocs
1313
2066
  # document to an S3-presigned URL returned by
1314
2067
  # InitiateDocumentVersionUpload.
1315
2068
  #
2069
+ # @option params [String] :authentication_token
2070
+ # Amazon WorkDocs authentication token. This field should not be set
2071
+ # when using administrative API actions, as in accessing the API using
2072
+ # AWS credentials.
2073
+ #
1316
2074
  # @option params [required, String] :document_id
1317
2075
  # The ID of the document.
1318
2076
  #
@@ -1327,6 +2085,7 @@ module Aws::WorkDocs
1327
2085
  # @example Request syntax with placeholder values
1328
2086
  #
1329
2087
  # resp = client.update_document_version({
2088
+ # authentication_token: "AuthenticationHeaderType",
1330
2089
  # document_id: "ResourceIdType", # required
1331
2090
  # version_id: "DocumentVersionIdType", # required
1332
2091
  # version_status: "ACTIVE", # accepts ACTIVE
@@ -1345,6 +2104,11 @@ module Aws::WorkDocs
1345
2104
  # must have access to both the folder and its parent folder, if
1346
2105
  # applicable.
1347
2106
  #
2107
+ # @option params [String] :authentication_token
2108
+ # Amazon WorkDocs authentication token. This field should not be set
2109
+ # when using administrative API actions, as in accessing the API using
2110
+ # AWS credentials.
2111
+ #
1348
2112
  # @option params [required, String] :folder_id
1349
2113
  # The ID of the folder.
1350
2114
  #
@@ -1363,6 +2127,7 @@ module Aws::WorkDocs
1363
2127
  # @example Request syntax with placeholder values
1364
2128
  #
1365
2129
  # resp = client.update_folder({
2130
+ # authentication_token: "AuthenticationHeaderType",
1366
2131
  # folder_id: "ResourceIdType", # required
1367
2132
  # name: "ResourceNameType",
1368
2133
  # parent_folder_id: "ResourceIdType",
@@ -1381,6 +2146,11 @@ module Aws::WorkDocs
1381
2146
  # Updates the specified attributes of the specified user, and grants or
1382
2147
  # revokes administrative privileges to the Amazon WorkDocs site.
1383
2148
  #
2149
+ # @option params [String] :authentication_token
2150
+ # Amazon WorkDocs authentication token. This field should not be set
2151
+ # when using administrative API actions, as in accessing the API using
2152
+ # AWS credentials.
2153
+ #
1384
2154
  # @option params [required, String] :user_id
1385
2155
  # The ID of the user.
1386
2156
  #
@@ -1409,6 +2179,7 @@ module Aws::WorkDocs
1409
2179
  # @example Request syntax with placeholder values
1410
2180
  #
1411
2181
  # resp = client.update_user({
2182
+ # authentication_token: "AuthenticationHeaderType",
1412
2183
  # user_id: "IdType", # required
1413
2184
  # given_name: "UserAttributeValueType",
1414
2185
  # surname: "UserAttributeValueType",
@@ -1463,7 +2234,7 @@ module Aws::WorkDocs
1463
2234
  params: params,
1464
2235
  config: config)
1465
2236
  context[:gem_name] = 'aws-sdk-workdocs'
1466
- context[:gem_version] = '1.0.0.rc5'
2237
+ context[:gem_version] = '1.0.0.rc6'
1467
2238
  Seahorse::Client::Request.new(handlers, context)
1468
2239
  end
1469
2240