aws-sdk-workdocs 1.41.0 → 1.43.0

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.
@@ -10,18 +10,9 @@
10
10
  module Aws::WorkDocs
11
11
  module Types
12
12
 
13
- # @note When making an API call, you may pass AbortDocumentVersionUploadRequest
14
- # data as a hash:
15
- #
16
- # {
17
- # authentication_token: "AuthenticationHeaderType",
18
- # document_id: "ResourceIdType", # required
19
- # version_id: "DocumentVersionIdType", # required
20
- # }
21
- #
22
13
  # @!attribute [rw] authentication_token
23
- # Amazon WorkDocs authentication token. Not required when using AWS
24
- # administrator credentials to access the API.
14
+ # Amazon WorkDocs authentication token. Not required when using Amazon
15
+ # Web Services administrator credentials to access the API.
25
16
  # @return [String]
26
17
  #
27
18
  # @!attribute [rw] document_id
@@ -42,21 +33,13 @@ module Aws::WorkDocs
42
33
  include Aws::Structure
43
34
  end
44
35
 
45
- # @note When making an API call, you may pass ActivateUserRequest
46
- # data as a hash:
47
- #
48
- # {
49
- # user_id: "IdType", # required
50
- # authentication_token: "AuthenticationHeaderType",
51
- # }
52
- #
53
36
  # @!attribute [rw] user_id
54
37
  # The ID of the user.
55
38
  # @return [String]
56
39
  #
57
40
  # @!attribute [rw] authentication_token
58
- # Amazon WorkDocs authentication token. Not required when using AWS
59
- # administrator credentials to access the API.
41
+ # Amazon WorkDocs authentication token. Not required when using Amazon
42
+ # Web Services administrator credentials to access the API.
60
43
  # @return [String]
61
44
  #
62
45
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest AWS API Documentation
@@ -143,28 +126,9 @@ module Aws::WorkDocs
143
126
  include Aws::Structure
144
127
  end
145
128
 
146
- # @note When making an API call, you may pass AddResourcePermissionsRequest
147
- # data as a hash:
148
- #
149
- # {
150
- # authentication_token: "AuthenticationHeaderType",
151
- # resource_id: "ResourceIdType", # required
152
- # principals: [ # required
153
- # {
154
- # id: "IdType", # required
155
- # type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
156
- # role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
157
- # },
158
- # ],
159
- # notification_options: {
160
- # send_email: false,
161
- # email_message: "MessageType",
162
- # },
163
- # }
164
- #
165
129
  # @!attribute [rw] authentication_token
166
- # Amazon WorkDocs authentication token. Not required when using AWS
167
- # administrator credentials to access the API.
130
+ # Amazon WorkDocs authentication token. Not required when using Amazon
131
+ # Web Services administrator credentials to access the API.
168
132
  # @return [String]
169
133
  #
170
134
  # @!attribute [rw] resource_id
@@ -321,23 +285,9 @@ module Aws::WorkDocs
321
285
  include Aws::Structure
322
286
  end
323
287
 
324
- # @note When making an API call, you may pass CreateCommentRequest
325
- # data as a hash:
326
- #
327
- # {
328
- # authentication_token: "AuthenticationHeaderType",
329
- # document_id: "ResourceIdType", # required
330
- # version_id: "DocumentVersionIdType", # required
331
- # parent_id: "CommentIdType",
332
- # thread_id: "CommentIdType",
333
- # text: "CommentTextType", # required
334
- # visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
335
- # notify_collaborators: false,
336
- # }
337
- #
338
288
  # @!attribute [rw] authentication_token
339
- # Amazon WorkDocs authentication token. Not required when using AWS
340
- # administrator credentials to access the API.
289
+ # Amazon WorkDocs authentication token. Not required when using Amazon
290
+ # Web Services administrator credentials to access the API.
341
291
  # @return [String]
342
292
  #
343
293
  # @!attribute [rw] document_id
@@ -399,21 +349,9 @@ module Aws::WorkDocs
399
349
  include Aws::Structure
400
350
  end
401
351
 
402
- # @note When making an API call, you may pass CreateCustomMetadataRequest
403
- # data as a hash:
404
- #
405
- # {
406
- # authentication_token: "AuthenticationHeaderType",
407
- # resource_id: "ResourceIdType", # required
408
- # version_id: "DocumentVersionIdType",
409
- # custom_metadata: { # required
410
- # "CustomMetadataKeyType" => "CustomMetadataValueType",
411
- # },
412
- # }
413
- #
414
352
  # @!attribute [rw] authentication_token
415
- # Amazon WorkDocs authentication token. Not required when using AWS
416
- # administrator credentials to access the API.
353
+ # Amazon WorkDocs authentication token. Not required when using Amazon
354
+ # Web Services administrator credentials to access the API.
417
355
  # @return [String]
418
356
  #
419
357
  # @!attribute [rw] resource_id
@@ -444,18 +382,9 @@ module Aws::WorkDocs
444
382
  #
445
383
  class CreateCustomMetadataResponse < Aws::EmptyStructure; end
446
384
 
447
- # @note When making an API call, you may pass CreateFolderRequest
448
- # data as a hash:
449
- #
450
- # {
451
- # authentication_token: "AuthenticationHeaderType",
452
- # name: "ResourceNameType",
453
- # parent_folder_id: "ResourceIdType", # required
454
- # }
455
- #
456
385
  # @!attribute [rw] authentication_token
457
- # Amazon WorkDocs authentication token. Not required when using AWS
458
- # administrator credentials to access the API.
386
+ # Amazon WorkDocs authentication token. Not required when using Amazon
387
+ # Web Services administrator credentials to access the API.
459
388
  # @return [String]
460
389
  #
461
390
  # @!attribute [rw] name
@@ -488,15 +417,6 @@ module Aws::WorkDocs
488
417
  include Aws::Structure
489
418
  end
490
419
 
491
- # @note When making an API call, you may pass CreateLabelsRequest
492
- # data as a hash:
493
- #
494
- # {
495
- # resource_id: "ResourceIdType", # required
496
- # labels: ["SharedLabel"], # required
497
- # authentication_token: "AuthenticationHeaderType",
498
- # }
499
- #
500
420
  # @!attribute [rw] resource_id
501
421
  # The ID of the resource.
502
422
  # @return [String]
@@ -506,8 +426,8 @@ module Aws::WorkDocs
506
426
  # @return [Array<String>]
507
427
  #
508
428
  # @!attribute [rw] authentication_token
509
- # Amazon WorkDocs authentication token. Not required when using AWS
510
- # administrator credentials to access the API.
429
+ # Amazon WorkDocs authentication token. Not required when using Amazon
430
+ # Web Services administrator credentials to access the API.
511
431
  # @return [String]
512
432
  #
513
433
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsRequest AWS API Documentation
@@ -524,16 +444,6 @@ module Aws::WorkDocs
524
444
  #
525
445
  class CreateLabelsResponse < Aws::EmptyStructure; end
526
446
 
527
- # @note When making an API call, you may pass CreateNotificationSubscriptionRequest
528
- # data as a hash:
529
- #
530
- # {
531
- # organization_id: "IdType", # required
532
- # endpoint: "SubscriptionEndPointType", # required
533
- # protocol: "HTTPS", # required, accepts HTTPS, SQS
534
- # subscription_type: "ALL", # required, accepts ALL
535
- # }
536
- #
537
447
  # @!attribute [rw] organization_id
538
448
  # The ID of the organization.
539
449
  # @return [String]
@@ -575,24 +485,6 @@ module Aws::WorkDocs
575
485
  include Aws::Structure
576
486
  end
577
487
 
578
- # @note When making an API call, you may pass CreateUserRequest
579
- # data as a hash:
580
- #
581
- # {
582
- # organization_id: "IdType",
583
- # username: "UsernameType", # required
584
- # email_address: "EmailAddressType",
585
- # given_name: "UserAttributeValueType", # required
586
- # surname: "UserAttributeValueType", # required
587
- # password: "PasswordType", # required
588
- # time_zone_id: "TimeZoneIdType",
589
- # storage_rule: {
590
- # storage_allocated_in_bytes: 1,
591
- # storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
592
- # },
593
- # authentication_token: "AuthenticationHeaderType",
594
- # }
595
- #
596
488
  # @!attribute [rw] organization_id
597
489
  # The ID of the organization.
598
490
  # @return [String]
@@ -626,8 +518,8 @@ module Aws::WorkDocs
626
518
  # @return [Types::StorageRuleType]
627
519
  #
628
520
  # @!attribute [rw] authentication_token
629
- # Amazon WorkDocs authentication token. Not required when using AWS
630
- # administrator credentials to access the API.
521
+ # Amazon WorkDocs authentication token. Not required when using Amazon
522
+ # Web Services administrator credentials to access the API.
631
523
  # @return [String]
632
524
  #
633
525
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest AWS API Documentation
@@ -672,21 +564,13 @@ module Aws::WorkDocs
672
564
  include Aws::Structure
673
565
  end
674
566
 
675
- # @note When making an API call, you may pass DeactivateUserRequest
676
- # data as a hash:
677
- #
678
- # {
679
- # user_id: "IdType", # required
680
- # authentication_token: "AuthenticationHeaderType",
681
- # }
682
- #
683
567
  # @!attribute [rw] user_id
684
568
  # The ID of the user.
685
569
  # @return [String]
686
570
  #
687
571
  # @!attribute [rw] authentication_token
688
- # Amazon WorkDocs authentication token. Not required when using AWS
689
- # administrator credentials to access the API.
572
+ # Amazon WorkDocs authentication token. Not required when using Amazon
573
+ # Web Services administrator credentials to access the API.
690
574
  # @return [String]
691
575
  #
692
576
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest AWS API Documentation
@@ -704,19 +588,9 @@ module Aws::WorkDocs
704
588
  #
705
589
  class DeactivatingLastSystemUserException < Aws::EmptyStructure; end
706
590
 
707
- # @note When making an API call, you may pass DeleteCommentRequest
708
- # data as a hash:
709
- #
710
- # {
711
- # authentication_token: "AuthenticationHeaderType",
712
- # document_id: "ResourceIdType", # required
713
- # version_id: "DocumentVersionIdType", # required
714
- # comment_id: "CommentIdType", # required
715
- # }
716
- #
717
591
  # @!attribute [rw] authentication_token
718
- # Amazon WorkDocs authentication token. Not required when using AWS
719
- # administrator credentials to access the API.
592
+ # Amazon WorkDocs authentication token. Not required when using Amazon
593
+ # Web Services administrator credentials to access the API.
720
594
  # @return [String]
721
595
  #
722
596
  # @!attribute [rw] document_id
@@ -742,20 +616,9 @@ module Aws::WorkDocs
742
616
  include Aws::Structure
743
617
  end
744
618
 
745
- # @note When making an API call, you may pass DeleteCustomMetadataRequest
746
- # data as a hash:
747
- #
748
- # {
749
- # authentication_token: "AuthenticationHeaderType",
750
- # resource_id: "ResourceIdType", # required
751
- # version_id: "DocumentVersionIdType",
752
- # keys: ["CustomMetadataKeyType"],
753
- # delete_all: false,
754
- # }
755
- #
756
619
  # @!attribute [rw] authentication_token
757
- # Amazon WorkDocs authentication token. Not required when using AWS
758
- # administrator credentials to access the API.
620
+ # Amazon WorkDocs authentication token. Not required when using Amazon
621
+ # Web Services administrator credentials to access the API.
759
622
  # @return [String]
760
623
  #
761
624
  # @!attribute [rw] resource_id
@@ -792,17 +655,9 @@ module Aws::WorkDocs
792
655
  #
793
656
  class DeleteCustomMetadataResponse < Aws::EmptyStructure; end
794
657
 
795
- # @note When making an API call, you may pass DeleteDocumentRequest
796
- # data as a hash:
797
- #
798
- # {
799
- # authentication_token: "AuthenticationHeaderType",
800
- # document_id: "ResourceIdType", # required
801
- # }
802
- #
803
658
  # @!attribute [rw] authentication_token
804
- # Amazon WorkDocs authentication token. Not required when using AWS
805
- # administrator credentials to access the API.
659
+ # Amazon WorkDocs authentication token. Not required when using Amazon
660
+ # Web Services administrator credentials to access the API.
806
661
  # @return [String]
807
662
  #
808
663
  # @!attribute [rw] document_id
@@ -818,32 +673,21 @@ module Aws::WorkDocs
818
673
  include Aws::Structure
819
674
  end
820
675
 
821
- # @note When making an API call, you may pass DeleteDocumentVersionRequest
822
- # data as a hash:
823
- #
824
- # {
825
- # authentication_token: "AuthenticationHeaderType",
826
- # document_id: "ResourceIdType", # required
827
- # version_id: "DocumentVersionIdType", # required
828
- # delete_prior_versions: false, # required
829
- # }
830
- #
831
676
  # @!attribute [rw] authentication_token
832
- # Amazon WorkDocs authentication token. Not required when using AWS
833
- # administrator credentials to access the API.
677
+ # Amazon WorkDocs authentication token. Not required when using Amazon
678
+ # Web Services administrator credentials to access the API.
834
679
  # @return [String]
835
680
  #
836
681
  # @!attribute [rw] document_id
837
- # The ID of a document.
682
+ # The ID of the document associated with the version being deleted.
838
683
  # @return [String]
839
684
  #
840
685
  # @!attribute [rw] version_id
841
- # The version ID of a document.
686
+ # The ID of the version being deleted.
842
687
  # @return [String]
843
688
  #
844
689
  # @!attribute [rw] delete_prior_versions
845
- # When set to `TRUE`, deletes the specified version and *all prior
846
- # versions* of a document.
690
+ # Deletes all versions of a document prior to the current version.
847
691
  # @return [Boolean]
848
692
  #
849
693
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersionRequest AWS API Documentation
@@ -857,17 +701,9 @@ module Aws::WorkDocs
857
701
  include Aws::Structure
858
702
  end
859
703
 
860
- # @note When making an API call, you may pass DeleteFolderContentsRequest
861
- # data as a hash:
862
- #
863
- # {
864
- # authentication_token: "AuthenticationHeaderType",
865
- # folder_id: "ResourceIdType", # required
866
- # }
867
- #
868
704
  # @!attribute [rw] authentication_token
869
- # Amazon WorkDocs authentication token. Not required when using AWS
870
- # administrator credentials to access the API.
705
+ # Amazon WorkDocs authentication token. Not required when using Amazon
706
+ # Web Services administrator credentials to access the API.
871
707
  # @return [String]
872
708
  #
873
709
  # @!attribute [rw] folder_id
@@ -883,17 +719,9 @@ module Aws::WorkDocs
883
719
  include Aws::Structure
884
720
  end
885
721
 
886
- # @note When making an API call, you may pass DeleteFolderRequest
887
- # data as a hash:
888
- #
889
- # {
890
- # authentication_token: "AuthenticationHeaderType",
891
- # folder_id: "ResourceIdType", # required
892
- # }
893
- #
894
722
  # @!attribute [rw] authentication_token
895
- # Amazon WorkDocs authentication token. Not required when using AWS
896
- # administrator credentials to access the API.
723
+ # Amazon WorkDocs authentication token. Not required when using Amazon
724
+ # Web Services administrator credentials to access the API.
897
725
  # @return [String]
898
726
  #
899
727
  # @!attribute [rw] folder_id
@@ -909,23 +737,13 @@ module Aws::WorkDocs
909
737
  include Aws::Structure
910
738
  end
911
739
 
912
- # @note When making an API call, you may pass DeleteLabelsRequest
913
- # data as a hash:
914
- #
915
- # {
916
- # resource_id: "ResourceIdType", # required
917
- # authentication_token: "AuthenticationHeaderType",
918
- # labels: ["SharedLabel"],
919
- # delete_all: false,
920
- # }
921
- #
922
740
  # @!attribute [rw] resource_id
923
741
  # The ID of the resource.
924
742
  # @return [String]
925
743
  #
926
744
  # @!attribute [rw] authentication_token
927
- # Amazon WorkDocs authentication token. Not required when using AWS
928
- # administrator credentials to access the API.
745
+ # Amazon WorkDocs authentication token. Not required when using Amazon
746
+ # Web Services administrator credentials to access the API.
929
747
  # @return [String]
930
748
  #
931
749
  # @!attribute [rw] labels
@@ -951,14 +769,6 @@ module Aws::WorkDocs
951
769
  #
952
770
  class DeleteLabelsResponse < Aws::EmptyStructure; end
953
771
 
954
- # @note When making an API call, you may pass DeleteNotificationSubscriptionRequest
955
- # data as a hash:
956
- #
957
- # {
958
- # subscription_id: "IdType", # required
959
- # organization_id: "IdType", # required
960
- # }
961
- #
962
772
  # @!attribute [rw] subscription_id
963
773
  # The ID of the subscription.
964
774
  # @return [String]
@@ -976,18 +786,10 @@ module Aws::WorkDocs
976
786
  include Aws::Structure
977
787
  end
978
788
 
979
- # @note When making an API call, you may pass DeleteUserRequest
980
- # data as a hash:
981
- #
982
- # {
983
- # authentication_token: "AuthenticationHeaderType",
984
- # user_id: "IdType", # required
985
- # }
986
- #
987
789
  # @!attribute [rw] authentication_token
988
790
  # Amazon WorkDocs authentication token. Do not set this field when
989
- # using administrative API actions, as in accessing the API using AWS
990
- # credentials.
791
+ # using administrative API actions, as in accessing the API using
792
+ # Amazon Web Services credentials.
991
793
  # @return [String]
992
794
  #
993
795
  # @!attribute [rw] user_id
@@ -1003,25 +805,9 @@ module Aws::WorkDocs
1003
805
  include Aws::Structure
1004
806
  end
1005
807
 
1006
- # @note When making an API call, you may pass DescribeActivitiesRequest
1007
- # data as a hash:
1008
- #
1009
- # {
1010
- # authentication_token: "AuthenticationHeaderType",
1011
- # start_time: Time.now,
1012
- # end_time: Time.now,
1013
- # organization_id: "IdType",
1014
- # activity_types: "ActivityNamesFilterType",
1015
- # resource_id: "IdType",
1016
- # user_id: "IdType",
1017
- # include_indirect_activities: false,
1018
- # limit: 1,
1019
- # marker: "SearchMarkerType",
1020
- # }
1021
- #
1022
808
  # @!attribute [rw] authentication_token
1023
- # Amazon WorkDocs authentication token. Not required when using AWS
1024
- # administrator credentials to access the API.
809
+ # Amazon WorkDocs authentication token. Not required when using Amazon
810
+ # Web Services administrator credentials to access the API.
1025
811
  # @return [String]
1026
812
  #
1027
813
  # @!attribute [rw] start_time
@@ -1105,20 +891,9 @@ module Aws::WorkDocs
1105
891
  include Aws::Structure
1106
892
  end
1107
893
 
1108
- # @note When making an API call, you may pass DescribeCommentsRequest
1109
- # data as a hash:
1110
- #
1111
- # {
1112
- # authentication_token: "AuthenticationHeaderType",
1113
- # document_id: "ResourceIdType", # required
1114
- # version_id: "DocumentVersionIdType", # required
1115
- # limit: 1,
1116
- # marker: "MarkerType",
1117
- # }
1118
- #
1119
894
  # @!attribute [rw] authentication_token
1120
- # Amazon WorkDocs authentication token. Not required when using AWS
1121
- # administrator credentials to access the API.
895
+ # Amazon WorkDocs authentication token. Not required when using Amazon
896
+ # Web Services administrator credentials to access the API.
1122
897
  # @return [String]
1123
898
  #
1124
899
  # @!attribute [rw] document_id
@@ -1168,21 +943,9 @@ module Aws::WorkDocs
1168
943
  include Aws::Structure
1169
944
  end
1170
945
 
1171
- # @note When making an API call, you may pass DescribeDocumentVersionsRequest
1172
- # data as a hash:
1173
- #
1174
- # {
1175
- # authentication_token: "AuthenticationHeaderType",
1176
- # document_id: "ResourceIdType", # required
1177
- # marker: "PageMarkerType",
1178
- # limit: 1,
1179
- # include: "FieldNamesType",
1180
- # fields: "FieldNamesType",
1181
- # }
1182
- #
1183
946
  # @!attribute [rw] authentication_token
1184
- # Amazon WorkDocs authentication token. Not required when using AWS
1185
- # administrator credentials to access the API.
947
+ # Amazon WorkDocs authentication token. Not required when using Amazon
948
+ # Web Services administrator credentials to access the API.
1186
949
  # @return [String]
1187
950
  #
1188
951
  # @!attribute [rw] document_id
@@ -1239,23 +1002,9 @@ module Aws::WorkDocs
1239
1002
  include Aws::Structure
1240
1003
  end
1241
1004
 
1242
- # @note When making an API call, you may pass DescribeFolderContentsRequest
1243
- # data as a hash:
1244
- #
1245
- # {
1246
- # authentication_token: "AuthenticationHeaderType",
1247
- # folder_id: "ResourceIdType", # required
1248
- # sort: "DATE", # accepts DATE, NAME
1249
- # order: "ASCENDING", # accepts ASCENDING, DESCENDING
1250
- # limit: 1,
1251
- # marker: "PageMarkerType",
1252
- # type: "ALL", # accepts ALL, DOCUMENT, FOLDER
1253
- # include: "FieldNamesType",
1254
- # }
1255
- #
1256
1005
  # @!attribute [rw] authentication_token
1257
- # Amazon WorkDocs authentication token. Not required when using AWS
1258
- # administrator credentials to access the API.
1006
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1007
+ # Web Services administrator credentials to access the API.
1259
1008
  # @return [String]
1260
1009
  #
1261
1010
  # @!attribute [rw] folder_id
@@ -1326,20 +1075,9 @@ module Aws::WorkDocs
1326
1075
  include Aws::Structure
1327
1076
  end
1328
1077
 
1329
- # @note When making an API call, you may pass DescribeGroupsRequest
1330
- # data as a hash:
1331
- #
1332
- # {
1333
- # authentication_token: "AuthenticationHeaderType",
1334
- # search_query: "SearchQueryType", # required
1335
- # organization_id: "IdType",
1336
- # marker: "MarkerType",
1337
- # limit: 1,
1338
- # }
1339
- #
1340
1078
  # @!attribute [rw] authentication_token
1341
- # Amazon WorkDocs authentication token. Not required when using AWS
1342
- # administrator credentials to access the API.
1079
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1080
+ # Web Services administrator credentials to access the API.
1343
1081
  # @return [String]
1344
1082
  #
1345
1083
  # @!attribute [rw] search_query
@@ -1389,15 +1127,6 @@ module Aws::WorkDocs
1389
1127
  include Aws::Structure
1390
1128
  end
1391
1129
 
1392
- # @note When making an API call, you may pass DescribeNotificationSubscriptionsRequest
1393
- # data as a hash:
1394
- #
1395
- # {
1396
- # organization_id: "IdType", # required
1397
- # marker: "PageMarkerType",
1398
- # limit: 1,
1399
- # }
1400
- #
1401
1130
  # @!attribute [rw] organization_id
1402
1131
  # The ID of the organization.
1403
1132
  # @return [String]
@@ -1439,20 +1168,9 @@ module Aws::WorkDocs
1439
1168
  include Aws::Structure
1440
1169
  end
1441
1170
 
1442
- # @note When making an API call, you may pass DescribeResourcePermissionsRequest
1443
- # data as a hash:
1444
- #
1445
- # {
1446
- # authentication_token: "AuthenticationHeaderType",
1447
- # resource_id: "ResourceIdType", # required
1448
- # principal_id: "IdType",
1449
- # limit: 1,
1450
- # marker: "PageMarkerType",
1451
- # }
1452
- #
1453
1171
  # @!attribute [rw] authentication_token
1454
- # Amazon WorkDocs authentication token. Not required when using AWS
1455
- # administrator credentials to access the API.
1172
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1173
+ # Web Services administrator credentials to access the API.
1456
1174
  # @return [String]
1457
1175
  #
1458
1176
  # @!attribute [rw] resource_id
@@ -1502,15 +1220,6 @@ module Aws::WorkDocs
1502
1220
  include Aws::Structure
1503
1221
  end
1504
1222
 
1505
- # @note When making an API call, you may pass DescribeRootFoldersRequest
1506
- # data as a hash:
1507
- #
1508
- # {
1509
- # authentication_token: "AuthenticationHeaderType", # required
1510
- # limit: 1,
1511
- # marker: "PageMarkerType",
1512
- # }
1513
- #
1514
1223
  # @!attribute [rw] authentication_token
1515
1224
  # Amazon WorkDocs authentication token.
1516
1225
  # @return [String]
@@ -1551,25 +1260,9 @@ module Aws::WorkDocs
1551
1260
  include Aws::Structure
1552
1261
  end
1553
1262
 
1554
- # @note When making an API call, you may pass DescribeUsersRequest
1555
- # data as a hash:
1556
- #
1557
- # {
1558
- # authentication_token: "AuthenticationHeaderType",
1559
- # organization_id: "IdType",
1560
- # user_ids: "UserIdsType",
1561
- # query: "SearchQueryType",
1562
- # include: "ALL", # accepts ALL, ACTIVE_PENDING
1563
- # order: "ASCENDING", # accepts ASCENDING, DESCENDING
1564
- # sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
1565
- # marker: "PageMarkerType",
1566
- # limit: 1,
1567
- # fields: "FieldNamesType",
1568
- # }
1569
- #
1570
1263
  # @!attribute [rw] authentication_token
1571
- # Amazon WorkDocs authentication token. Not required when using AWS
1572
- # administrator credentials to access the API.
1264
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1265
+ # Web Services administrator credentials to access the API.
1573
1266
  # @return [String]
1574
1267
  #
1575
1268
  # @!attribute [rw] organization_id
@@ -1855,7 +1548,7 @@ module Aws::WorkDocs
1855
1548
  include Aws::Structure
1856
1549
  end
1857
1550
 
1858
- # The AWS Directory Service cannot reach an on-premises instance. Or a
1551
+ # The Directory Service cannot reach an on-premises instance. Or a
1859
1552
  # dependency under the control of the organization is failing, such as a
1860
1553
  # connected Active Directory.
1861
1554
  #
@@ -1935,13 +1628,6 @@ module Aws::WorkDocs
1935
1628
  include Aws::Structure
1936
1629
  end
1937
1630
 
1938
- # @note When making an API call, you may pass GetCurrentUserRequest
1939
- # data as a hash:
1940
- #
1941
- # {
1942
- # authentication_token: "AuthenticationHeaderType", # required
1943
- # }
1944
- #
1945
1631
  # @!attribute [rw] authentication_token
1946
1632
  # Amazon WorkDocs authentication token.
1947
1633
  # @return [String]
@@ -1966,20 +1652,9 @@ module Aws::WorkDocs
1966
1652
  include Aws::Structure
1967
1653
  end
1968
1654
 
1969
- # @note When making an API call, you may pass GetDocumentPathRequest
1970
- # data as a hash:
1971
- #
1972
- # {
1973
- # authentication_token: "AuthenticationHeaderType",
1974
- # document_id: "IdType", # required
1975
- # limit: 1,
1976
- # fields: "FieldNamesType",
1977
- # marker: "PageMarkerType",
1978
- # }
1979
- #
1980
1655
  # @!attribute [rw] authentication_token
1981
- # Amazon WorkDocs authentication token. Not required when using AWS
1982
- # administrator credentials to access the API.
1656
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1657
+ # Web Services administrator credentials to access the API.
1983
1658
  # @return [String]
1984
1659
  #
1985
1660
  # @!attribute [rw] document_id
@@ -2023,18 +1698,9 @@ module Aws::WorkDocs
2023
1698
  include Aws::Structure
2024
1699
  end
2025
1700
 
2026
- # @note When making an API call, you may pass GetDocumentRequest
2027
- # data as a hash:
2028
- #
2029
- # {
2030
- # authentication_token: "AuthenticationHeaderType",
2031
- # document_id: "ResourceIdType", # required
2032
- # include_custom_metadata: false,
2033
- # }
2034
- #
2035
1701
  # @!attribute [rw] authentication_token
2036
- # Amazon WorkDocs authentication token. Not required when using AWS
2037
- # administrator credentials to access the API.
1702
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1703
+ # Web Services administrator credentials to access the API.
2038
1704
  # @return [String]
2039
1705
  #
2040
1706
  # @!attribute [rw] document_id
@@ -2072,20 +1738,9 @@ module Aws::WorkDocs
2072
1738
  include Aws::Structure
2073
1739
  end
2074
1740
 
2075
- # @note When making an API call, you may pass GetDocumentVersionRequest
2076
- # data as a hash:
2077
- #
2078
- # {
2079
- # authentication_token: "AuthenticationHeaderType",
2080
- # document_id: "ResourceIdType", # required
2081
- # version_id: "DocumentVersionIdType", # required
2082
- # fields: "FieldNamesType",
2083
- # include_custom_metadata: false,
2084
- # }
2085
- #
2086
1741
  # @!attribute [rw] authentication_token
2087
- # Amazon WorkDocs authentication token. Not required when using AWS
2088
- # administrator credentials to access the API.
1742
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1743
+ # Web Services administrator credentials to access the API.
2089
1744
  # @return [String]
2090
1745
  #
2091
1746
  # @!attribute [rw] document_id
@@ -2134,20 +1789,9 @@ module Aws::WorkDocs
2134
1789
  include Aws::Structure
2135
1790
  end
2136
1791
 
2137
- # @note When making an API call, you may pass GetFolderPathRequest
2138
- # data as a hash:
2139
- #
2140
- # {
2141
- # authentication_token: "AuthenticationHeaderType",
2142
- # folder_id: "IdType", # required
2143
- # limit: 1,
2144
- # fields: "FieldNamesType",
2145
- # marker: "PageMarkerType",
2146
- # }
2147
- #
2148
1792
  # @!attribute [rw] authentication_token
2149
- # Amazon WorkDocs authentication token. Not required when using AWS
2150
- # administrator credentials to access the API.
1793
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1794
+ # Web Services administrator credentials to access the API.
2151
1795
  # @return [String]
2152
1796
  #
2153
1797
  # @!attribute [rw] folder_id
@@ -2191,18 +1835,9 @@ module Aws::WorkDocs
2191
1835
  include Aws::Structure
2192
1836
  end
2193
1837
 
2194
- # @note When making an API call, you may pass GetFolderRequest
2195
- # data as a hash:
2196
- #
2197
- # {
2198
- # authentication_token: "AuthenticationHeaderType",
2199
- # folder_id: "ResourceIdType", # required
2200
- # include_custom_metadata: false,
2201
- # }
2202
- #
2203
1838
  # @!attribute [rw] authentication_token
2204
- # Amazon WorkDocs authentication token. Not required when using AWS
2205
- # administrator credentials to access the API.
1839
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1840
+ # Web Services administrator credentials to access the API.
2206
1841
  # @return [String]
2207
1842
  #
2208
1843
  # @!attribute [rw] folder_id
@@ -2240,20 +1875,9 @@ module Aws::WorkDocs
2240
1875
  include Aws::Structure
2241
1876
  end
2242
1877
 
2243
- # @note When making an API call, you may pass GetResourcesRequest
2244
- # data as a hash:
2245
- #
2246
- # {
2247
- # authentication_token: "AuthenticationHeaderType",
2248
- # user_id: "IdType",
2249
- # collection_type: "SHARED_WITH_ME", # accepts SHARED_WITH_ME
2250
- # limit: 1,
2251
- # marker: "PageMarkerType",
2252
- # }
2253
- #
2254
1878
  # @!attribute [rw] authentication_token
2255
1879
  # The Amazon WorkDocs authentication token. Not required when using
2256
- # AWS administrator credentials to access the API.
1880
+ # Amazon Web Services administrator credentials to access the API.
2257
1881
  # @return [String]
2258
1882
  #
2259
1883
  # @!attribute [rw] user_id
@@ -2341,23 +1965,9 @@ module Aws::WorkDocs
2341
1965
  include Aws::Structure
2342
1966
  end
2343
1967
 
2344
- # @note When making an API call, you may pass InitiateDocumentVersionUploadRequest
2345
- # data as a hash:
2346
- #
2347
- # {
2348
- # authentication_token: "AuthenticationHeaderType",
2349
- # id: "ResourceIdType",
2350
- # name: "ResourceNameType",
2351
- # content_created_timestamp: Time.now,
2352
- # content_modified_timestamp: Time.now,
2353
- # content_type: "DocumentContentType",
2354
- # document_size_in_bytes: 1,
2355
- # parent_folder_id: "ResourceIdType",
2356
- # }
2357
- #
2358
1968
  # @!attribute [rw] authentication_token
2359
- # Amazon WorkDocs authentication token. Not required when using AWS
2360
- # administrator credentials to access the API.
1969
+ # Amazon WorkDocs authentication token. Not required when using Amazon
1970
+ # Web Services administrator credentials to access the API.
2361
1971
  # @return [String]
2362
1972
  #
2363
1973
  # @!attribute [rw] id
@@ -2490,17 +2100,9 @@ module Aws::WorkDocs
2490
2100
 
2491
2101
  # Set of options which defines notification preferences of given action.
2492
2102
  #
2493
- # @note When making an API call, you may pass NotificationOptions
2494
- # data as a hash:
2495
- #
2496
- # {
2497
- # send_email: false,
2498
- # email_message: "MessageType",
2499
- # }
2500
- #
2501
2103
  # @!attribute [rw] send_email
2502
2104
  # Boolean value to indicate an email notification should be sent to
2503
- # the receipients.
2105
+ # the recipients.
2504
2106
  # @return [Boolean]
2505
2107
  #
2506
2108
  # @!attribute [rw] email_message
@@ -2591,17 +2193,9 @@ module Aws::WorkDocs
2591
2193
  include Aws::Structure
2592
2194
  end
2593
2195
 
2594
- # @note When making an API call, you may pass RemoveAllResourcePermissionsRequest
2595
- # data as a hash:
2596
- #
2597
- # {
2598
- # authentication_token: "AuthenticationHeaderType",
2599
- # resource_id: "ResourceIdType", # required
2600
- # }
2601
- #
2602
2196
  # @!attribute [rw] authentication_token
2603
- # Amazon WorkDocs authentication token. Not required when using AWS
2604
- # administrator credentials to access the API.
2197
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2198
+ # Web Services administrator credentials to access the API.
2605
2199
  # @return [String]
2606
2200
  #
2607
2201
  # @!attribute [rw] resource_id
@@ -2617,19 +2211,9 @@ module Aws::WorkDocs
2617
2211
  include Aws::Structure
2618
2212
  end
2619
2213
 
2620
- # @note When making an API call, you may pass RemoveResourcePermissionRequest
2621
- # data as a hash:
2622
- #
2623
- # {
2624
- # authentication_token: "AuthenticationHeaderType",
2625
- # resource_id: "ResourceIdType", # required
2626
- # principal_id: "IdType", # required
2627
- # principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
2628
- # }
2629
- #
2630
2214
  # @!attribute [rw] authentication_token
2631
- # Amazon WorkDocs authentication token. Not required when using AWS
2632
- # administrator credentials to access the API.
2215
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2216
+ # Web Services administrator credentials to access the API.
2633
2217
  # @return [String]
2634
2218
  #
2635
2219
  # @!attribute [rw] resource_id
@@ -2760,17 +2344,9 @@ module Aws::WorkDocs
2760
2344
  include Aws::Structure
2761
2345
  end
2762
2346
 
2763
- # @note When making an API call, you may pass RestoreDocumentVersionsRequest
2764
- # data as a hash:
2765
- #
2766
- # {
2767
- # authentication_token: "AuthenticationHeaderType",
2768
- # document_id: "ResourceIdType", # required
2769
- # }
2770
- #
2771
2347
  # @!attribute [rw] authentication_token
2772
- # Amazon WorkDocs authentication token. Not required when using AWS
2773
- # administrator credentials to access the API.
2348
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2349
+ # Web Services administrator credentials to access the API.
2774
2350
  # @return [String]
2775
2351
  #
2776
2352
  # @!attribute [rw] document_id
@@ -2801,15 +2377,6 @@ module Aws::WorkDocs
2801
2377
 
2802
2378
  # Describes the recipient type and ID, if available.
2803
2379
  #
2804
- # @note When making an API call, you may pass SharePrincipal
2805
- # data as a hash:
2806
- #
2807
- # {
2808
- # id: "IdType", # required
2809
- # type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
2810
- # role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
2811
- # }
2812
- #
2813
2380
  # @!attribute [rw] id
2814
2381
  # The ID of the recipient.
2815
2382
  # @return [String]
@@ -2899,14 +2466,6 @@ module Aws::WorkDocs
2899
2466
 
2900
2467
  # Describes the storage for a user.
2901
2468
  #
2902
- # @note When making an API call, you may pass StorageRuleType
2903
- # data as a hash:
2904
- #
2905
- # {
2906
- # storage_allocated_in_bytes: 1,
2907
- # storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
2908
- # }
2909
- #
2910
2469
  # @!attribute [rw] storage_allocated_in_bytes
2911
2470
  # The amount of storage allocated, in bytes.
2912
2471
  # @return [Integer]
@@ -2995,20 +2554,9 @@ module Aws::WorkDocs
2995
2554
  include Aws::Structure
2996
2555
  end
2997
2556
 
2998
- # @note When making an API call, you may pass UpdateDocumentRequest
2999
- # data as a hash:
3000
- #
3001
- # {
3002
- # authentication_token: "AuthenticationHeaderType",
3003
- # document_id: "ResourceIdType", # required
3004
- # name: "ResourceNameType",
3005
- # parent_folder_id: "ResourceIdType",
3006
- # resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
3007
- # }
3008
- #
3009
2557
  # @!attribute [rw] authentication_token
3010
- # Amazon WorkDocs authentication token. Not required when using AWS
3011
- # administrator credentials to access the API.
2558
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2559
+ # Web Services administrator credentials to access the API.
3012
2560
  # @return [String]
3013
2561
  #
3014
2562
  # @!attribute [rw] document_id
@@ -3040,19 +2588,9 @@ module Aws::WorkDocs
3040
2588
  include Aws::Structure
3041
2589
  end
3042
2590
 
3043
- # @note When making an API call, you may pass UpdateDocumentVersionRequest
3044
- # data as a hash:
3045
- #
3046
- # {
3047
- # authentication_token: "AuthenticationHeaderType",
3048
- # document_id: "ResourceIdType", # required
3049
- # version_id: "DocumentVersionIdType", # required
3050
- # version_status: "ACTIVE", # accepts ACTIVE
3051
- # }
3052
- #
3053
2591
  # @!attribute [rw] authentication_token
3054
- # Amazon WorkDocs authentication token. Not required when using AWS
3055
- # administrator credentials to access the API.
2592
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2593
+ # Web Services administrator credentials to access the API.
3056
2594
  # @return [String]
3057
2595
  #
3058
2596
  # @!attribute [rw] document_id
@@ -3078,20 +2616,9 @@ module Aws::WorkDocs
3078
2616
  include Aws::Structure
3079
2617
  end
3080
2618
 
3081
- # @note When making an API call, you may pass UpdateFolderRequest
3082
- # data as a hash:
3083
- #
3084
- # {
3085
- # authentication_token: "AuthenticationHeaderType",
3086
- # folder_id: "ResourceIdType", # required
3087
- # name: "ResourceNameType",
3088
- # parent_folder_id: "ResourceIdType",
3089
- # resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
3090
- # }
3091
- #
3092
2619
  # @!attribute [rw] authentication_token
3093
- # Amazon WorkDocs authentication token. Not required when using AWS
3094
- # administrator credentials to access the API.
2620
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2621
+ # Web Services administrator credentials to access the API.
3095
2622
  # @return [String]
3096
2623
  #
3097
2624
  # @!attribute [rw] folder_id
@@ -3123,27 +2650,9 @@ module Aws::WorkDocs
3123
2650
  include Aws::Structure
3124
2651
  end
3125
2652
 
3126
- # @note When making an API call, you may pass UpdateUserRequest
3127
- # data as a hash:
3128
- #
3129
- # {
3130
- # authentication_token: "AuthenticationHeaderType",
3131
- # user_id: "IdType", # required
3132
- # given_name: "UserAttributeValueType",
3133
- # surname: "UserAttributeValueType",
3134
- # type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
3135
- # storage_rule: {
3136
- # storage_allocated_in_bytes: 1,
3137
- # storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
3138
- # },
3139
- # time_zone_id: "TimeZoneIdType",
3140
- # locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
3141
- # grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
3142
- # }
3143
- #
3144
2653
  # @!attribute [rw] authentication_token
3145
- # Amazon WorkDocs authentication token. Not required when using AWS
3146
- # administrator credentials to access the API.
2654
+ # Amazon WorkDocs authentication token. Not required when using Amazon
2655
+ # Web Services administrator credentials to access the API.
3147
2656
  # @return [String]
3148
2657
  #
3149
2658
  # @!attribute [rw] user_id
@@ -3175,7 +2684,7 @@ module Aws::WorkDocs
3175
2684
  # @return [String]
3176
2685
  #
3177
2686
  # @!attribute [rw] grant_poweruser_privileges
3178
- # Boolean value to determine whether the user is granted Poweruser
2687
+ # Boolean value to determine whether the user is granted Power user
3179
2688
  # privileges.
3180
2689
  # @return [String]
3181
2690
  #