@aws-sdk/client-workdocs 3.379.1 → 3.382.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.
@@ -5,14 +5,17 @@ import { WorkDocsServiceException as __BaseException } from "./WorkDocsServiceEx
5
5
  */
6
6
  export interface AbortDocumentVersionUploadRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
9
10
  */
10
11
  AuthenticationToken?: string;
11
12
  /**
13
+ * @public
12
14
  * <p>The ID of the document.</p>
13
15
  */
14
16
  DocumentId: string | undefined;
15
17
  /**
18
+ * @public
16
19
  * <p>The ID of the version.</p>
17
20
  */
18
21
  VersionId: string | undefined;
@@ -39,6 +42,7 @@ export declare class EntityNotExistsException extends __BaseException {
39
42
  readonly $fault: "client";
40
43
  Message?: string;
41
44
  /**
45
+ * @public
42
46
  * <p>The IDs of the non-existent resources.</p>
43
47
  */
44
48
  EntityIds?: string[];
@@ -120,10 +124,12 @@ export declare class UnauthorizedResourceAccessException extends __BaseException
120
124
  */
121
125
  export interface ActivateUserRequest {
122
126
  /**
127
+ * @public
123
128
  * <p>The ID of the user.</p>
124
129
  */
125
130
  UserId: string | undefined;
126
131
  /**
132
+ * @public
127
133
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
128
134
  */
129
135
  AuthenticationToken?: string;
@@ -180,10 +186,12 @@ export type StorageType = (typeof StorageType)[keyof typeof StorageType];
180
186
  */
181
187
  export interface StorageRuleType {
182
188
  /**
189
+ * @public
183
190
  * <p>The amount of storage allocated, in bytes.</p>
184
191
  */
185
192
  StorageAllocatedInBytes?: number;
186
193
  /**
194
+ * @public
187
195
  * <p>The type of storage.</p>
188
196
  */
189
197
  StorageType?: StorageType | string;
@@ -194,10 +202,12 @@ export interface StorageRuleType {
194
202
  */
195
203
  export interface UserStorageMetadata {
196
204
  /**
205
+ * @public
197
206
  * <p>The amount of storage used, in bytes.</p>
198
207
  */
199
208
  StorageUtilizedInBytes?: number;
200
209
  /**
210
+ * @public
201
211
  * <p>The storage for a user.</p>
202
212
  */
203
213
  StorageRule?: StorageRuleType;
@@ -223,62 +233,77 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
223
233
  */
224
234
  export interface User {
225
235
  /**
236
+ * @public
226
237
  * <p>The ID of the user.</p>
227
238
  */
228
239
  Id?: string;
229
240
  /**
241
+ * @public
230
242
  * <p>The login name of the user.</p>
231
243
  */
232
244
  Username?: string;
233
245
  /**
246
+ * @public
234
247
  * <p>The email address of the user.</p>
235
248
  */
236
249
  EmailAddress?: string;
237
250
  /**
251
+ * @public
238
252
  * <p>The given name of the user.</p>
239
253
  */
240
254
  GivenName?: string;
241
255
  /**
256
+ * @public
242
257
  * <p>The surname of the user.</p>
243
258
  */
244
259
  Surname?: string;
245
260
  /**
261
+ * @public
246
262
  * <p>The ID of the organization.</p>
247
263
  */
248
264
  OrganizationId?: string;
249
265
  /**
266
+ * @public
250
267
  * <p>The ID of the root folder.</p>
251
268
  */
252
269
  RootFolderId?: string;
253
270
  /**
271
+ * @public
254
272
  * <p>The ID of the recycle bin folder.</p>
255
273
  */
256
274
  RecycleBinFolderId?: string;
257
275
  /**
276
+ * @public
258
277
  * <p>The status of the user.</p>
259
278
  */
260
279
  Status?: UserStatusType | string;
261
280
  /**
281
+ * @public
262
282
  * <p>The type of user.</p>
263
283
  */
264
284
  Type?: UserType | string;
265
285
  /**
286
+ * @public
266
287
  * <p>The time when the user was created.</p>
267
288
  */
268
289
  CreatedTimestamp?: Date;
269
290
  /**
291
+ * @public
270
292
  * <p>The time when the user was modified.</p>
271
293
  */
272
294
  ModifiedTimestamp?: Date;
273
295
  /**
296
+ * @public
274
297
  * <p>The time zone ID of the user.</p>
275
298
  */
276
299
  TimeZoneId?: string;
277
300
  /**
301
+ * @public
278
302
  * <p>The locale of the user.</p>
279
303
  */
280
304
  Locale?: LocaleType | string;
281
305
  /**
306
+ * @public
282
307
  * <p>The storage for the user.</p>
283
308
  */
284
309
  Storage?: UserStorageMetadata;
@@ -288,6 +313,7 @@ export interface User {
288
313
  */
289
314
  export interface ActivateUserResponse {
290
315
  /**
316
+ * @public
291
317
  * <p>The user information.</p>
292
318
  */
293
319
  User?: User;
@@ -311,26 +337,32 @@ export type CommentStatusType = (typeof CommentStatusType)[keyof typeof CommentS
311
337
  */
312
338
  export interface CommentMetadata {
313
339
  /**
340
+ * @public
314
341
  * <p>The ID of the comment.</p>
315
342
  */
316
343
  CommentId?: string;
317
344
  /**
345
+ * @public
318
346
  * <p>The user who made the comment.</p>
319
347
  */
320
348
  Contributor?: User;
321
349
  /**
350
+ * @public
322
351
  * <p>The timestamp that the comment was created.</p>
323
352
  */
324
353
  CreatedTimestamp?: Date;
325
354
  /**
355
+ * @public
326
356
  * <p>The status of the comment.</p>
327
357
  */
328
358
  CommentStatus?: CommentStatusType | string;
329
359
  /**
360
+ * @public
330
361
  * <p>The ID of the user being replied to.</p>
331
362
  */
332
363
  RecipientId?: string;
333
364
  /**
365
+ * @public
334
366
  * <p>The ID of the user who made the comment.</p>
335
367
  */
336
368
  ContributorId?: string;
@@ -341,22 +373,27 @@ export interface CommentMetadata {
341
373
  */
342
374
  export interface UserMetadata {
343
375
  /**
376
+ * @public
344
377
  * <p>The ID of the user.</p>
345
378
  */
346
379
  Id?: string;
347
380
  /**
381
+ * @public
348
382
  * <p>The name of the user.</p>
349
383
  */
350
384
  Username?: string;
351
385
  /**
386
+ * @public
352
387
  * <p>The given name of the user before a rename operation.</p>
353
388
  */
354
389
  GivenName?: string;
355
390
  /**
391
+ * @public
356
392
  * <p>The surname of the user.</p>
357
393
  */
358
394
  Surname?: string;
359
395
  /**
396
+ * @public
360
397
  * <p>The email address of the user.</p>
361
398
  */
362
399
  EmailAddress?: string;
@@ -379,31 +416,38 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
379
416
  */
380
417
  export interface ResourceMetadata {
381
418
  /**
419
+ * @public
382
420
  * <p>The type of resource.</p>
383
421
  */
384
422
  Type?: ResourceType | string;
385
423
  /**
424
+ * @public
386
425
  * <p>The name of the resource.</p>
387
426
  */
388
427
  Name?: string;
389
428
  /**
429
+ * @public
390
430
  * <p>The original name of the resource before a rename operation.</p>
391
431
  */
392
432
  OriginalName?: string;
393
433
  /**
434
+ * @public
394
435
  * <p>The ID of the resource.</p>
395
436
  */
396
437
  Id?: string;
397
438
  /**
439
+ * @public
398
440
  * <p>The version ID of the resource. This is an optional field and is filled for action
399
441
  * on document version.</p>
400
442
  */
401
443
  VersionId?: string;
402
444
  /**
445
+ * @public
403
446
  * <p>The owner of the resource.</p>
404
447
  */
405
448
  Owner?: UserMetadata;
406
449
  /**
450
+ * @public
407
451
  * <p>The parent ID of the resource before a rename operation.</p>
408
452
  */
409
453
  ParentId?: string;
@@ -414,10 +458,12 @@ export interface ResourceMetadata {
414
458
  */
415
459
  export interface GroupMetadata {
416
460
  /**
461
+ * @public
417
462
  * <p>The ID of the user group.</p>
418
463
  */
419
464
  Id?: string;
420
465
  /**
466
+ * @public
421
467
  * <p>The name of the group.</p>
422
468
  */
423
469
  Name?: string;
@@ -428,10 +474,12 @@ export interface GroupMetadata {
428
474
  */
429
475
  export interface Participants {
430
476
  /**
477
+ * @public
431
478
  * <p>The list of users.</p>
432
479
  */
433
480
  Users?: UserMetadata[];
434
481
  /**
482
+ * @public
435
483
  * <p>The list of user groups.</p>
436
484
  */
437
485
  Groups?: GroupMetadata[];
@@ -485,14 +533,17 @@ export type ActivityType = (typeof ActivityType)[keyof typeof ActivityType];
485
533
  */
486
534
  export interface Activity {
487
535
  /**
536
+ * @public
488
537
  * <p>The activity type.</p>
489
538
  */
490
539
  Type?: ActivityType | string;
491
540
  /**
541
+ * @public
492
542
  * <p>The timestamp when the action was performed.</p>
493
543
  */
494
544
  TimeStamp?: Date;
495
545
  /**
546
+ * @public
496
547
  * <p>Indicates whether an activity is indirect or direct. An indirect activity results
497
548
  * from a direct activity performed on a parent resource. For example, sharing a parent
498
549
  * folder (the direct activity) shares all of the subfolders and documents within the
@@ -500,29 +551,35 @@ export interface Activity {
500
551
  */
501
552
  IsIndirectActivity?: boolean;
502
553
  /**
554
+ * @public
503
555
  * <p>The ID of the organization.</p>
504
556
  */
505
557
  OrganizationId?: string;
506
558
  /**
559
+ * @public
507
560
  * <p>The user who performed the action.</p>
508
561
  */
509
562
  Initiator?: UserMetadata;
510
563
  /**
564
+ * @public
511
565
  * <p>The list of users or groups impacted by this action. This is an optional field and
512
566
  * is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED,
513
567
  * DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.</p>
514
568
  */
515
569
  Participants?: Participants;
516
570
  /**
571
+ * @public
517
572
  * <p>The metadata of the resource involved in the user action.</p>
518
573
  */
519
574
  ResourceMetadata?: ResourceMetadata;
520
575
  /**
576
+ * @public
521
577
  * <p>The original parent of the resource. This is an optional field and is filled for
522
578
  * move activities.</p>
523
579
  */
524
580
  OriginalParent?: ResourceMetadata;
525
581
  /**
582
+ * @public
526
583
  * <p>Metadata of the commenting activity. This is an optional field and is filled for
527
584
  * commenting activities.</p>
528
585
  */
@@ -545,11 +602,13 @@ export type AdditionalResponseFieldType = (typeof AdditionalResponseFieldType)[k
545
602
  */
546
603
  export interface NotificationOptions {
547
604
  /**
605
+ * @public
548
606
  * <p>Boolean value to indicate an email notification should be sent to the
549
607
  * recipients.</p>
550
608
  */
551
609
  SendEmail?: boolean;
552
610
  /**
611
+ * @public
553
612
  * <p>Text value to be included in the email body.</p>
554
613
  */
555
614
  EmailMessage?: string;
@@ -589,14 +648,17 @@ export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
589
648
  */
590
649
  export interface SharePrincipal {
591
650
  /**
651
+ * @public
592
652
  * <p>The ID of the recipient.</p>
593
653
  */
594
654
  Id: string | undefined;
595
655
  /**
656
+ * @public
596
657
  * <p>The type of the recipient.</p>
597
658
  */
598
659
  Type: PrincipalType | string | undefined;
599
660
  /**
661
+ * @public
600
662
  * <p>The role of the recipient.</p>
601
663
  */
602
664
  Role: RoleType | string | undefined;
@@ -606,18 +668,22 @@ export interface SharePrincipal {
606
668
  */
607
669
  export interface AddResourcePermissionsRequest {
608
670
  /**
671
+ * @public
609
672
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
610
673
  */
611
674
  AuthenticationToken?: string;
612
675
  /**
676
+ * @public
613
677
  * <p>The ID of the resource.</p>
614
678
  */
615
679
  ResourceId: string | undefined;
616
680
  /**
681
+ * @public
617
682
  * <p>The users, groups, or organization being granted permission.</p>
618
683
  */
619
684
  Principals: SharePrincipal[] | undefined;
620
685
  /**
686
+ * @public
621
687
  * <p>The notification options.</p>
622
688
  */
623
689
  NotificationOptions?: NotificationOptions;
@@ -640,26 +706,32 @@ export type ShareStatusType = (typeof ShareStatusType)[keyof typeof ShareStatusT
640
706
  */
641
707
  export interface ShareResult {
642
708
  /**
709
+ * @public
643
710
  * <p>The ID of the principal.</p>
644
711
  */
645
712
  PrincipalId?: string;
646
713
  /**
714
+ * @public
647
715
  * <p>The ID of the invited user.</p>
648
716
  */
649
717
  InviteePrincipalId?: string;
650
718
  /**
719
+ * @public
651
720
  * <p>The role.</p>
652
721
  */
653
722
  Role?: RoleType | string;
654
723
  /**
724
+ * @public
655
725
  * <p>The status.</p>
656
726
  */
657
727
  Status?: ShareStatusType | string;
658
728
  /**
729
+ * @public
659
730
  * <p>The ID of the resource that was shared.</p>
660
731
  */
661
732
  ShareId?: string;
662
733
  /**
734
+ * @public
663
735
  * <p>The status message.</p>
664
736
  */
665
737
  StatusMessage?: string;
@@ -669,6 +741,7 @@ export interface ShareResult {
669
741
  */
670
742
  export interface AddResourcePermissionsResponse {
671
743
  /**
744
+ * @public
672
745
  * <p>The share results.</p>
673
746
  */
674
747
  ShareResults?: ShareResult[];
@@ -690,36 +763,44 @@ export type CommentVisibilityType = (typeof CommentVisibilityType)[keyof typeof
690
763
  */
691
764
  export interface CreateCommentRequest {
692
765
  /**
766
+ * @public
693
767
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
694
768
  */
695
769
  AuthenticationToken?: string;
696
770
  /**
771
+ * @public
697
772
  * <p>The ID of the document.</p>
698
773
  */
699
774
  DocumentId: string | undefined;
700
775
  /**
776
+ * @public
701
777
  * <p>The ID of the document version.</p>
702
778
  */
703
779
  VersionId: string | undefined;
704
780
  /**
781
+ * @public
705
782
  * <p>The ID of the parent comment.</p>
706
783
  */
707
784
  ParentId?: string;
708
785
  /**
786
+ * @public
709
787
  * <p>The ID of the root comment in the thread.</p>
710
788
  */
711
789
  ThreadId?: string;
712
790
  /**
791
+ * @public
713
792
  * <p>The text of the comment.</p>
714
793
  */
715
794
  Text: string | undefined;
716
795
  /**
796
+ * @public
717
797
  * <p>The visibility of the comment. Options are either PRIVATE, where the comment is
718
798
  * visible only to the comment author and document owner and co-owners, or PUBLIC, where
719
799
  * the comment is visible to document owners, co-owners, and contributors.</p>
720
800
  */
721
801
  Visibility?: CommentVisibilityType | string;
722
802
  /**
803
+ * @public
723
804
  * <p>Set this parameter to TRUE to send an email out to the document collaborators after
724
805
  * the comment is created.</p>
725
806
  */
@@ -731,40 +812,49 @@ export interface CreateCommentRequest {
731
812
  */
732
813
  export interface Comment {
733
814
  /**
815
+ * @public
734
816
  * <p>The ID of the comment.</p>
735
817
  */
736
818
  CommentId: string | undefined;
737
819
  /**
820
+ * @public
738
821
  * <p>The ID of the parent comment.</p>
739
822
  */
740
823
  ParentId?: string;
741
824
  /**
825
+ * @public
742
826
  * <p>The ID of the root comment in the thread.</p>
743
827
  */
744
828
  ThreadId?: string;
745
829
  /**
830
+ * @public
746
831
  * <p>The text of the comment.</p>
747
832
  */
748
833
  Text?: string;
749
834
  /**
835
+ * @public
750
836
  * <p>The details of the user who made the comment.</p>
751
837
  */
752
838
  Contributor?: User;
753
839
  /**
840
+ * @public
754
841
  * <p>The time that the comment was created.</p>
755
842
  */
756
843
  CreatedTimestamp?: Date;
757
844
  /**
845
+ * @public
758
846
  * <p>The status of the comment.</p>
759
847
  */
760
848
  Status?: CommentStatusType | string;
761
849
  /**
850
+ * @public
762
851
  * <p>The visibility of the comment. Options are either PRIVATE, where the comment is
763
852
  * visible only to the comment author and document owner and co-owners, or PUBLIC, where
764
853
  * the comment is visible to document owners, co-owners, and contributors.</p>
765
854
  */
766
855
  Visibility?: CommentVisibilityType | string;
767
856
  /**
857
+ * @public
768
858
  * <p>If the comment is a reply to another user's comment, this field contains the user
769
859
  * ID of the user being replied to.</p>
770
860
  */
@@ -775,6 +865,7 @@ export interface Comment {
775
865
  */
776
866
  export interface CreateCommentResponse {
777
867
  /**
868
+ * @public
778
869
  * <p>The comment that has been created.</p>
779
870
  */
780
871
  Comment?: Comment;
@@ -811,19 +902,23 @@ export declare class InvalidCommentOperationException extends __BaseException {
811
902
  */
812
903
  export interface CreateCustomMetadataRequest {
813
904
  /**
905
+ * @public
814
906
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
815
907
  */
816
908
  AuthenticationToken?: string;
817
909
  /**
910
+ * @public
818
911
  * <p>The ID of the resource.</p>
819
912
  */
820
913
  ResourceId: string | undefined;
821
914
  /**
915
+ * @public
822
916
  * <p>The ID of the version, if the custom metadata is being added to a document
823
917
  * version.</p>
824
918
  */
825
919
  VersionId?: string;
826
920
  /**
921
+ * @public
827
922
  * <p>Custom metadata in the form of name-value pairs.</p>
828
923
  */
829
924
  CustomMetadata: Record<string, string> | undefined;
@@ -865,14 +960,17 @@ export declare class ConflictingOperationException extends __BaseException {
865
960
  */
866
961
  export interface CreateFolderRequest {
867
962
  /**
963
+ * @public
868
964
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
869
965
  */
870
966
  AuthenticationToken?: string;
871
967
  /**
968
+ * @public
872
969
  * <p>The name of the new folder.</p>
873
970
  */
874
971
  Name?: string;
875
972
  /**
973
+ * @public
876
974
  * <p>The ID of the parent folder.</p>
877
975
  */
878
976
  ParentFolderId: string | undefined;
@@ -897,47 +995,58 @@ export type ResourceStateType = (typeof ResourceStateType)[keyof typeof Resource
897
995
  */
898
996
  export interface FolderMetadata {
899
997
  /**
998
+ * @public
900
999
  * <p>The ID of the folder.</p>
901
1000
  */
902
1001
  Id?: string;
903
1002
  /**
1003
+ * @public
904
1004
  * <p>The name of the folder.</p>
905
1005
  */
906
1006
  Name?: string;
907
1007
  /**
1008
+ * @public
908
1009
  * <p>The ID of the creator.</p>
909
1010
  */
910
1011
  CreatorId?: string;
911
1012
  /**
1013
+ * @public
912
1014
  * <p>The ID of the parent folder.</p>
913
1015
  */
914
1016
  ParentFolderId?: string;
915
1017
  /**
1018
+ * @public
916
1019
  * <p>The time when the folder was created.</p>
917
1020
  */
918
1021
  CreatedTimestamp?: Date;
919
1022
  /**
1023
+ * @public
920
1024
  * <p>The time when the folder was updated.</p>
921
1025
  */
922
1026
  ModifiedTimestamp?: Date;
923
1027
  /**
1028
+ * @public
924
1029
  * <p>The resource state of the folder.</p>
925
1030
  */
926
1031
  ResourceState?: ResourceStateType | string;
927
1032
  /**
1033
+ * @public
928
1034
  * <p>The unique identifier created from the subfolders and documents of the
929
1035
  * folder.</p>
930
1036
  */
931
1037
  Signature?: string;
932
1038
  /**
1039
+ * @public
933
1040
  * <p>List of labels on the folder.</p>
934
1041
  */
935
1042
  Labels?: string[];
936
1043
  /**
1044
+ * @public
937
1045
  * <p>The size of the folder metadata.</p>
938
1046
  */
939
1047
  Size?: number;
940
1048
  /**
1049
+ * @public
941
1050
  * <p>The size of the latest version of the folder metadata.</p>
942
1051
  */
943
1052
  LatestVersionSize?: number;
@@ -947,6 +1056,7 @@ export interface FolderMetadata {
947
1056
  */
948
1057
  export interface CreateFolderResponse {
949
1058
  /**
1059
+ * @public
950
1060
  * <p>The metadata of the folder.</p>
951
1061
  */
952
1062
  Metadata?: FolderMetadata;
@@ -982,14 +1092,17 @@ export declare class LimitExceededException extends __BaseException {
982
1092
  */
983
1093
  export interface CreateLabelsRequest {
984
1094
  /**
1095
+ * @public
985
1096
  * <p>The ID of the resource.</p>
986
1097
  */
987
1098
  ResourceId: string | undefined;
988
1099
  /**
1100
+ * @public
989
1101
  * <p>List of labels to add to the resource.</p>
990
1102
  */
991
1103
  Labels: string[] | undefined;
992
1104
  /**
1105
+ * @public
993
1106
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
994
1107
  */
995
1108
  AuthenticationToken?: string;
@@ -1041,20 +1154,24 @@ export type SubscriptionType = (typeof SubscriptionType)[keyof typeof Subscripti
1041
1154
  */
1042
1155
  export interface CreateNotificationSubscriptionRequest {
1043
1156
  /**
1157
+ * @public
1044
1158
  * <p>The ID of the organization.</p>
1045
1159
  */
1046
1160
  OrganizationId: string | undefined;
1047
1161
  /**
1162
+ * @public
1048
1163
  * <p>The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint
1049
1164
  * is a URL that begins with <code>https</code>.</p>
1050
1165
  */
1051
1166
  Endpoint: string | undefined;
1052
1167
  /**
1168
+ * @public
1053
1169
  * <p>The protocol to use. The supported value is https, which delivers JSON-encoded
1054
1170
  * messages using HTTPS POST.</p>
1055
1171
  */
1056
1172
  Protocol: SubscriptionProtocolType | string | undefined;
1057
1173
  /**
1174
+ * @public
1058
1175
  * <p>The notification type.</p>
1059
1176
  */
1060
1177
  SubscriptionType: SubscriptionType | string | undefined;
@@ -1065,14 +1182,17 @@ export interface CreateNotificationSubscriptionRequest {
1065
1182
  */
1066
1183
  export interface Subscription {
1067
1184
  /**
1185
+ * @public
1068
1186
  * <p>The ID of the subscription.</p>
1069
1187
  */
1070
1188
  SubscriptionId?: string;
1071
1189
  /**
1190
+ * @public
1072
1191
  * <p>The endpoint of the subscription.</p>
1073
1192
  */
1074
1193
  EndPoint?: string;
1075
1194
  /**
1195
+ * @public
1076
1196
  * <p>The protocol of the subscription.</p>
1077
1197
  */
1078
1198
  Protocol?: SubscriptionProtocolType | string;
@@ -1082,6 +1202,7 @@ export interface Subscription {
1082
1202
  */
1083
1203
  export interface CreateNotificationSubscriptionResponse {
1084
1204
  /**
1205
+ * @public
1085
1206
  * <p>The subscription.</p>
1086
1207
  */
1087
1208
  Subscription?: Subscription;
@@ -1118,38 +1239,47 @@ export declare class TooManySubscriptionsException extends __BaseException {
1118
1239
  */
1119
1240
  export interface CreateUserRequest {
1120
1241
  /**
1242
+ * @public
1121
1243
  * <p>The ID of the organization.</p>
1122
1244
  */
1123
1245
  OrganizationId?: string;
1124
1246
  /**
1247
+ * @public
1125
1248
  * <p>The login name of the user.</p>
1126
1249
  */
1127
1250
  Username: string | undefined;
1128
1251
  /**
1252
+ * @public
1129
1253
  * <p>The email address of the user.</p>
1130
1254
  */
1131
1255
  EmailAddress?: string;
1132
1256
  /**
1257
+ * @public
1133
1258
  * <p>The given name of the user.</p>
1134
1259
  */
1135
1260
  GivenName: string | undefined;
1136
1261
  /**
1262
+ * @public
1137
1263
  * <p>The surname of the user.</p>
1138
1264
  */
1139
1265
  Surname: string | undefined;
1140
1266
  /**
1267
+ * @public
1141
1268
  * <p>The password of the user.</p>
1142
1269
  */
1143
1270
  Password: string | undefined;
1144
1271
  /**
1272
+ * @public
1145
1273
  * <p>The time zone ID of the user.</p>
1146
1274
  */
1147
1275
  TimeZoneId?: string;
1148
1276
  /**
1277
+ * @public
1149
1278
  * <p>The amount of storage for the user.</p>
1150
1279
  */
1151
1280
  StorageRule?: StorageRuleType;
1152
1281
  /**
1282
+ * @public
1153
1283
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1154
1284
  */
1155
1285
  AuthenticationToken?: string;
@@ -1159,6 +1289,7 @@ export interface CreateUserRequest {
1159
1289
  */
1160
1290
  export interface CreateUserResponse {
1161
1291
  /**
1292
+ * @public
1162
1293
  * <p>The user information.</p>
1163
1294
  */
1164
1295
  User?: User;
@@ -1168,10 +1299,12 @@ export interface CreateUserResponse {
1168
1299
  */
1169
1300
  export interface DeactivateUserRequest {
1170
1301
  /**
1302
+ * @public
1171
1303
  * <p>The ID of the user.</p>
1172
1304
  */
1173
1305
  UserId: string | undefined;
1174
1306
  /**
1307
+ * @public
1175
1308
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1176
1309
  */
1177
1310
  AuthenticationToken?: string;
@@ -1181,18 +1314,22 @@ export interface DeactivateUserRequest {
1181
1314
  */
1182
1315
  export interface DeleteCommentRequest {
1183
1316
  /**
1317
+ * @public
1184
1318
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1185
1319
  */
1186
1320
  AuthenticationToken?: string;
1187
1321
  /**
1322
+ * @public
1188
1323
  * <p>The ID of the document.</p>
1189
1324
  */
1190
1325
  DocumentId: string | undefined;
1191
1326
  /**
1327
+ * @public
1192
1328
  * <p>The ID of the document version.</p>
1193
1329
  */
1194
1330
  VersionId: string | undefined;
1195
1331
  /**
1332
+ * @public
1196
1333
  * <p>The ID of the comment.</p>
1197
1334
  */
1198
1335
  CommentId: string | undefined;
@@ -1202,23 +1339,28 @@ export interface DeleteCommentRequest {
1202
1339
  */
1203
1340
  export interface DeleteCustomMetadataRequest {
1204
1341
  /**
1342
+ * @public
1205
1343
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1206
1344
  */
1207
1345
  AuthenticationToken?: string;
1208
1346
  /**
1347
+ * @public
1209
1348
  * <p>The ID of the resource, either a document or folder.</p>
1210
1349
  */
1211
1350
  ResourceId: string | undefined;
1212
1351
  /**
1352
+ * @public
1213
1353
  * <p>The ID of the version, if the custom metadata is being deleted from a document
1214
1354
  * version.</p>
1215
1355
  */
1216
1356
  VersionId?: string;
1217
1357
  /**
1358
+ * @public
1218
1359
  * <p>List of properties to remove.</p>
1219
1360
  */
1220
1361
  Keys?: string[];
1221
1362
  /**
1363
+ * @public
1222
1364
  * <p>Flag to indicate removal of all custom metadata properties from the specified
1223
1365
  * resource.</p>
1224
1366
  */
@@ -1234,10 +1376,12 @@ export interface DeleteCustomMetadataResponse {
1234
1376
  */
1235
1377
  export interface DeleteDocumentRequest {
1236
1378
  /**
1379
+ * @public
1237
1380
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1238
1381
  */
1239
1382
  AuthenticationToken?: string;
1240
1383
  /**
1384
+ * @public
1241
1385
  * <p>The ID of the document.</p>
1242
1386
  */
1243
1387
  DocumentId: string | undefined;
@@ -1247,18 +1391,22 @@ export interface DeleteDocumentRequest {
1247
1391
  */
1248
1392
  export interface DeleteDocumentVersionRequest {
1249
1393
  /**
1394
+ * @public
1250
1395
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1251
1396
  */
1252
1397
  AuthenticationToken?: string;
1253
1398
  /**
1399
+ * @public
1254
1400
  * <p>The ID of the document associated with the version being deleted.</p>
1255
1401
  */
1256
1402
  DocumentId: string | undefined;
1257
1403
  /**
1404
+ * @public
1258
1405
  * <p>The ID of the version being deleted.</p>
1259
1406
  */
1260
1407
  VersionId: string | undefined;
1261
1408
  /**
1409
+ * @public
1262
1410
  * <p>Deletes all versions of a document prior to the current version.</p>
1263
1411
  */
1264
1412
  DeletePriorVersions: boolean | undefined;
@@ -1281,10 +1429,12 @@ export declare class InvalidOperationException extends __BaseException {
1281
1429
  */
1282
1430
  export interface DeleteFolderRequest {
1283
1431
  /**
1432
+ * @public
1284
1433
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1285
1434
  */
1286
1435
  AuthenticationToken?: string;
1287
1436
  /**
1437
+ * @public
1288
1438
  * <p>The ID of the folder.</p>
1289
1439
  */
1290
1440
  FolderId: string | undefined;
@@ -1294,10 +1444,12 @@ export interface DeleteFolderRequest {
1294
1444
  */
1295
1445
  export interface DeleteFolderContentsRequest {
1296
1446
  /**
1447
+ * @public
1297
1448
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1298
1449
  */
1299
1450
  AuthenticationToken?: string;
1300
1451
  /**
1452
+ * @public
1301
1453
  * <p>The ID of the folder.</p>
1302
1454
  */
1303
1455
  FolderId: string | undefined;
@@ -1307,18 +1459,22 @@ export interface DeleteFolderContentsRequest {
1307
1459
  */
1308
1460
  export interface DeleteLabelsRequest {
1309
1461
  /**
1462
+ * @public
1310
1463
  * <p>The ID of the resource.</p>
1311
1464
  */
1312
1465
  ResourceId: string | undefined;
1313
1466
  /**
1467
+ * @public
1314
1468
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1315
1469
  */
1316
1470
  AuthenticationToken?: string;
1317
1471
  /**
1472
+ * @public
1318
1473
  * <p>List of labels to delete from the resource.</p>
1319
1474
  */
1320
1475
  Labels?: string[];
1321
1476
  /**
1477
+ * @public
1322
1478
  * <p>Flag to request removal of all labels from the specified resource.</p>
1323
1479
  */
1324
1480
  DeleteAll?: boolean;
@@ -1333,10 +1489,12 @@ export interface DeleteLabelsResponse {
1333
1489
  */
1334
1490
  export interface DeleteNotificationSubscriptionRequest {
1335
1491
  /**
1492
+ * @public
1336
1493
  * <p>The ID of the subscription.</p>
1337
1494
  */
1338
1495
  SubscriptionId: string | undefined;
1339
1496
  /**
1497
+ * @public
1340
1498
  * <p>The ID of the organization.</p>
1341
1499
  */
1342
1500
  OrganizationId: string | undefined;
@@ -1346,11 +1504,13 @@ export interface DeleteNotificationSubscriptionRequest {
1346
1504
  */
1347
1505
  export interface DeleteUserRequest {
1348
1506
  /**
1507
+ * @public
1349
1508
  * <p>Amazon WorkDocs authentication token. Do not set this field when using
1350
1509
  * administrative API actions, as in accessing the API using Amazon Web Services credentials.</p>
1351
1510
  */
1352
1511
  AuthenticationToken?: string;
1353
1512
  /**
1513
+ * @public
1354
1514
  * <p>The ID of the user.</p>
1355
1515
  */
1356
1516
  UserId: string | undefined;
@@ -1360,40 +1520,48 @@ export interface DeleteUserRequest {
1360
1520
  */
1361
1521
  export interface DescribeActivitiesRequest {
1362
1522
  /**
1523
+ * @public
1363
1524
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1364
1525
  */
1365
1526
  AuthenticationToken?: string;
1366
1527
  /**
1528
+ * @public
1367
1529
  * <p>The timestamp that determines the starting time of the activities. The response
1368
1530
  * includes the activities performed after the specified timestamp.</p>
1369
1531
  */
1370
1532
  StartTime?: Date;
1371
1533
  /**
1534
+ * @public
1372
1535
  * <p>The timestamp that determines the end time of the activities. The response includes
1373
1536
  * the activities performed before the specified timestamp.</p>
1374
1537
  */
1375
1538
  EndTime?: Date;
1376
1539
  /**
1540
+ * @public
1377
1541
  * <p>The ID of the organization. This is a mandatory parameter when using administrative
1378
1542
  * API (SigV4) requests.</p>
1379
1543
  */
1380
1544
  OrganizationId?: string;
1381
1545
  /**
1546
+ * @public
1382
1547
  * <p>Specifies which activity types to include in the response. If this field is left
1383
1548
  * empty, all activity types are returned.</p>
1384
1549
  */
1385
1550
  ActivityTypes?: string;
1386
1551
  /**
1552
+ * @public
1387
1553
  * <p>The document or folder ID for which to describe activity types.</p>
1388
1554
  */
1389
1555
  ResourceId?: string;
1390
1556
  /**
1557
+ * @public
1391
1558
  * <p>The ID of the user who performed the action. The response includes activities
1392
1559
  * pertaining to this user. This is an optional parameter and is only applicable for
1393
1560
  * administrative API (SigV4) requests.</p>
1394
1561
  */
1395
1562
  UserId?: string;
1396
1563
  /**
1564
+ * @public
1397
1565
  * <p>Includes indirect activities. An indirect activity results from a direct activity
1398
1566
  * performed on a parent resource. For example, sharing a parent folder (the direct
1399
1567
  * activity) shares all of the subfolders and documents within the parent folder (the
@@ -1401,10 +1569,12 @@ export interface DescribeActivitiesRequest {
1401
1569
  */
1402
1570
  IncludeIndirectActivities?: boolean;
1403
1571
  /**
1572
+ * @public
1404
1573
  * <p>The maximum number of items to return.</p>
1405
1574
  */
1406
1575
  Limit?: number;
1407
1576
  /**
1577
+ * @public
1408
1578
  * <p>The marker for the next set of results.</p>
1409
1579
  */
1410
1580
  Marker?: string;
@@ -1414,10 +1584,12 @@ export interface DescribeActivitiesRequest {
1414
1584
  */
1415
1585
  export interface DescribeActivitiesResponse {
1416
1586
  /**
1587
+ * @public
1417
1588
  * <p>The list of activities for the specified user and time period.</p>
1418
1589
  */
1419
1590
  UserActivities?: Activity[];
1420
1591
  /**
1592
+ * @public
1421
1593
  * <p>The marker for the next set of results.</p>
1422
1594
  */
1423
1595
  Marker?: string;
@@ -1427,22 +1599,27 @@ export interface DescribeActivitiesResponse {
1427
1599
  */
1428
1600
  export interface DescribeCommentsRequest {
1429
1601
  /**
1602
+ * @public
1430
1603
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1431
1604
  */
1432
1605
  AuthenticationToken?: string;
1433
1606
  /**
1607
+ * @public
1434
1608
  * <p>The ID of the document.</p>
1435
1609
  */
1436
1610
  DocumentId: string | undefined;
1437
1611
  /**
1612
+ * @public
1438
1613
  * <p>The ID of the document version.</p>
1439
1614
  */
1440
1615
  VersionId: string | undefined;
1441
1616
  /**
1617
+ * @public
1442
1618
  * <p>The maximum number of items to return.</p>
1443
1619
  */
1444
1620
  Limit?: number;
1445
1621
  /**
1622
+ * @public
1446
1623
  * <p>The marker for the next set of results. This marker was received from a previous
1447
1624
  * call.</p>
1448
1625
  */
@@ -1453,10 +1630,12 @@ export interface DescribeCommentsRequest {
1453
1630
  */
1454
1631
  export interface DescribeCommentsResponse {
1455
1632
  /**
1633
+ * @public
1456
1634
  * <p>The list of comments for the specified document version.</p>
1457
1635
  */
1458
1636
  Comments?: Comment[];
1459
1637
  /**
1638
+ * @public
1460
1639
  * <p>The marker for the next set of results. This marker was received from a previous
1461
1640
  * call.</p>
1462
1641
  */
@@ -1467,28 +1646,34 @@ export interface DescribeCommentsResponse {
1467
1646
  */
1468
1647
  export interface DescribeDocumentVersionsRequest {
1469
1648
  /**
1649
+ * @public
1470
1650
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1471
1651
  */
1472
1652
  AuthenticationToken?: string;
1473
1653
  /**
1654
+ * @public
1474
1655
  * <p>The ID of the document.</p>
1475
1656
  */
1476
1657
  DocumentId: string | undefined;
1477
1658
  /**
1659
+ * @public
1478
1660
  * <p>The marker for the next set of results. (You received this marker from a previous
1479
1661
  * call.)</p>
1480
1662
  */
1481
1663
  Marker?: string;
1482
1664
  /**
1665
+ * @public
1483
1666
  * <p>The maximum number of versions to return with this call.</p>
1484
1667
  */
1485
1668
  Limit?: number;
1486
1669
  /**
1670
+ * @public
1487
1671
  * <p>A comma-separated list of values. Specify "INITIALIZED" to include incomplete
1488
1672
  * versions.</p>
1489
1673
  */
1490
1674
  Include?: string;
1491
1675
  /**
1676
+ * @public
1492
1677
  * <p>Specify "SOURCE" to include initialized versions and a URL for the source
1493
1678
  * document.</p>
1494
1679
  */
@@ -1537,54 +1722,67 @@ export type DocumentThumbnailType = (typeof DocumentThumbnailType)[keyof typeof
1537
1722
  */
1538
1723
  export interface DocumentVersionMetadata {
1539
1724
  /**
1725
+ * @public
1540
1726
  * <p>The ID of the version.</p>
1541
1727
  */
1542
1728
  Id?: string;
1543
1729
  /**
1730
+ * @public
1544
1731
  * <p>The name of the version.</p>
1545
1732
  */
1546
1733
  Name?: string;
1547
1734
  /**
1735
+ * @public
1548
1736
  * <p>The content type of the document.</p>
1549
1737
  */
1550
1738
  ContentType?: string;
1551
1739
  /**
1740
+ * @public
1552
1741
  * <p>The size of the document, in bytes.</p>
1553
1742
  */
1554
1743
  Size?: number;
1555
1744
  /**
1745
+ * @public
1556
1746
  * <p>The signature of the document.</p>
1557
1747
  */
1558
1748
  Signature?: string;
1559
1749
  /**
1750
+ * @public
1560
1751
  * <p>The status of the document.</p>
1561
1752
  */
1562
1753
  Status?: DocumentStatusType | string;
1563
1754
  /**
1755
+ * @public
1564
1756
  * <p>The timestamp when the document was first uploaded.</p>
1565
1757
  */
1566
1758
  CreatedTimestamp?: Date;
1567
1759
  /**
1760
+ * @public
1568
1761
  * <p>The timestamp when the document was last uploaded.</p>
1569
1762
  */
1570
1763
  ModifiedTimestamp?: Date;
1571
1764
  /**
1765
+ * @public
1572
1766
  * <p>The timestamp when the content of the document was originally created.</p>
1573
1767
  */
1574
1768
  ContentCreatedTimestamp?: Date;
1575
1769
  /**
1770
+ * @public
1576
1771
  * <p>The timestamp when the content of the document was modified.</p>
1577
1772
  */
1578
1773
  ContentModifiedTimestamp?: Date;
1579
1774
  /**
1775
+ * @public
1580
1776
  * <p>The ID of the creator.</p>
1581
1777
  */
1582
1778
  CreatorId?: string;
1583
1779
  /**
1780
+ * @public
1584
1781
  * <p>The thumbnail of the document.</p>
1585
1782
  */
1586
1783
  Thumbnail?: Record<string, string>;
1587
1784
  /**
1785
+ * @public
1588
1786
  * <p>The source of the document.</p>
1589
1787
  */
1590
1788
  Source?: Record<string, string>;
@@ -1594,10 +1792,12 @@ export interface DocumentVersionMetadata {
1594
1792
  */
1595
1793
  export interface DescribeDocumentVersionsResponse {
1596
1794
  /**
1795
+ * @public
1597
1796
  * <p>The document versions.</p>
1598
1797
  */
1599
1798
  DocumentVersions?: DocumentVersionMetadata[];
1600
1799
  /**
1800
+ * @public
1601
1801
  * <p>The marker to use when requesting the next set of results. If there are no
1602
1802
  * additional results, the string is empty.</p>
1603
1803
  */
@@ -1658,35 +1858,43 @@ export type FolderContentType = (typeof FolderContentType)[keyof typeof FolderCo
1658
1858
  */
1659
1859
  export interface DescribeFolderContentsRequest {
1660
1860
  /**
1861
+ * @public
1661
1862
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1662
1863
  */
1663
1864
  AuthenticationToken?: string;
1664
1865
  /**
1866
+ * @public
1665
1867
  * <p>The ID of the folder.</p>
1666
1868
  */
1667
1869
  FolderId: string | undefined;
1668
1870
  /**
1871
+ * @public
1669
1872
  * <p>The sorting criteria.</p>
1670
1873
  */
1671
1874
  Sort?: ResourceSortType | string;
1672
1875
  /**
1876
+ * @public
1673
1877
  * <p>The order for the contents of the folder.</p>
1674
1878
  */
1675
1879
  Order?: OrderType | string;
1676
1880
  /**
1881
+ * @public
1677
1882
  * <p>The maximum number of items to return with this call.</p>
1678
1883
  */
1679
1884
  Limit?: number;
1680
1885
  /**
1886
+ * @public
1681
1887
  * <p>The marker for the next set of results. This marker was received from a previous
1682
1888
  * call.</p>
1683
1889
  */
1684
1890
  Marker?: string;
1685
1891
  /**
1892
+ * @public
1686
1893
  * <p>The type of items.</p>
1687
1894
  */
1688
1895
  Type?: FolderContentType | string;
1689
1896
  /**
1897
+ * @public
1690
1898
  * <p>The contents to include. Specify "INITIALIZED" to include initialized
1691
1899
  * documents.</p>
1692
1900
  */
@@ -1698,34 +1906,42 @@ export interface DescribeFolderContentsRequest {
1698
1906
  */
1699
1907
  export interface DocumentMetadata {
1700
1908
  /**
1909
+ * @public
1701
1910
  * <p>The ID of the document.</p>
1702
1911
  */
1703
1912
  Id?: string;
1704
1913
  /**
1914
+ * @public
1705
1915
  * <p>The ID of the creator.</p>
1706
1916
  */
1707
1917
  CreatorId?: string;
1708
1918
  /**
1919
+ * @public
1709
1920
  * <p>The ID of the parent folder.</p>
1710
1921
  */
1711
1922
  ParentFolderId?: string;
1712
1923
  /**
1924
+ * @public
1713
1925
  * <p>The time when the document was created.</p>
1714
1926
  */
1715
1927
  CreatedTimestamp?: Date;
1716
1928
  /**
1929
+ * @public
1717
1930
  * <p>The time when the document was updated.</p>
1718
1931
  */
1719
1932
  ModifiedTimestamp?: Date;
1720
1933
  /**
1934
+ * @public
1721
1935
  * <p>The latest version of the document.</p>
1722
1936
  */
1723
1937
  LatestVersionMetadata?: DocumentVersionMetadata;
1724
1938
  /**
1939
+ * @public
1725
1940
  * <p>The resource state.</p>
1726
1941
  */
1727
1942
  ResourceState?: ResourceStateType | string;
1728
1943
  /**
1944
+ * @public
1729
1945
  * <p>List of labels on the document.</p>
1730
1946
  */
1731
1947
  Labels?: string[];
@@ -1735,14 +1951,17 @@ export interface DocumentMetadata {
1735
1951
  */
1736
1952
  export interface DescribeFolderContentsResponse {
1737
1953
  /**
1954
+ * @public
1738
1955
  * <p>The subfolders in the specified folder.</p>
1739
1956
  */
1740
1957
  Folders?: FolderMetadata[];
1741
1958
  /**
1959
+ * @public
1742
1960
  * <p>The documents in the specified folder.</p>
1743
1961
  */
1744
1962
  Documents?: DocumentMetadata[];
1745
1963
  /**
1964
+ * @public
1746
1965
  * <p>The marker to use when requesting the next set of results. If there are no
1747
1966
  * additional results, the string is empty.</p>
1748
1967
  */
@@ -1753,23 +1972,28 @@ export interface DescribeFolderContentsResponse {
1753
1972
  */
1754
1973
  export interface DescribeGroupsRequest {
1755
1974
  /**
1975
+ * @public
1756
1976
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1757
1977
  */
1758
1978
  AuthenticationToken?: string;
1759
1979
  /**
1980
+ * @public
1760
1981
  * <p>A query to describe groups by group name.</p>
1761
1982
  */
1762
1983
  SearchQuery: string | undefined;
1763
1984
  /**
1985
+ * @public
1764
1986
  * <p>The ID of the organization.</p>
1765
1987
  */
1766
1988
  OrganizationId?: string;
1767
1989
  /**
1990
+ * @public
1768
1991
  * <p>The marker for the next set of results. (You received this marker from a previous
1769
1992
  * call.)</p>
1770
1993
  */
1771
1994
  Marker?: string;
1772
1995
  /**
1996
+ * @public
1773
1997
  * <p>The maximum number of items to return with this call.</p>
1774
1998
  */
1775
1999
  Limit?: number;
@@ -1779,10 +2003,12 @@ export interface DescribeGroupsRequest {
1779
2003
  */
1780
2004
  export interface DescribeGroupsResponse {
1781
2005
  /**
2006
+ * @public
1782
2007
  * <p>The list of groups.</p>
1783
2008
  */
1784
2009
  Groups?: GroupMetadata[];
1785
2010
  /**
2011
+ * @public
1786
2012
  * <p>The marker to use when requesting the next set of results. If there are no additional
1787
2013
  * results, the string is empty.</p>
1788
2014
  */
@@ -1793,15 +2019,18 @@ export interface DescribeGroupsResponse {
1793
2019
  */
1794
2020
  export interface DescribeNotificationSubscriptionsRequest {
1795
2021
  /**
2022
+ * @public
1796
2023
  * <p>The ID of the organization.</p>
1797
2024
  */
1798
2025
  OrganizationId: string | undefined;
1799
2026
  /**
2027
+ * @public
1800
2028
  * <p>The marker for the next set of results. (You received this marker from a previous
1801
2029
  * call.)</p>
1802
2030
  */
1803
2031
  Marker?: string;
1804
2032
  /**
2033
+ * @public
1805
2034
  * <p>The maximum number of items to return with this call.</p>
1806
2035
  */
1807
2036
  Limit?: number;
@@ -1811,10 +2040,12 @@ export interface DescribeNotificationSubscriptionsRequest {
1811
2040
  */
1812
2041
  export interface DescribeNotificationSubscriptionsResponse {
1813
2042
  /**
2043
+ * @public
1814
2044
  * <p>The subscriptions.</p>
1815
2045
  */
1816
2046
  Subscriptions?: Subscription[];
1817
2047
  /**
2048
+ * @public
1818
2049
  * <p>The marker to use when requesting the next set of results. If there are no
1819
2050
  * additional results, the string is empty.</p>
1820
2051
  */
@@ -1825,22 +2056,27 @@ export interface DescribeNotificationSubscriptionsResponse {
1825
2056
  */
1826
2057
  export interface DescribeResourcePermissionsRequest {
1827
2058
  /**
2059
+ * @public
1828
2060
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1829
2061
  */
1830
2062
  AuthenticationToken?: string;
1831
2063
  /**
2064
+ * @public
1832
2065
  * <p>The ID of the resource.</p>
1833
2066
  */
1834
2067
  ResourceId: string | undefined;
1835
2068
  /**
2069
+ * @public
1836
2070
  * <p>The ID of the principal to filter permissions by.</p>
1837
2071
  */
1838
2072
  PrincipalId?: string;
1839
2073
  /**
2074
+ * @public
1840
2075
  * <p>The maximum number of items to return with this call.</p>
1841
2076
  */
1842
2077
  Limit?: number;
1843
2078
  /**
2079
+ * @public
1844
2080
  * <p>The marker for the next set of results. (You received this marker from a previous
1845
2081
  * call)</p>
1846
2082
  */
@@ -1864,10 +2100,12 @@ export type RolePermissionType = (typeof RolePermissionType)[keyof typeof RolePe
1864
2100
  */
1865
2101
  export interface PermissionInfo {
1866
2102
  /**
2103
+ * @public
1867
2104
  * <p>The role of the user.</p>
1868
2105
  */
1869
2106
  Role?: RoleType | string;
1870
2107
  /**
2108
+ * @public
1871
2109
  * <p>The type of permissions.</p>
1872
2110
  */
1873
2111
  Type?: RolePermissionType | string;
@@ -1878,14 +2116,17 @@ export interface PermissionInfo {
1878
2116
  */
1879
2117
  export interface Principal {
1880
2118
  /**
2119
+ * @public
1881
2120
  * <p>The ID of the resource.</p>
1882
2121
  */
1883
2122
  Id?: string;
1884
2123
  /**
2124
+ * @public
1885
2125
  * <p>The type of resource.</p>
1886
2126
  */
1887
2127
  Type?: PrincipalType | string;
1888
2128
  /**
2129
+ * @public
1889
2130
  * <p>The permission information for the resource.</p>
1890
2131
  */
1891
2132
  Roles?: PermissionInfo[];
@@ -1895,10 +2136,12 @@ export interface Principal {
1895
2136
  */
1896
2137
  export interface DescribeResourcePermissionsResponse {
1897
2138
  /**
2139
+ * @public
1898
2140
  * <p>The principals.</p>
1899
2141
  */
1900
2142
  Principals?: Principal[];
1901
2143
  /**
2144
+ * @public
1902
2145
  * <p>The marker to use when requesting the next set of results. If there are no
1903
2146
  * additional results, the string is empty.</p>
1904
2147
  */
@@ -1909,14 +2152,17 @@ export interface DescribeResourcePermissionsResponse {
1909
2152
  */
1910
2153
  export interface DescribeRootFoldersRequest {
1911
2154
  /**
2155
+ * @public
1912
2156
  * <p>Amazon WorkDocs authentication token.</p>
1913
2157
  */
1914
2158
  AuthenticationToken: string | undefined;
1915
2159
  /**
2160
+ * @public
1916
2161
  * <p>The maximum number of items to return.</p>
1917
2162
  */
1918
2163
  Limit?: number;
1919
2164
  /**
2165
+ * @public
1920
2166
  * <p>The marker for the next set of results. (You received this marker from a previous
1921
2167
  * call.)</p>
1922
2168
  */
@@ -1927,10 +2173,12 @@ export interface DescribeRootFoldersRequest {
1927
2173
  */
1928
2174
  export interface DescribeRootFoldersResponse {
1929
2175
  /**
2176
+ * @public
1930
2177
  * <p>The user's special folders.</p>
1931
2178
  */
1932
2179
  Folders?: FolderMetadata[];
1933
2180
  /**
2181
+ * @public
1934
2182
  * <p>The marker for the next set of results.</p>
1935
2183
  */
1936
2184
  Marker?: string;
@@ -1967,18 +2215,22 @@ export type UserSortType = (typeof UserSortType)[keyof typeof UserSortType];
1967
2215
  */
1968
2216
  export interface DescribeUsersRequest {
1969
2217
  /**
2218
+ * @public
1970
2219
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
1971
2220
  */
1972
2221
  AuthenticationToken?: string;
1973
2222
  /**
2223
+ * @public
1974
2224
  * <p>The ID of the organization.</p>
1975
2225
  */
1976
2226
  OrganizationId?: string;
1977
2227
  /**
2228
+ * @public
1978
2229
  * <p>The IDs of the users.</p>
1979
2230
  */
1980
2231
  UserIds?: string;
1981
2232
  /**
2233
+ * @public
1982
2234
  * <p>A query to filter users by user name. Remember the following about the <code>Userids</code> and <code>Query</code> parameters:</p>
1983
2235
  * <ul>
1984
2236
  * <li>
@@ -2000,27 +2252,33 @@ export interface DescribeUsersRequest {
2000
2252
  */
2001
2253
  Query?: string;
2002
2254
  /**
2255
+ * @public
2003
2256
  * <p>The state of the users. Specify "ALL" to include inactive users.</p>
2004
2257
  */
2005
2258
  Include?: UserFilterType | string;
2006
2259
  /**
2260
+ * @public
2007
2261
  * <p>The order for the results.</p>
2008
2262
  */
2009
2263
  Order?: OrderType | string;
2010
2264
  /**
2265
+ * @public
2011
2266
  * <p>The sorting criteria.</p>
2012
2267
  */
2013
2268
  Sort?: UserSortType | string;
2014
2269
  /**
2270
+ * @public
2015
2271
  * <p>The marker for the next set of results. (You received this marker from a previous
2016
2272
  * call.)</p>
2017
2273
  */
2018
2274
  Marker?: string;
2019
2275
  /**
2276
+ * @public
2020
2277
  * <p>The maximum number of items to return.</p>
2021
2278
  */
2022
2279
  Limit?: number;
2023
2280
  /**
2281
+ * @public
2024
2282
  * <p>A comma-separated list of values. Specify "STORAGE_METADATA" to include the user
2025
2283
  * storage quota and utilization information.</p>
2026
2284
  */
@@ -2031,16 +2289,19 @@ export interface DescribeUsersRequest {
2031
2289
  */
2032
2290
  export interface DescribeUsersResponse {
2033
2291
  /**
2292
+ * @public
2034
2293
  * <p>The users.</p>
2035
2294
  */
2036
2295
  Users?: User[];
2037
2296
  /**
2297
+ * @public
2038
2298
  * @deprecated
2039
2299
  *
2040
2300
  * <p>The total number of users included in the results.</p>
2041
2301
  */
2042
2302
  TotalNumberOfUsers?: number;
2043
2303
  /**
2304
+ * @public
2044
2305
  * <p>The marker to use when requesting the next set of results. If there are no
2045
2306
  * additional results, the string is empty.</p>
2046
2307
  */
@@ -2064,6 +2325,7 @@ export declare class RequestedEntityTooLargeException extends __BaseException {
2064
2325
  */
2065
2326
  export interface GetCurrentUserRequest {
2066
2327
  /**
2328
+ * @public
2067
2329
  * <p>Amazon WorkDocs authentication token.</p>
2068
2330
  */
2069
2331
  AuthenticationToken: string | undefined;
@@ -2073,6 +2335,7 @@ export interface GetCurrentUserRequest {
2073
2335
  */
2074
2336
  export interface GetCurrentUserResponse {
2075
2337
  /**
2338
+ * @public
2076
2339
  * <p>Metadata of the user.</p>
2077
2340
  */
2078
2341
  User?: User;
@@ -2082,14 +2345,17 @@ export interface GetCurrentUserResponse {
2082
2345
  */
2083
2346
  export interface GetDocumentRequest {
2084
2347
  /**
2348
+ * @public
2085
2349
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2086
2350
  */
2087
2351
  AuthenticationToken?: string;
2088
2352
  /**
2353
+ * @public
2089
2354
  * <p>The ID of the document.</p>
2090
2355
  */
2091
2356
  DocumentId: string | undefined;
2092
2357
  /**
2358
+ * @public
2093
2359
  * <p>Set this to <code>TRUE</code> to include custom metadata in the response.</p>
2094
2360
  */
2095
2361
  IncludeCustomMetadata?: boolean;
@@ -2099,10 +2365,12 @@ export interface GetDocumentRequest {
2099
2365
  */
2100
2366
  export interface GetDocumentResponse {
2101
2367
  /**
2368
+ * @public
2102
2369
  * <p>The metadata details of the document.</p>
2103
2370
  */
2104
2371
  Metadata?: DocumentMetadata;
2105
2372
  /**
2373
+ * @public
2106
2374
  * <p>The custom metadata on the document.</p>
2107
2375
  */
2108
2376
  CustomMetadata?: Record<string, string>;
@@ -2112,23 +2380,28 @@ export interface GetDocumentResponse {
2112
2380
  */
2113
2381
  export interface GetDocumentPathRequest {
2114
2382
  /**
2383
+ * @public
2115
2384
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2116
2385
  */
2117
2386
  AuthenticationToken?: string;
2118
2387
  /**
2388
+ * @public
2119
2389
  * <p>The ID of the document.</p>
2120
2390
  */
2121
2391
  DocumentId: string | undefined;
2122
2392
  /**
2393
+ * @public
2123
2394
  * <p>The maximum number of levels in the hierarchy to return.</p>
2124
2395
  */
2125
2396
  Limit?: number;
2126
2397
  /**
2398
+ * @public
2127
2399
  * <p>A comma-separated list of values. Specify <code>NAME</code> to include the names of
2128
2400
  * the parent folders.</p>
2129
2401
  */
2130
2402
  Fields?: string;
2131
2403
  /**
2404
+ * @public
2132
2405
  * <p>This value is not supported.</p>
2133
2406
  */
2134
2407
  Marker?: string;
@@ -2139,10 +2412,12 @@ export interface GetDocumentPathRequest {
2139
2412
  */
2140
2413
  export interface ResourcePathComponent {
2141
2414
  /**
2415
+ * @public
2142
2416
  * <p>The ID of the resource path.</p>
2143
2417
  */
2144
2418
  Id?: string;
2145
2419
  /**
2420
+ * @public
2146
2421
  * <p>The name of the resource path.</p>
2147
2422
  */
2148
2423
  Name?: string;
@@ -2153,6 +2428,7 @@ export interface ResourcePathComponent {
2153
2428
  */
2154
2429
  export interface ResourcePath {
2155
2430
  /**
2431
+ * @public
2156
2432
  * <p>The components of the resource path.</p>
2157
2433
  */
2158
2434
  Components?: ResourcePathComponent[];
@@ -2162,6 +2438,7 @@ export interface ResourcePath {
2162
2438
  */
2163
2439
  export interface GetDocumentPathResponse {
2164
2440
  /**
2441
+ * @public
2165
2442
  * <p>The path information.</p>
2166
2443
  */
2167
2444
  Path?: ResourcePath;
@@ -2171,23 +2448,28 @@ export interface GetDocumentPathResponse {
2171
2448
  */
2172
2449
  export interface GetDocumentVersionRequest {
2173
2450
  /**
2451
+ * @public
2174
2452
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2175
2453
  */
2176
2454
  AuthenticationToken?: string;
2177
2455
  /**
2456
+ * @public
2178
2457
  * <p>The ID of the document.</p>
2179
2458
  */
2180
2459
  DocumentId: string | undefined;
2181
2460
  /**
2461
+ * @public
2182
2462
  * <p>The version ID of the document.</p>
2183
2463
  */
2184
2464
  VersionId: string | undefined;
2185
2465
  /**
2466
+ * @public
2186
2467
  * <p>A comma-separated list of values. Specify "SOURCE" to include a URL for the source
2187
2468
  * document.</p>
2188
2469
  */
2189
2470
  Fields?: string;
2190
2471
  /**
2472
+ * @public
2191
2473
  * <p>Set this to TRUE to include custom metadata in the response.</p>
2192
2474
  */
2193
2475
  IncludeCustomMetadata?: boolean;
@@ -2197,10 +2479,12 @@ export interface GetDocumentVersionRequest {
2197
2479
  */
2198
2480
  export interface GetDocumentVersionResponse {
2199
2481
  /**
2482
+ * @public
2200
2483
  * <p>The version metadata.</p>
2201
2484
  */
2202
2485
  Metadata?: DocumentVersionMetadata;
2203
2486
  /**
2487
+ * @public
2204
2488
  * <p>The custom metadata on the document version.</p>
2205
2489
  */
2206
2490
  CustomMetadata?: Record<string, string>;
@@ -2210,14 +2494,17 @@ export interface GetDocumentVersionResponse {
2210
2494
  */
2211
2495
  export interface GetFolderRequest {
2212
2496
  /**
2497
+ * @public
2213
2498
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2214
2499
  */
2215
2500
  AuthenticationToken?: string;
2216
2501
  /**
2502
+ * @public
2217
2503
  * <p>The ID of the folder.</p>
2218
2504
  */
2219
2505
  FolderId: string | undefined;
2220
2506
  /**
2507
+ * @public
2221
2508
  * <p>Set to TRUE to include custom metadata in the response.</p>
2222
2509
  */
2223
2510
  IncludeCustomMetadata?: boolean;
@@ -2227,10 +2514,12 @@ export interface GetFolderRequest {
2227
2514
  */
2228
2515
  export interface GetFolderResponse {
2229
2516
  /**
2517
+ * @public
2230
2518
  * <p>The metadata of the folder.</p>
2231
2519
  */
2232
2520
  Metadata?: FolderMetadata;
2233
2521
  /**
2522
+ * @public
2234
2523
  * <p>The custom metadata on the folder.</p>
2235
2524
  */
2236
2525
  CustomMetadata?: Record<string, string>;
@@ -2240,23 +2529,28 @@ export interface GetFolderResponse {
2240
2529
  */
2241
2530
  export interface GetFolderPathRequest {
2242
2531
  /**
2532
+ * @public
2243
2533
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2244
2534
  */
2245
2535
  AuthenticationToken?: string;
2246
2536
  /**
2537
+ * @public
2247
2538
  * <p>The ID of the folder.</p>
2248
2539
  */
2249
2540
  FolderId: string | undefined;
2250
2541
  /**
2542
+ * @public
2251
2543
  * <p>The maximum number of levels in the hierarchy to return.</p>
2252
2544
  */
2253
2545
  Limit?: number;
2254
2546
  /**
2547
+ * @public
2255
2548
  * <p>A comma-separated list of values. Specify "NAME" to include the names of the parent
2256
2549
  * folders.</p>
2257
2550
  */
2258
2551
  Fields?: string;
2259
2552
  /**
2553
+ * @public
2260
2554
  * <p>This value is not supported.</p>
2261
2555
  */
2262
2556
  Marker?: string;
@@ -2266,6 +2560,7 @@ export interface GetFolderPathRequest {
2266
2560
  */
2267
2561
  export interface GetFolderPathResponse {
2268
2562
  /**
2563
+ * @public
2269
2564
  * <p>The path information.</p>
2270
2565
  */
2271
2566
  Path?: ResourcePath;
@@ -2286,23 +2581,28 @@ export type ResourceCollectionType = (typeof ResourceCollectionType)[keyof typeo
2286
2581
  */
2287
2582
  export interface GetResourcesRequest {
2288
2583
  /**
2584
+ * @public
2289
2585
  * <p>The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2290
2586
  */
2291
2587
  AuthenticationToken?: string;
2292
2588
  /**
2589
+ * @public
2293
2590
  * <p>The user ID for the resource collection. This is a required field for accessing the
2294
2591
  * API operation using IAM credentials.</p>
2295
2592
  */
2296
2593
  UserId?: string;
2297
2594
  /**
2595
+ * @public
2298
2596
  * <p>The collection type.</p>
2299
2597
  */
2300
2598
  CollectionType?: ResourceCollectionType | string;
2301
2599
  /**
2600
+ * @public
2302
2601
  * <p>The maximum number of resources to return.</p>
2303
2602
  */
2304
2603
  Limit?: number;
2305
2604
  /**
2605
+ * @public
2306
2606
  * <p>The marker for the next set of results. This marker was received from a previous call.</p>
2307
2607
  */
2308
2608
  Marker?: string;
@@ -2312,14 +2612,17 @@ export interface GetResourcesRequest {
2312
2612
  */
2313
2613
  export interface GetResourcesResponse {
2314
2614
  /**
2615
+ * @public
2315
2616
  * <p>The folders in the specified folder.</p>
2316
2617
  */
2317
2618
  Folders?: FolderMetadata[];
2318
2619
  /**
2620
+ * @public
2319
2621
  * <p>The documents in the specified collection.</p>
2320
2622
  */
2321
2623
  Documents?: DocumentMetadata[];
2322
2624
  /**
2625
+ * @public
2323
2626
  * <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
2324
2627
  */
2325
2628
  Marker?: string;
@@ -2343,34 +2646,42 @@ export declare class DraftUploadOutOfSyncException extends __BaseException {
2343
2646
  */
2344
2647
  export interface InitiateDocumentVersionUploadRequest {
2345
2648
  /**
2649
+ * @public
2346
2650
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2347
2651
  */
2348
2652
  AuthenticationToken?: string;
2349
2653
  /**
2654
+ * @public
2350
2655
  * <p>The ID of the document.</p>
2351
2656
  */
2352
2657
  Id?: string;
2353
2658
  /**
2659
+ * @public
2354
2660
  * <p>The name of the document.</p>
2355
2661
  */
2356
2662
  Name?: string;
2357
2663
  /**
2664
+ * @public
2358
2665
  * <p>The timestamp when the content of the document was originally created.</p>
2359
2666
  */
2360
2667
  ContentCreatedTimestamp?: Date;
2361
2668
  /**
2669
+ * @public
2362
2670
  * <p>The timestamp when the content of the document was modified.</p>
2363
2671
  */
2364
2672
  ContentModifiedTimestamp?: Date;
2365
2673
  /**
2674
+ * @public
2366
2675
  * <p>The content type of the document.</p>
2367
2676
  */
2368
2677
  ContentType?: string;
2369
2678
  /**
2679
+ * @public
2370
2680
  * <p>The size of the document, in bytes.</p>
2371
2681
  */
2372
2682
  DocumentSizeInBytes?: number;
2373
2683
  /**
2684
+ * @public
2374
2685
  * <p>The ID of the parent folder.</p>
2375
2686
  */
2376
2687
  ParentFolderId?: string;
@@ -2381,10 +2692,12 @@ export interface InitiateDocumentVersionUploadRequest {
2381
2692
  */
2382
2693
  export interface UploadMetadata {
2383
2694
  /**
2695
+ * @public
2384
2696
  * <p>The URL of the upload.</p>
2385
2697
  */
2386
2698
  UploadUrl?: string;
2387
2699
  /**
2700
+ * @public
2388
2701
  * <p>The signed headers.</p>
2389
2702
  */
2390
2703
  SignedHeaders?: Record<string, string>;
@@ -2394,10 +2707,12 @@ export interface UploadMetadata {
2394
2707
  */
2395
2708
  export interface InitiateDocumentVersionUploadResponse {
2396
2709
  /**
2710
+ * @public
2397
2711
  * <p>The document metadata.</p>
2398
2712
  */
2399
2713
  Metadata?: DocumentMetadata;
2400
2714
  /**
2715
+ * @public
2401
2716
  * <p>The upload metadata.</p>
2402
2717
  */
2403
2718
  UploadMetadata?: UploadMetadata;
@@ -2446,10 +2761,12 @@ export declare class StorageLimitWillExceedException extends __BaseException {
2446
2761
  */
2447
2762
  export interface RemoveAllResourcePermissionsRequest {
2448
2763
  /**
2764
+ * @public
2449
2765
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2450
2766
  */
2451
2767
  AuthenticationToken?: string;
2452
2768
  /**
2769
+ * @public
2453
2770
  * <p>The ID of the resource.</p>
2454
2771
  */
2455
2772
  ResourceId: string | undefined;
@@ -2459,18 +2776,22 @@ export interface RemoveAllResourcePermissionsRequest {
2459
2776
  */
2460
2777
  export interface RemoveResourcePermissionRequest {
2461
2778
  /**
2779
+ * @public
2462
2780
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2463
2781
  */
2464
2782
  AuthenticationToken?: string;
2465
2783
  /**
2784
+ * @public
2466
2785
  * <p>The ID of the resource.</p>
2467
2786
  */
2468
2787
  ResourceId: string | undefined;
2469
2788
  /**
2789
+ * @public
2470
2790
  * <p>The principal ID of the resource.</p>
2471
2791
  */
2472
2792
  PrincipalId: string | undefined;
2473
2793
  /**
2794
+ * @public
2474
2795
  * <p>The principal type of the resource.</p>
2475
2796
  */
2476
2797
  PrincipalType?: PrincipalType | string;
@@ -2480,10 +2801,12 @@ export interface RemoveResourcePermissionRequest {
2480
2801
  */
2481
2802
  export interface RestoreDocumentVersionsRequest {
2482
2803
  /**
2804
+ * @public
2483
2805
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2484
2806
  */
2485
2807
  AuthenticationToken?: string;
2486
2808
  /**
2809
+ * @public
2487
2810
  * <p>The ID of the document.</p>
2488
2811
  */
2489
2812
  DocumentId: string | undefined;
@@ -2513,10 +2836,12 @@ export type ContentCategoryType = (typeof ContentCategoryType)[keyof typeof Cont
2513
2836
  */
2514
2837
  export interface DateRangeType {
2515
2838
  /**
2839
+ * @public
2516
2840
  * <p>Timestamp range start value (in epochs)</p>
2517
2841
  */
2518
2842
  StartValue?: Date;
2519
2843
  /**
2844
+ * @public
2520
2845
  * <p>Timestamp range end value (in epochs).</p>
2521
2846
  */
2522
2847
  EndValue?: Date;
@@ -2541,10 +2866,12 @@ export type PrincipalRoleType = (typeof PrincipalRoleType)[keyof typeof Principa
2541
2866
  */
2542
2867
  export interface SearchPrincipalType {
2543
2868
  /**
2869
+ * @public
2544
2870
  * <p>UserIds or GroupIds.</p>
2545
2871
  */
2546
2872
  Id: string | undefined;
2547
2873
  /**
2874
+ * @public
2548
2875
  * <p>The Role of a User or Group.</p>
2549
2876
  */
2550
2877
  Roles?: (PrincipalRoleType | string)[];
@@ -2581,10 +2908,12 @@ export type SearchCollectionType = (typeof SearchCollectionType)[keyof typeof Se
2581
2908
  */
2582
2909
  export interface LongRangeType {
2583
2910
  /**
2911
+ * @public
2584
2912
  * <p>The size start range (in bytes).</p>
2585
2913
  */
2586
2914
  StartValue?: number;
2587
2915
  /**
2916
+ * @public
2588
2917
  * <p>The size end range (in bytes).</p>
2589
2918
  */
2590
2919
  EndValue?: number;
@@ -2636,42 +2965,52 @@ export type LanguageCodeType = (typeof LanguageCodeType)[keyof typeof LanguageCo
2636
2965
  */
2637
2966
  export interface Filters {
2638
2967
  /**
2968
+ * @public
2639
2969
  * <p>Filters by the locale of the content or comment.</p>
2640
2970
  */
2641
2971
  TextLocales?: (LanguageCodeType | string)[];
2642
2972
  /**
2973
+ * @public
2643
2974
  * <p>Filters by content category.</p>
2644
2975
  */
2645
2976
  ContentCategories?: (ContentCategoryType | string)[];
2646
2977
  /**
2978
+ * @public
2647
2979
  * <p>Filters based on entity type.</p>
2648
2980
  */
2649
2981
  ResourceTypes?: (SearchResourceType | string)[];
2650
2982
  /**
2983
+ * @public
2651
2984
  * <p>Filter by labels using exact match.</p>
2652
2985
  */
2653
2986
  Labels?: string[];
2654
2987
  /**
2988
+ * @public
2655
2989
  * <p>Filter based on UserIds or GroupIds.</p>
2656
2990
  */
2657
2991
  Principals?: SearchPrincipalType[];
2658
2992
  /**
2993
+ * @public
2659
2994
  * <p>Filter based on resource’s path.</p>
2660
2995
  */
2661
2996
  AncestorIds?: string[];
2662
2997
  /**
2998
+ * @public
2663
2999
  * <p>Filter based on file groupings.</p>
2664
3000
  */
2665
3001
  SearchCollectionTypes?: (SearchCollectionType | string)[];
2666
3002
  /**
3003
+ * @public
2667
3004
  * <p>Filter based on size (in bytes).</p>
2668
3005
  */
2669
3006
  SizeRange?: LongRangeType;
2670
3007
  /**
3008
+ * @public
2671
3009
  * <p>Filter based on resource’s creation timestamp.</p>
2672
3010
  */
2673
3011
  CreatedRange?: DateRangeType;
2674
3012
  /**
3013
+ * @public
2675
3014
  * <p>Filter based on resource’s modified timestamp.</p>
2676
3015
  */
2677
3016
  ModifiedRange?: DateRangeType;
@@ -2709,10 +3048,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
2709
3048
  */
2710
3049
  export interface SearchSortResult {
2711
3050
  /**
3051
+ * @public
2712
3052
  * <p>Sort search results based on this field name.</p>
2713
3053
  */
2714
3054
  Field?: OrderByFieldType | string;
2715
3055
  /**
3056
+ * @public
2716
3057
  * <p>Sort direction.</p>
2717
3058
  */
2718
3059
  Order?: SortOrder | string;
@@ -2734,39 +3075,48 @@ export type SearchQueryScopeType = (typeof SearchQueryScopeType)[keyof typeof Se
2734
3075
  */
2735
3076
  export interface SearchResourcesRequest {
2736
3077
  /**
3078
+ * @public
2737
3079
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2738
3080
  */
2739
3081
  AuthenticationToken?: string;
2740
3082
  /**
3083
+ * @public
2741
3084
  * <p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>
2742
3085
  */
2743
3086
  QueryText?: string;
2744
3087
  /**
3088
+ * @public
2745
3089
  * <p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>
2746
3090
  */
2747
3091
  QueryScopes?: (SearchQueryScopeType | string)[];
2748
3092
  /**
3093
+ * @public
2749
3094
  * <p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>
2750
3095
  */
2751
3096
  OrganizationId?: string;
2752
3097
  /**
3098
+ * @public
2753
3099
  * <p>A list of attributes to include in the response. Used to request fields that are not normally
2754
3100
  * returned in a standard response.</p>
2755
3101
  */
2756
3102
  AdditionalResponseFields?: (AdditionalResponseFieldType | string)[];
2757
3103
  /**
3104
+ * @public
2758
3105
  * <p>Filters results based on entity metadata.</p>
2759
3106
  */
2760
3107
  Filters?: Filters;
2761
3108
  /**
3109
+ * @public
2762
3110
  * <p>Order by results in one or more categories.</p>
2763
3111
  */
2764
3112
  OrderBy?: SearchSortResult[];
2765
3113
  /**
3114
+ * @public
2766
3115
  * <p>Max results count per page.</p>
2767
3116
  */
2768
3117
  Limit?: number;
2769
3118
  /**
3119
+ * @public
2770
3120
  * <p>The marker for the next set of results.</p>
2771
3121
  */
2772
3122
  Marker?: string;
@@ -2791,26 +3141,32 @@ export type ResponseItemType = (typeof ResponseItemType)[keyof typeof ResponseIt
2791
3141
  */
2792
3142
  export interface ResponseItem {
2793
3143
  /**
3144
+ * @public
2794
3145
  * <p>The type of item being returned.</p>
2795
3146
  */
2796
3147
  ResourceType?: ResponseItemType | string;
2797
3148
  /**
3149
+ * @public
2798
3150
  * <p>The webUrl of the item being returned.</p>
2799
3151
  */
2800
3152
  WebUrl?: string;
2801
3153
  /**
3154
+ * @public
2802
3155
  * <p>The document that matches the query.</p>
2803
3156
  */
2804
3157
  DocumentMetadata?: DocumentMetadata;
2805
3158
  /**
3159
+ * @public
2806
3160
  * <p>The folder that matches the query.</p>
2807
3161
  */
2808
3162
  FolderMetadata?: FolderMetadata;
2809
3163
  /**
3164
+ * @public
2810
3165
  * <p>The comment that matches the query.</p>
2811
3166
  */
2812
3167
  CommentMetadata?: CommentMetadata;
2813
3168
  /**
3169
+ * @public
2814
3170
  * <p>The document version that matches the metadata.</p>
2815
3171
  */
2816
3172
  DocumentVersionMetadata?: DocumentVersionMetadata;
@@ -2820,10 +3176,12 @@ export interface ResponseItem {
2820
3176
  */
2821
3177
  export interface SearchResourcesResponse {
2822
3178
  /**
3179
+ * @public
2823
3180
  * <p>List of Documents, Folders, Comments, and Document Versions matching the query.</p>
2824
3181
  */
2825
3182
  Items?: ResponseItem[];
2826
3183
  /**
3184
+ * @public
2827
3185
  * <p>The marker to use when requesting the next set of results. If there are no additional results, the string is empty.</p>
2828
3186
  */
2829
3187
  Marker?: string;
@@ -2833,22 +3191,27 @@ export interface SearchResourcesResponse {
2833
3191
  */
2834
3192
  export interface UpdateDocumentRequest {
2835
3193
  /**
3194
+ * @public
2836
3195
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2837
3196
  */
2838
3197
  AuthenticationToken?: string;
2839
3198
  /**
3199
+ * @public
2840
3200
  * <p>The ID of the document.</p>
2841
3201
  */
2842
3202
  DocumentId: string | undefined;
2843
3203
  /**
3204
+ * @public
2844
3205
  * <p>The name of the document.</p>
2845
3206
  */
2846
3207
  Name?: string;
2847
3208
  /**
3209
+ * @public
2848
3210
  * <p>The ID of the parent folder.</p>
2849
3211
  */
2850
3212
  ParentFolderId?: string;
2851
3213
  /**
3214
+ * @public
2852
3215
  * <p>The resource state of the document. Only ACTIVE and RECYCLED are
2853
3216
  * supported.</p>
2854
3217
  */
@@ -2870,18 +3233,22 @@ export type DocumentVersionStatus = (typeof DocumentVersionStatus)[keyof typeof
2870
3233
  */
2871
3234
  export interface UpdateDocumentVersionRequest {
2872
3235
  /**
3236
+ * @public
2873
3237
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2874
3238
  */
2875
3239
  AuthenticationToken?: string;
2876
3240
  /**
3241
+ * @public
2877
3242
  * <p>The ID of the document.</p>
2878
3243
  */
2879
3244
  DocumentId: string | undefined;
2880
3245
  /**
3246
+ * @public
2881
3247
  * <p>The version ID of the document.</p>
2882
3248
  */
2883
3249
  VersionId: string | undefined;
2884
3250
  /**
3251
+ * @public
2885
3252
  * <p>The status of the version.</p>
2886
3253
  */
2887
3254
  VersionStatus?: DocumentVersionStatus | string;
@@ -2891,22 +3258,27 @@ export interface UpdateDocumentVersionRequest {
2891
3258
  */
2892
3259
  export interface UpdateFolderRequest {
2893
3260
  /**
3261
+ * @public
2894
3262
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2895
3263
  */
2896
3264
  AuthenticationToken?: string;
2897
3265
  /**
3266
+ * @public
2898
3267
  * <p>The ID of the folder.</p>
2899
3268
  */
2900
3269
  FolderId: string | undefined;
2901
3270
  /**
3271
+ * @public
2902
3272
  * <p>The name of the folder.</p>
2903
3273
  */
2904
3274
  Name?: string;
2905
3275
  /**
3276
+ * @public
2906
3277
  * <p>The ID of the parent folder.</p>
2907
3278
  */
2908
3279
  ParentFolderId?: string;
2909
3280
  /**
3281
+ * @public
2910
3282
  * <p>The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from
2911
3283
  * the API.</p>
2912
3284
  */
@@ -2956,38 +3328,47 @@ export type BooleanEnumType = (typeof BooleanEnumType)[keyof typeof BooleanEnumT
2956
3328
  */
2957
3329
  export interface UpdateUserRequest {
2958
3330
  /**
3331
+ * @public
2959
3332
  * <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
2960
3333
  */
2961
3334
  AuthenticationToken?: string;
2962
3335
  /**
3336
+ * @public
2963
3337
  * <p>The ID of the user.</p>
2964
3338
  */
2965
3339
  UserId: string | undefined;
2966
3340
  /**
3341
+ * @public
2967
3342
  * <p>The given name of the user.</p>
2968
3343
  */
2969
3344
  GivenName?: string;
2970
3345
  /**
3346
+ * @public
2971
3347
  * <p>The surname of the user.</p>
2972
3348
  */
2973
3349
  Surname?: string;
2974
3350
  /**
3351
+ * @public
2975
3352
  * <p>The type of the user.</p>
2976
3353
  */
2977
3354
  Type?: UserType | string;
2978
3355
  /**
3356
+ * @public
2979
3357
  * <p>The amount of storage for the user.</p>
2980
3358
  */
2981
3359
  StorageRule?: StorageRuleType;
2982
3360
  /**
3361
+ * @public
2983
3362
  * <p>The time zone ID of the user.</p>
2984
3363
  */
2985
3364
  TimeZoneId?: string;
2986
3365
  /**
3366
+ * @public
2987
3367
  * <p>The locale of the user.</p>
2988
3368
  */
2989
3369
  Locale?: LocaleType | string;
2990
3370
  /**
3371
+ * @public
2991
3372
  * <p>Boolean value to determine whether the user is granted Power user privileges.</p>
2992
3373
  */
2993
3374
  GrantPoweruserPrivileges?: BooleanEnumType | string;
@@ -2997,6 +3378,7 @@ export interface UpdateUserRequest {
2997
3378
  */
2998
3379
  export interface UpdateUserResponse {
2999
3380
  /**
3381
+ * @public
3000
3382
  * <p>The user information.</p>
3001
3383
  */
3002
3384
  User?: User;