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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,10 +12,17 @@ module Aws::WorkDocs
12
12
  # data as a hash:
13
13
  #
14
14
  # {
15
+ # authentication_token: "AuthenticationHeaderType",
15
16
  # document_id: "ResourceIdType", # required
16
17
  # version_id: "DocumentVersionIdType", # required
17
18
  # }
18
19
  #
20
+ # @!attribute [rw] authentication_token
21
+ # Amazon WorkDocs authentication token. This field should not be set
22
+ # when using administrative API actions, as in accessing the API using
23
+ # AWS credentials.
24
+ # @return [String]
25
+ #
19
26
  # @!attribute [rw] document_id
20
27
  # The ID of the document.
21
28
  # @return [String]
@@ -27,6 +34,7 @@ module Aws::WorkDocs
27
34
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUploadRequest AWS API Documentation
28
35
  #
29
36
  class AbortDocumentVersionUploadRequest < Struct.new(
37
+ :authentication_token,
30
38
  :document_id,
31
39
  :version_id)
32
40
  include Aws::Structure
@@ -37,16 +45,24 @@ module Aws::WorkDocs
37
45
  #
38
46
  # {
39
47
  # user_id: "IdType", # required
48
+ # authentication_token: "AuthenticationHeaderType",
40
49
  # }
41
50
  #
42
51
  # @!attribute [rw] user_id
43
52
  # The ID of the user.
44
53
  # @return [String]
45
54
  #
55
+ # @!attribute [rw] authentication_token
56
+ # Amazon WorkDocs authentication token. This field should not be set
57
+ # when using administrative API actions, as in accessing the API using
58
+ # AWS credentials.
59
+ # @return [String]
60
+ #
46
61
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest AWS API Documentation
47
62
  #
48
63
  class ActivateUserRequest < Struct.new(
49
- :user_id)
64
+ :user_id,
65
+ :authentication_token)
50
66
  include Aws::Structure
51
67
  end
52
68
 
@@ -61,10 +77,64 @@ module Aws::WorkDocs
61
77
  include Aws::Structure
62
78
  end
63
79
 
80
+ # Describes the activity information.
81
+ #
82
+ # @!attribute [rw] type
83
+ # The activity type.
84
+ # @return [String]
85
+ #
86
+ # @!attribute [rw] time_stamp
87
+ # The timestamp when the action was performed.
88
+ # @return [Time]
89
+ #
90
+ # @!attribute [rw] organization_id
91
+ # The ID of the organization.
92
+ # @return [String]
93
+ #
94
+ # @!attribute [rw] initiator
95
+ # The user who performed the action.
96
+ # @return [Types::UserMetadata]
97
+ #
98
+ # @!attribute [rw] participants
99
+ # The list of users or groups impacted by this action. This is an
100
+ # optional field and is filled for the following sharing activities:
101
+ # DOCUMENT\_SHARED, DOCUMENT\_SHARED, DOCUMENT\_UNSHARED,
102
+ # FOLDER\_SHARED, FOLDER\_UNSHARED.
103
+ # @return [Types::Participants]
104
+ #
105
+ # @!attribute [rw] resource_metadata
106
+ # The metadata of the resource involved in the user action.
107
+ # @return [Types::ResourceMetadata]
108
+ #
109
+ # @!attribute [rw] original_parent
110
+ # The original parent of the resource. This is an optional field and
111
+ # is filled for move activities.
112
+ # @return [Types::ResourceMetadata]
113
+ #
114
+ # @!attribute [rw] comment_metadata
115
+ # Metadata of the commenting activity. This is an optional field and
116
+ # is filled for commenting activities.
117
+ # @return [Types::CommentMetadata]
118
+ #
119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Activity AWS API Documentation
120
+ #
121
+ class Activity < Struct.new(
122
+ :type,
123
+ :time_stamp,
124
+ :organization_id,
125
+ :initiator,
126
+ :participants,
127
+ :resource_metadata,
128
+ :original_parent,
129
+ :comment_metadata)
130
+ include Aws::Structure
131
+ end
132
+
64
133
  # @note When making an API call, you may pass AddResourcePermissionsRequest
65
134
  # data as a hash:
66
135
  #
67
136
  # {
137
+ # authentication_token: "AuthenticationHeaderType",
68
138
  # resource_id: "ResourceIdType", # required
69
139
  # principals: [ # required
70
140
  # {
@@ -75,6 +145,12 @@ module Aws::WorkDocs
75
145
  # ],
76
146
  # }
77
147
  #
148
+ # @!attribute [rw] authentication_token
149
+ # Amazon WorkDocs authentication token. This field should not be set
150
+ # when using administrative API actions, as in accessing the API using
151
+ # AWS credentials.
152
+ # @return [String]
153
+ #
78
154
  # @!attribute [rw] resource_id
79
155
  # The ID of the resource.
80
156
  # @return [String]
@@ -86,6 +162,7 @@ module Aws::WorkDocs
86
162
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsRequest AWS API Documentation
87
163
  #
88
164
  class AddResourcePermissionsRequest < Struct.new(
165
+ :authentication_token,
89
166
  :resource_id,
90
167
  :principals)
91
168
  include Aws::Structure
@@ -102,14 +179,231 @@ module Aws::WorkDocs
102
179
  include Aws::Structure
103
180
  end
104
181
 
182
+ # Describes a comment.
183
+ #
184
+ # @!attribute [rw] comment_id
185
+ # The ID of the comment.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] parent_id
189
+ # The ID of the parent comment.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] thread_id
193
+ # The ID of the root comment in the thread.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] text
197
+ # The text of the comment.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] contributor
201
+ # The details of the user who made the comment.
202
+ # @return [Types::User]
203
+ #
204
+ # @!attribute [rw] created_timestamp
205
+ # The time that the comment was created.
206
+ # @return [Time]
207
+ #
208
+ # @!attribute [rw] status
209
+ # The status of the comment.
210
+ # @return [String]
211
+ #
212
+ # @!attribute [rw] visibility
213
+ # The visibility of the comment. Options are either PRIVATE, where the
214
+ # comment is visible only to the comment author and document owner and
215
+ # co-owners, or PUBLIC, where the comment is visible to document
216
+ # owners, co-owners, and contributors.
217
+ # @return [String]
218
+ #
219
+ # @!attribute [rw] recipient_id
220
+ # If the comment is a reply to another user's comment, this field
221
+ # contains the user ID of the user being replied to.
222
+ # @return [String]
223
+ #
224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Comment AWS API Documentation
225
+ #
226
+ class Comment < Struct.new(
227
+ :comment_id,
228
+ :parent_id,
229
+ :thread_id,
230
+ :text,
231
+ :contributor,
232
+ :created_timestamp,
233
+ :status,
234
+ :visibility,
235
+ :recipient_id)
236
+ include Aws::Structure
237
+ end
238
+
239
+ # Describes the metadata of a comment.
240
+ #
241
+ # @!attribute [rw] comment_id
242
+ # The ID of the comment.
243
+ # @return [String]
244
+ #
245
+ # @!attribute [rw] contributor
246
+ # The user who made the comment.
247
+ # @return [Types::User]
248
+ #
249
+ # @!attribute [rw] created_timestamp
250
+ # @return [Time]
251
+ #
252
+ # @!attribute [rw] comment_status
253
+ # @return [String]
254
+ #
255
+ # @!attribute [rw] recipient_id
256
+ # The ID of the user being replied to.
257
+ # @return [String]
258
+ #
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CommentMetadata AWS API Documentation
260
+ #
261
+ class CommentMetadata < Struct.new(
262
+ :comment_id,
263
+ :contributor,
264
+ :created_timestamp,
265
+ :comment_status,
266
+ :recipient_id)
267
+ include Aws::Structure
268
+ end
269
+
270
+ # @note When making an API call, you may pass CreateCommentRequest
271
+ # data as a hash:
272
+ #
273
+ # {
274
+ # authentication_token: "AuthenticationHeaderType",
275
+ # document_id: "ResourceIdType", # required
276
+ # version_id: "DocumentVersionIdType", # required
277
+ # parent_id: "CommentIdType",
278
+ # thread_id: "CommentIdType",
279
+ # text: "CommentTextType", # required
280
+ # visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
281
+ # notify_collaborators: false,
282
+ # }
283
+ #
284
+ # @!attribute [rw] authentication_token
285
+ # Amazon WorkDocs authentication token. This field should not be set
286
+ # when using administrative API actions, as in accessing the API using
287
+ # AWS credentials.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] document_id
291
+ # The ID of the document.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] version_id
295
+ # The ID of the document version.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] parent_id
299
+ # The ID of the parent comment.
300
+ # @return [String]
301
+ #
302
+ # @!attribute [rw] thread_id
303
+ # The ID of the root comment in the thread.
304
+ # @return [String]
305
+ #
306
+ # @!attribute [rw] text
307
+ # The text of the comment.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] visibility
311
+ # The visibility of the comment. Options are either PRIVATE, where the
312
+ # comment is visible only to the comment author and document owner and
313
+ # co-owners, or PUBLIC, where the comment is visible to document
314
+ # owners, co-owners, and contributors.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] notify_collaborators
318
+ # Set this parameter to TRUE to send an email out to the document
319
+ # collaborators after the comment is created.
320
+ # @return [Boolean]
321
+ #
322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCommentRequest AWS API Documentation
323
+ #
324
+ class CreateCommentRequest < Struct.new(
325
+ :authentication_token,
326
+ :document_id,
327
+ :version_id,
328
+ :parent_id,
329
+ :thread_id,
330
+ :text,
331
+ :visibility,
332
+ :notify_collaborators)
333
+ include Aws::Structure
334
+ end
335
+
336
+ # @!attribute [rw] comment
337
+ # The comment that has been created.
338
+ # @return [Types::Comment]
339
+ #
340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCommentResponse AWS API Documentation
341
+ #
342
+ class CreateCommentResponse < Struct.new(
343
+ :comment)
344
+ include Aws::Structure
345
+ end
346
+
347
+ # @note When making an API call, you may pass CreateCustomMetadataRequest
348
+ # data as a hash:
349
+ #
350
+ # {
351
+ # authentication_token: "AuthenticationHeaderType",
352
+ # resource_id: "ResourceIdType", # required
353
+ # version_id: "DocumentVersionIdType",
354
+ # custom_metadata: { # required
355
+ # "CustomMetadataKeyType" => "CustomMetadataValueType",
356
+ # },
357
+ # }
358
+ #
359
+ # @!attribute [rw] authentication_token
360
+ # Amazon WorkDocs authentication token. This field should not be set
361
+ # when using administrative API actions, as in accessing the API using
362
+ # AWS credentials.
363
+ # @return [String]
364
+ #
365
+ # @!attribute [rw] resource_id
366
+ # The ID of the resource.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] version_id
370
+ # The ID of the version, if the custom metadata is being added to a
371
+ # document version.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] custom_metadata
375
+ # Custom metadata in the form of name-value pairs.
376
+ # @return [Hash<String,String>]
377
+ #
378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadataRequest AWS API Documentation
379
+ #
380
+ class CreateCustomMetadataRequest < Struct.new(
381
+ :authentication_token,
382
+ :resource_id,
383
+ :version_id,
384
+ :custom_metadata)
385
+ include Aws::Structure
386
+ end
387
+
388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateCustomMetadataResponse AWS API Documentation
389
+ #
390
+ class CreateCustomMetadataResponse < Aws::EmptyStructure; end
391
+
105
392
  # @note When making an API call, you may pass CreateFolderRequest
106
393
  # data as a hash:
107
394
  #
108
395
  # {
396
+ # authentication_token: "AuthenticationHeaderType",
109
397
  # name: "ResourceNameType",
110
398
  # parent_folder_id: "ResourceIdType", # required
111
399
  # }
112
400
  #
401
+ # @!attribute [rw] authentication_token
402
+ # Amazon WorkDocs authentication token. This field should not be set
403
+ # when using administrative API actions, as in accessing the API using
404
+ # AWS credentials.
405
+ # @return [String]
406
+ #
113
407
  # @!attribute [rw] name
114
408
  # The name of the new folder.
115
409
  # @return [String]
@@ -121,6 +415,7 @@ module Aws::WorkDocs
121
415
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolderRequest AWS API Documentation
122
416
  #
123
417
  class CreateFolderRequest < Struct.new(
418
+ :authentication_token,
124
419
  :name,
125
420
  :parent_folder_id)
126
421
  include Aws::Structure
@@ -137,6 +432,42 @@ module Aws::WorkDocs
137
432
  include Aws::Structure
138
433
  end
139
434
 
435
+ # @note When making an API call, you may pass CreateLabelsRequest
436
+ # data as a hash:
437
+ #
438
+ # {
439
+ # resource_id: "ResourceIdType", # required
440
+ # labels: ["Label"], # required
441
+ # authentication_token: "AuthenticationHeaderType",
442
+ # }
443
+ #
444
+ # @!attribute [rw] resource_id
445
+ # The ID of the resource.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] labels
449
+ # List of labels to add to the resource.
450
+ # @return [Array<String>]
451
+ #
452
+ # @!attribute [rw] authentication_token
453
+ # Amazon WorkDocs authentication token. This field should not be set
454
+ # when using administrative API actions, as in accessing the API using
455
+ # AWS credentials.
456
+ # @return [String]
457
+ #
458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsRequest AWS API Documentation
459
+ #
460
+ class CreateLabelsRequest < Struct.new(
461
+ :resource_id,
462
+ :labels,
463
+ :authentication_token)
464
+ include Aws::Structure
465
+ end
466
+
467
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsResponse AWS API Documentation
468
+ #
469
+ class CreateLabelsResponse < Aws::EmptyStructure; end
470
+
140
471
  # @note When making an API call, you may pass CreateNotificationSubscriptionRequest
141
472
  # data as a hash:
142
473
  #
@@ -192,6 +523,7 @@ module Aws::WorkDocs
192
523
  # {
193
524
  # organization_id: "IdType",
194
525
  # username: "UsernameType", # required
526
+ # email_address: "EmailAddressType",
195
527
  # given_name: "UserAttributeValueType", # required
196
528
  # surname: "UserAttributeValueType", # required
197
529
  # password: "PasswordType", # required
@@ -200,6 +532,7 @@ module Aws::WorkDocs
200
532
  # storage_allocated_in_bytes: 1,
201
533
  # storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
202
534
  # },
535
+ # authentication_token: "AuthenticationHeaderType",
203
536
  # }
204
537
  #
205
538
  # @!attribute [rw] organization_id
@@ -210,6 +543,10 @@ module Aws::WorkDocs
210
543
  # The login name of the user.
211
544
  # @return [String]
212
545
  #
546
+ # @!attribute [rw] email_address
547
+ # The email address of the user.
548
+ # @return [String]
549
+ #
213
550
  # @!attribute [rw] given_name
214
551
  # The given name of the user.
215
552
  # @return [String]
@@ -230,16 +567,24 @@ module Aws::WorkDocs
230
567
  # The amount of storage for the user.
231
568
  # @return [Types::StorageRuleType]
232
569
  #
570
+ # @!attribute [rw] authentication_token
571
+ # Amazon WorkDocs authentication token. This field should not be set
572
+ # when using administrative API actions, as in accessing the API using
573
+ # AWS credentials.
574
+ # @return [String]
575
+ #
233
576
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest AWS API Documentation
234
577
  #
235
578
  class CreateUserRequest < Struct.new(
236
579
  :organization_id,
237
580
  :username,
581
+ :email_address,
238
582
  :given_name,
239
583
  :surname,
240
584
  :password,
241
585
  :time_zone_id,
242
- :storage_rule)
586
+ :storage_rule,
587
+ :authentication_token)
243
588
  include Aws::Structure
244
589
  end
245
590
 
@@ -259,26 +604,129 @@ module Aws::WorkDocs
259
604
  #
260
605
  # {
261
606
  # user_id: "IdType", # required
607
+ # authentication_token: "AuthenticationHeaderType",
262
608
  # }
263
609
  #
264
610
  # @!attribute [rw] user_id
265
611
  # The ID of the user.
266
612
  # @return [String]
267
613
  #
614
+ # @!attribute [rw] authentication_token
615
+ # Amazon WorkDocs authentication token. This field should not be set
616
+ # when using administrative API actions, as in accessing the API using
617
+ # AWS credentials.
618
+ # @return [String]
619
+ #
268
620
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest AWS API Documentation
269
621
  #
270
622
  class DeactivateUserRequest < Struct.new(
271
- :user_id)
623
+ :user_id,
624
+ :authentication_token)
272
625
  include Aws::Structure
273
626
  end
274
627
 
628
+ # @note When making an API call, you may pass DeleteCommentRequest
629
+ # data as a hash:
630
+ #
631
+ # {
632
+ # authentication_token: "AuthenticationHeaderType",
633
+ # document_id: "ResourceIdType", # required
634
+ # version_id: "DocumentVersionIdType", # required
635
+ # comment_id: "CommentIdType", # required
636
+ # }
637
+ #
638
+ # @!attribute [rw] authentication_token
639
+ # Amazon WorkDocs authentication token. This field should not be set
640
+ # when using administrative API actions, as in accessing the API using
641
+ # AWS credentials.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] document_id
645
+ # The ID of the document.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] version_id
649
+ # The ID of the document version.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] comment_id
653
+ # The ID of the comment.
654
+ # @return [String]
655
+ #
656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCommentRequest AWS API Documentation
657
+ #
658
+ class DeleteCommentRequest < Struct.new(
659
+ :authentication_token,
660
+ :document_id,
661
+ :version_id,
662
+ :comment_id)
663
+ include Aws::Structure
664
+ end
665
+
666
+ # @note When making an API call, you may pass DeleteCustomMetadataRequest
667
+ # data as a hash:
668
+ #
669
+ # {
670
+ # authentication_token: "AuthenticationHeaderType",
671
+ # resource_id: "ResourceIdType", # required
672
+ # version_id: "DocumentVersionIdType",
673
+ # keys: ["CustomMetadataKeyType"],
674
+ # delete_all: false,
675
+ # }
676
+ #
677
+ # @!attribute [rw] authentication_token
678
+ # Amazon WorkDocs authentication token. This field should not be set
679
+ # when using administrative API actions, as in accessing the API using
680
+ # AWS credentials.
681
+ # @return [String]
682
+ #
683
+ # @!attribute [rw] resource_id
684
+ # The ID of the resource, either a document or folder.
685
+ # @return [String]
686
+ #
687
+ # @!attribute [rw] version_id
688
+ # The ID of the version, if the custom metadata is being deleted from
689
+ # a document version.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] keys
693
+ # List of properties to remove.
694
+ # @return [Array<String>]
695
+ #
696
+ # @!attribute [rw] delete_all
697
+ # Flag to indicate removal of all custom metadata properties from the
698
+ # specified resource.
699
+ # @return [Boolean]
700
+ #
701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadataRequest AWS API Documentation
702
+ #
703
+ class DeleteCustomMetadataRequest < Struct.new(
704
+ :authentication_token,
705
+ :resource_id,
706
+ :version_id,
707
+ :keys,
708
+ :delete_all)
709
+ include Aws::Structure
710
+ end
711
+
712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadataResponse AWS API Documentation
713
+ #
714
+ class DeleteCustomMetadataResponse < Aws::EmptyStructure; end
715
+
275
716
  # @note When making an API call, you may pass DeleteDocumentRequest
276
717
  # data as a hash:
277
718
  #
278
719
  # {
720
+ # authentication_token: "AuthenticationHeaderType",
279
721
  # document_id: "ResourceIdType", # required
280
722
  # }
281
723
  #
724
+ # @!attribute [rw] authentication_token
725
+ # Amazon WorkDocs authentication token. This field should not be set
726
+ # when using administrative API actions, as in accessing the API using
727
+ # AWS credentials.
728
+ # @return [String]
729
+ #
282
730
  # @!attribute [rw] document_id
283
731
  # The ID of the document.
284
732
  # @return [String]
@@ -286,6 +734,7 @@ module Aws::WorkDocs
286
734
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentRequest AWS API Documentation
287
735
  #
288
736
  class DeleteDocumentRequest < Struct.new(
737
+ :authentication_token,
289
738
  :document_id)
290
739
  include Aws::Structure
291
740
  end
@@ -294,9 +743,16 @@ module Aws::WorkDocs
294
743
  # data as a hash:
295
744
  #
296
745
  # {
746
+ # authentication_token: "AuthenticationHeaderType",
297
747
  # folder_id: "ResourceIdType", # required
298
748
  # }
299
749
  #
750
+ # @!attribute [rw] authentication_token
751
+ # Amazon WorkDocs authentication token. This field should not be set
752
+ # when using administrative API actions, as in accessing the API using
753
+ # AWS credentials.
754
+ # @return [String]
755
+ #
300
756
  # @!attribute [rw] folder_id
301
757
  # The ID of the folder.
302
758
  # @return [String]
@@ -304,67 +760,268 @@ module Aws::WorkDocs
304
760
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContentsRequest AWS API Documentation
305
761
  #
306
762
  class DeleteFolderContentsRequest < Struct.new(
763
+ :authentication_token,
307
764
  :folder_id)
308
765
  include Aws::Structure
309
766
  end
310
767
 
311
- # @note When making an API call, you may pass DeleteFolderRequest
312
- # data as a hash:
313
- #
314
- # {
315
- # folder_id: "ResourceIdType", # required
316
- # }
768
+ # @note When making an API call, you may pass DeleteFolderRequest
769
+ # data as a hash:
770
+ #
771
+ # {
772
+ # authentication_token: "AuthenticationHeaderType",
773
+ # folder_id: "ResourceIdType", # required
774
+ # }
775
+ #
776
+ # @!attribute [rw] authentication_token
777
+ # Amazon WorkDocs authentication token. This field should not be set
778
+ # when using administrative API actions, as in accessing the API using
779
+ # AWS credentials.
780
+ # @return [String]
781
+ #
782
+ # @!attribute [rw] folder_id
783
+ # The ID of the folder.
784
+ # @return [String]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderRequest AWS API Documentation
787
+ #
788
+ class DeleteFolderRequest < Struct.new(
789
+ :authentication_token,
790
+ :folder_id)
791
+ include Aws::Structure
792
+ end
793
+
794
+ # @note When making an API call, you may pass DeleteLabelsRequest
795
+ # data as a hash:
796
+ #
797
+ # {
798
+ # resource_id: "ResourceIdType", # required
799
+ # authentication_token: "AuthenticationHeaderType",
800
+ # labels: ["Label"],
801
+ # delete_all: false,
802
+ # }
803
+ #
804
+ # @!attribute [rw] resource_id
805
+ # The ID of the resource.
806
+ # @return [String]
807
+ #
808
+ # @!attribute [rw] authentication_token
809
+ # Amazon WorkDocs authentication token. This field should not be set
810
+ # when using administrative API actions, as in accessing the API using
811
+ # AWS credentials.
812
+ # @return [String]
813
+ #
814
+ # @!attribute [rw] labels
815
+ # List of labels to delete from the resource.
816
+ # @return [Array<String>]
817
+ #
818
+ # @!attribute [rw] delete_all
819
+ # Flag to request removal of all labels from the specified resource.
820
+ # @return [Boolean]
821
+ #
822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabelsRequest AWS API Documentation
823
+ #
824
+ class DeleteLabelsRequest < Struct.new(
825
+ :resource_id,
826
+ :authentication_token,
827
+ :labels,
828
+ :delete_all)
829
+ include Aws::Structure
830
+ end
831
+
832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteLabelsResponse AWS API Documentation
833
+ #
834
+ class DeleteLabelsResponse < Aws::EmptyStructure; end
835
+
836
+ # @note When making an API call, you may pass DeleteNotificationSubscriptionRequest
837
+ # data as a hash:
838
+ #
839
+ # {
840
+ # subscription_id: "IdType", # required
841
+ # organization_id: "IdType", # required
842
+ # }
843
+ #
844
+ # @!attribute [rw] subscription_id
845
+ # The ID of the subscription.
846
+ # @return [String]
847
+ #
848
+ # @!attribute [rw] organization_id
849
+ # The ID of the organization.
850
+ # @return [String]
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscriptionRequest AWS API Documentation
853
+ #
854
+ class DeleteNotificationSubscriptionRequest < Struct.new(
855
+ :subscription_id,
856
+ :organization_id)
857
+ include Aws::Structure
858
+ end
859
+
860
+ # @note When making an API call, you may pass DeleteUserRequest
861
+ # data as a hash:
862
+ #
863
+ # {
864
+ # authentication_token: "AuthenticationHeaderType",
865
+ # user_id: "IdType", # required
866
+ # }
867
+ #
868
+ # @!attribute [rw] authentication_token
869
+ # Amazon WorkDocs authentication token. This field should not be set
870
+ # when using administrative API actions, as in accessing the API using
871
+ # AWS credentials.
872
+ # @return [String]
873
+ #
874
+ # @!attribute [rw] user_id
875
+ # The ID of the user.
876
+ # @return [String]
877
+ #
878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUserRequest AWS API Documentation
879
+ #
880
+ class DeleteUserRequest < Struct.new(
881
+ :authentication_token,
882
+ :user_id)
883
+ include Aws::Structure
884
+ end
885
+
886
+ # @note When making an API call, you may pass DescribeActivitiesRequest
887
+ # data as a hash:
888
+ #
889
+ # {
890
+ # authentication_token: "AuthenticationHeaderType",
891
+ # start_time: Time.now,
892
+ # end_time: Time.now,
893
+ # organization_id: "IdType",
894
+ # user_id: "IdType",
895
+ # limit: 1,
896
+ # marker: "MarkerType",
897
+ # }
898
+ #
899
+ # @!attribute [rw] authentication_token
900
+ # Amazon WorkDocs authentication token. This field should not be set
901
+ # when using administrative API actions, as in accessing the API using
902
+ # AWS credentials.
903
+ # @return [String]
904
+ #
905
+ # @!attribute [rw] start_time
906
+ # The timestamp that determines the starting time of the activities;
907
+ # the response includes the activities performed after the specified
908
+ # timestamp.
909
+ # @return [Time]
910
+ #
911
+ # @!attribute [rw] end_time
912
+ # The timestamp that determines the end time of the activities; the
913
+ # response includes the activities performed before the specified
914
+ # timestamp.
915
+ # @return [Time]
916
+ #
917
+ # @!attribute [rw] organization_id
918
+ # The ID of the organization. This is a mandatory parameter when using
919
+ # administrative API (SigV4) requests.
920
+ # @return [String]
921
+ #
922
+ # @!attribute [rw] user_id
923
+ # The ID of the user who performed the action. The response includes
924
+ # activities pertaining to this user. This is an optional parameter
925
+ # and is only applicable for administrative API (SigV4) requests.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] limit
929
+ # The maximum number of items to return.
930
+ # @return [Integer]
931
+ #
932
+ # @!attribute [rw] marker
933
+ # The marker for the next set of results. (You received this marker
934
+ # from a previous call.)
935
+ # @return [String]
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivitiesRequest AWS API Documentation
938
+ #
939
+ class DescribeActivitiesRequest < Struct.new(
940
+ :authentication_token,
941
+ :start_time,
942
+ :end_time,
943
+ :organization_id,
944
+ :user_id,
945
+ :limit,
946
+ :marker)
947
+ include Aws::Structure
948
+ end
949
+
950
+ # @!attribute [rw] user_activities
951
+ # The list of activities for the specified user and time period.
952
+ # @return [Array<Types::Activity>]
317
953
  #
318
- # @!attribute [rw] folder_id
319
- # The ID of the folder.
954
+ # @!attribute [rw] marker
955
+ # The marker for the next set of results.
320
956
  # @return [String]
321
957
  #
322
- # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderRequest AWS API Documentation
958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivitiesResponse AWS API Documentation
323
959
  #
324
- class DeleteFolderRequest < Struct.new(
325
- :folder_id)
960
+ class DescribeActivitiesResponse < Struct.new(
961
+ :user_activities,
962
+ :marker)
326
963
  include Aws::Structure
327
964
  end
328
965
 
329
- # @note When making an API call, you may pass DeleteNotificationSubscriptionRequest
966
+ # @note When making an API call, you may pass DescribeCommentsRequest
330
967
  # data as a hash:
331
968
  #
332
969
  # {
333
- # subscription_id: "IdType", # required
334
- # organization_id: "IdType", # required
970
+ # authentication_token: "AuthenticationHeaderType",
971
+ # document_id: "ResourceIdType", # required
972
+ # version_id: "DocumentVersionIdType", # required
973
+ # limit: 1,
974
+ # marker: "MarkerType",
335
975
  # }
336
976
  #
337
- # @!attribute [rw] subscription_id
338
- # The ID of the subscription.
977
+ # @!attribute [rw] authentication_token
978
+ # Amazon WorkDocs authentication token. This field should not be set
979
+ # when using administrative API actions, as in accessing the API using
980
+ # AWS credentials.
339
981
  # @return [String]
340
982
  #
341
- # @!attribute [rw] organization_id
342
- # The ID of the organization.
983
+ # @!attribute [rw] document_id
984
+ # The ID of the document.
343
985
  # @return [String]
344
986
  #
345
- # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscriptionRequest AWS API Documentation
987
+ # @!attribute [rw] version_id
988
+ # The ID of the document version.
989
+ # @return [String]
346
990
  #
347
- class DeleteNotificationSubscriptionRequest < Struct.new(
348
- :subscription_id,
349
- :organization_id)
991
+ # @!attribute [rw] limit
992
+ # The maximum number of items to return.
993
+ # @return [Integer]
994
+ #
995
+ # @!attribute [rw] marker
996
+ # The marker for the next set of results. This marker was received
997
+ # from a previous call.
998
+ # @return [String]
999
+ #
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeCommentsRequest AWS API Documentation
1001
+ #
1002
+ class DescribeCommentsRequest < Struct.new(
1003
+ :authentication_token,
1004
+ :document_id,
1005
+ :version_id,
1006
+ :limit,
1007
+ :marker)
350
1008
  include Aws::Structure
351
1009
  end
352
1010
 
353
- # @note When making an API call, you may pass DeleteUserRequest
354
- # data as a hash:
355
- #
356
- # {
357
- # user_id: "IdType", # required
358
- # }
1011
+ # @!attribute [rw] comments
1012
+ # The list of comments for the specified document version.
1013
+ # @return [Array<Types::Comment>]
359
1014
  #
360
- # @!attribute [rw] user_id
361
- # The ID of the user.
1015
+ # @!attribute [rw] marker
1016
+ # The marker for the next set of results. This marker was received
1017
+ # from a previous call.
362
1018
  # @return [String]
363
1019
  #
364
- # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUserRequest AWS API Documentation
1020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeCommentsResponse AWS API Documentation
365
1021
  #
366
- class DeleteUserRequest < Struct.new(
367
- :user_id)
1022
+ class DescribeCommentsResponse < Struct.new(
1023
+ :comments,
1024
+ :marker)
368
1025
  include Aws::Structure
369
1026
  end
370
1027
 
@@ -372,6 +1029,7 @@ module Aws::WorkDocs
372
1029
  # data as a hash:
373
1030
  #
374
1031
  # {
1032
+ # authentication_token: "AuthenticationHeaderType",
375
1033
  # document_id: "ResourceIdType", # required
376
1034
  # marker: "PageMarkerType",
377
1035
  # limit: 1,
@@ -379,6 +1037,12 @@ module Aws::WorkDocs
379
1037
  # fields: "FieldNamesType",
380
1038
  # }
381
1039
  #
1040
+ # @!attribute [rw] authentication_token
1041
+ # Amazon WorkDocs authentication token. This field should not be set
1042
+ # when using administrative API actions, as in accessing the API using
1043
+ # AWS credentials.
1044
+ # @return [String]
1045
+ #
382
1046
  # @!attribute [rw] document_id
383
1047
  # The ID of the document.
384
1048
  # @return [String]
@@ -405,6 +1069,7 @@ module Aws::WorkDocs
405
1069
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersionsRequest AWS API Documentation
406
1070
  #
407
1071
  class DescribeDocumentVersionsRequest < Struct.new(
1072
+ :authentication_token,
408
1073
  :document_id,
409
1074
  :marker,
410
1075
  :limit,
@@ -434,6 +1099,7 @@ module Aws::WorkDocs
434
1099
  # data as a hash:
435
1100
  #
436
1101
  # {
1102
+ # authentication_token: "AuthenticationHeaderType",
437
1103
  # folder_id: "ResourceIdType", # required
438
1104
  # sort: "DATE", # accepts DATE, NAME
439
1105
  # order: "ASCENDING", # accepts ASCENDING, DESCENDING
@@ -443,6 +1109,12 @@ module Aws::WorkDocs
443
1109
  # include: "FieldNamesType",
444
1110
  # }
445
1111
  #
1112
+ # @!attribute [rw] authentication_token
1113
+ # Amazon WorkDocs authentication token. This field should not be set
1114
+ # when using administrative API actions, as in accessing the API using
1115
+ # AWS credentials.
1116
+ # @return [String]
1117
+ #
446
1118
  # @!attribute [rw] folder_id
447
1119
  # The ID of the folder.
448
1120
  # @return [String]
@@ -460,8 +1132,8 @@ module Aws::WorkDocs
460
1132
  # @return [Integer]
461
1133
  #
462
1134
  # @!attribute [rw] marker
463
- # The marker for the next set of results. (You received this marker
464
- # from a previous call.)
1135
+ # The marker for the next set of results. This marker was received
1136
+ # from a previous call.
465
1137
  # @return [String]
466
1138
  #
467
1139
  # @!attribute [rw] type
@@ -476,6 +1148,7 @@ module Aws::WorkDocs
476
1148
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContentsRequest AWS API Documentation
477
1149
  #
478
1150
  class DescribeFolderContentsRequest < Struct.new(
1151
+ :authentication_token,
479
1152
  :folder_id,
480
1153
  :sort,
481
1154
  :order,
@@ -487,7 +1160,7 @@ module Aws::WorkDocs
487
1160
  end
488
1161
 
489
1162
  # @!attribute [rw] folders
490
- # The sub-folders in the specified folder.
1163
+ # The subfolders in the specified folder.
491
1164
  # @return [Array<Types::FolderMetadata>]
492
1165
  #
493
1166
  # @!attribute [rw] documents
@@ -560,11 +1233,18 @@ module Aws::WorkDocs
560
1233
  # data as a hash:
561
1234
  #
562
1235
  # {
1236
+ # authentication_token: "AuthenticationHeaderType",
563
1237
  # resource_id: "ResourceIdType", # required
564
1238
  # limit: 1,
565
1239
  # marker: "PageMarkerType",
566
1240
  # }
567
1241
  #
1242
+ # @!attribute [rw] authentication_token
1243
+ # Amazon WorkDocs authentication token. This field should not be set
1244
+ # when using administrative API actions, as in accessing the API using
1245
+ # AWS credentials.
1246
+ # @return [String]
1247
+ #
568
1248
  # @!attribute [rw] resource_id
569
1249
  # The ID of the resource.
570
1250
  # @return [String]
@@ -581,6 +1261,7 @@ module Aws::WorkDocs
581
1261
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissionsRequest AWS API Documentation
582
1262
  #
583
1263
  class DescribeResourcePermissionsRequest < Struct.new(
1264
+ :authentication_token,
584
1265
  :resource_id,
585
1266
  :limit,
586
1267
  :marker)
@@ -604,10 +1285,60 @@ module Aws::WorkDocs
604
1285
  include Aws::Structure
605
1286
  end
606
1287
 
1288
+ # @note When making an API call, you may pass DescribeRootFoldersRequest
1289
+ # data as a hash:
1290
+ #
1291
+ # {
1292
+ # authentication_token: "AuthenticationHeaderType", # required
1293
+ # limit: 1,
1294
+ # marker: "PageMarkerType",
1295
+ # }
1296
+ #
1297
+ # @!attribute [rw] authentication_token
1298
+ # Amazon WorkDocs authentication token. This field should not be set
1299
+ # when using administrative API actions, as in accessing the API using
1300
+ # AWS credentials.
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] limit
1304
+ # The maximum number of items to return.
1305
+ # @return [Integer]
1306
+ #
1307
+ # @!attribute [rw] marker
1308
+ # The marker for the next set of results. (You received this marker
1309
+ # from a previous call.)
1310
+ # @return [String]
1311
+ #
1312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFoldersRequest AWS API Documentation
1313
+ #
1314
+ class DescribeRootFoldersRequest < Struct.new(
1315
+ :authentication_token,
1316
+ :limit,
1317
+ :marker)
1318
+ include Aws::Structure
1319
+ end
1320
+
1321
+ # @!attribute [rw] folders
1322
+ # The user's special folders.
1323
+ # @return [Array<Types::FolderMetadata>]
1324
+ #
1325
+ # @!attribute [rw] marker
1326
+ # The marker for the next set of results.
1327
+ # @return [String]
1328
+ #
1329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeRootFoldersResponse AWS API Documentation
1330
+ #
1331
+ class DescribeRootFoldersResponse < Struct.new(
1332
+ :folders,
1333
+ :marker)
1334
+ include Aws::Structure
1335
+ end
1336
+
607
1337
  # @note When making an API call, you may pass DescribeUsersRequest
608
1338
  # data as a hash:
609
1339
  #
610
1340
  # {
1341
+ # authentication_token: "AuthenticationHeaderType",
611
1342
  # organization_id: "IdType",
612
1343
  # user_ids: "UserIdsType",
613
1344
  # query: "SearchQueryType",
@@ -619,6 +1350,12 @@ module Aws::WorkDocs
619
1350
  # fields: "FieldNamesType",
620
1351
  # }
621
1352
  #
1353
+ # @!attribute [rw] authentication_token
1354
+ # Amazon WorkDocs authentication token. This field should not be set
1355
+ # when using administrative API actions, as in accessing the API using
1356
+ # AWS credentials.
1357
+ # @return [String]
1358
+ #
622
1359
  # @!attribute [rw] organization_id
623
1360
  # The ID of the organization.
624
1361
  # @return [String]
@@ -660,6 +1397,7 @@ module Aws::WorkDocs
660
1397
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersRequest AWS API Documentation
661
1398
  #
662
1399
  class DescribeUsersRequest < Struct.new(
1400
+ :authentication_token,
663
1401
  :organization_id,
664
1402
  :user_ids,
665
1403
  :query,
@@ -724,6 +1462,10 @@ module Aws::WorkDocs
724
1462
  # The resource state.
725
1463
  # @return [String]
726
1464
  #
1465
+ # @!attribute [rw] labels
1466
+ # List of labels on the document.
1467
+ # @return [Array<String>]
1468
+ #
727
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DocumentMetadata AWS API Documentation
728
1470
  #
729
1471
  class DocumentMetadata < Struct.new(
@@ -733,7 +1475,8 @@ module Aws::WorkDocs
733
1475
  :created_timestamp,
734
1476
  :modified_timestamp,
735
1477
  :latest_version_metadata,
736
- :resource_state)
1478
+ :resource_state,
1479
+ :labels)
737
1480
  include Aws::Structure
738
1481
  end
739
1482
 
@@ -846,6 +1589,18 @@ module Aws::WorkDocs
846
1589
  # the folder.
847
1590
  # @return [String]
848
1591
  #
1592
+ # @!attribute [rw] labels
1593
+ # List of labels on the folder.
1594
+ # @return [Array<String>]
1595
+ #
1596
+ # @!attribute [rw] size
1597
+ # The size of the folder metadata.
1598
+ # @return [Integer]
1599
+ #
1600
+ # @!attribute [rw] latest_version_size
1601
+ # The size of the latest version of the folder metadata.
1602
+ # @return [Integer]
1603
+ #
849
1604
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/FolderMetadata AWS API Documentation
850
1605
  #
851
1606
  class FolderMetadata < Struct.new(
@@ -856,7 +1611,39 @@ module Aws::WorkDocs
856
1611
  :created_timestamp,
857
1612
  :modified_timestamp,
858
1613
  :resource_state,
859
- :signature)
1614
+ :signature,
1615
+ :labels,
1616
+ :size,
1617
+ :latest_version_size)
1618
+ include Aws::Structure
1619
+ end
1620
+
1621
+ # @note When making an API call, you may pass GetCurrentUserRequest
1622
+ # data as a hash:
1623
+ #
1624
+ # {
1625
+ # authentication_token: "AuthenticationHeaderType", # required
1626
+ # }
1627
+ #
1628
+ # @!attribute [rw] authentication_token
1629
+ # Amazon WorkDocs authentication token.
1630
+ # @return [String]
1631
+ #
1632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUserRequest AWS API Documentation
1633
+ #
1634
+ class GetCurrentUserRequest < Struct.new(
1635
+ :authentication_token)
1636
+ include Aws::Structure
1637
+ end
1638
+
1639
+ # @!attribute [rw] user
1640
+ # Metadata of the user.
1641
+ # @return [Types::User]
1642
+ #
1643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetCurrentUserResponse AWS API Documentation
1644
+ #
1645
+ class GetCurrentUserResponse < Struct.new(
1646
+ :user)
860
1647
  include Aws::Structure
861
1648
  end
862
1649
 
@@ -864,12 +1651,19 @@ module Aws::WorkDocs
864
1651
  # data as a hash:
865
1652
  #
866
1653
  # {
1654
+ # authentication_token: "AuthenticationHeaderType",
867
1655
  # document_id: "IdType", # required
868
1656
  # limit: 1,
869
1657
  # fields: "FieldNamesType",
870
1658
  # marker: "PageMarkerType",
871
1659
  # }
872
1660
  #
1661
+ # @!attribute [rw] authentication_token
1662
+ # Amazon WorkDocs authentication token. This field should not be set
1663
+ # when using administrative API actions, as in accessing the API using
1664
+ # AWS credentials.
1665
+ # @return [String]
1666
+ #
873
1667
  # @!attribute [rw] document_id
874
1668
  # The ID of the document.
875
1669
  # @return [String]
@@ -879,7 +1673,7 @@ module Aws::WorkDocs
879
1673
  # @return [Integer]
880
1674
  #
881
1675
  # @!attribute [rw] fields
882
- # A comma-separated list of values. Specify "NAME" to include the
1676
+ # A comma-separated list of values. Specify `NAME` to include the
883
1677
  # names of the parent folders.
884
1678
  # @return [String]
885
1679
  #
@@ -890,6 +1684,7 @@ module Aws::WorkDocs
890
1684
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPathRequest AWS API Documentation
891
1685
  #
892
1686
  class GetDocumentPathRequest < Struct.new(
1687
+ :authentication_token,
893
1688
  :document_id,
894
1689
  :limit,
895
1690
  :fields,
@@ -912,28 +1707,47 @@ module Aws::WorkDocs
912
1707
  # data as a hash:
913
1708
  #
914
1709
  # {
1710
+ # authentication_token: "AuthenticationHeaderType",
915
1711
  # document_id: "ResourceIdType", # required
1712
+ # include_custom_metadata: false,
916
1713
  # }
917
1714
  #
1715
+ # @!attribute [rw] authentication_token
1716
+ # Amazon WorkDocs authentication token. This field should not be set
1717
+ # when using administrative API actions, as in accessing the API using
1718
+ # AWS credentials.
1719
+ # @return [String]
1720
+ #
918
1721
  # @!attribute [rw] document_id
919
- # The ID of the document object.
1722
+ # The ID of the document.
920
1723
  # @return [String]
921
1724
  #
1725
+ # @!attribute [rw] include_custom_metadata
1726
+ # Set this to `TRUE` to include custom metadata in the response.
1727
+ # @return [Boolean]
1728
+ #
922
1729
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentRequest AWS API Documentation
923
1730
  #
924
1731
  class GetDocumentRequest < Struct.new(
925
- :document_id)
1732
+ :authentication_token,
1733
+ :document_id,
1734
+ :include_custom_metadata)
926
1735
  include Aws::Structure
927
1736
  end
928
1737
 
929
1738
  # @!attribute [rw] metadata
930
- # The document object.
1739
+ # The metadata details of the document.
931
1740
  # @return [Types::DocumentMetadata]
932
1741
  #
1742
+ # @!attribute [rw] custom_metadata
1743
+ # The custom metadata on the document.
1744
+ # @return [Hash<String,String>]
1745
+ #
933
1746
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentResponse AWS API Documentation
934
1747
  #
935
1748
  class GetDocumentResponse < Struct.new(
936
- :metadata)
1749
+ :metadata,
1750
+ :custom_metadata)
937
1751
  include Aws::Structure
938
1752
  end
939
1753
 
@@ -941,11 +1755,19 @@ module Aws::WorkDocs
941
1755
  # data as a hash:
942
1756
  #
943
1757
  # {
1758
+ # authentication_token: "AuthenticationHeaderType",
944
1759
  # document_id: "ResourceIdType", # required
945
1760
  # version_id: "DocumentVersionIdType", # required
946
1761
  # fields: "FieldNamesType",
1762
+ # include_custom_metadata: false,
947
1763
  # }
948
1764
  #
1765
+ # @!attribute [rw] authentication_token
1766
+ # Amazon WorkDocs authentication token. This field should not be set
1767
+ # when using administrative API actions, as in accessing the API using
1768
+ # AWS credentials.
1769
+ # @return [String]
1770
+ #
949
1771
  # @!attribute [rw] document_id
950
1772
  # The ID of the document.
951
1773
  # @return [String]
@@ -959,12 +1781,18 @@ module Aws::WorkDocs
959
1781
  # URL for the source document.
960
1782
  # @return [String]
961
1783
  #
1784
+ # @!attribute [rw] include_custom_metadata
1785
+ # Set this to TRUE to include custom metadata in the response.
1786
+ # @return [Boolean]
1787
+ #
962
1788
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionRequest AWS API Documentation
963
1789
  #
964
1790
  class GetDocumentVersionRequest < Struct.new(
1791
+ :authentication_token,
965
1792
  :document_id,
966
1793
  :version_id,
967
- :fields)
1794
+ :fields,
1795
+ :include_custom_metadata)
968
1796
  include Aws::Structure
969
1797
  end
970
1798
 
@@ -972,10 +1800,15 @@ module Aws::WorkDocs
972
1800
  # The version metadata.
973
1801
  # @return [Types::DocumentVersionMetadata]
974
1802
  #
1803
+ # @!attribute [rw] custom_metadata
1804
+ # The custom metadata on the document version.
1805
+ # @return [Hash<String,String>]
1806
+ #
975
1807
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionResponse AWS API Documentation
976
1808
  #
977
1809
  class GetDocumentVersionResponse < Struct.new(
978
- :metadata)
1810
+ :metadata,
1811
+ :custom_metadata)
979
1812
  include Aws::Structure
980
1813
  end
981
1814
 
@@ -983,12 +1816,19 @@ module Aws::WorkDocs
983
1816
  # data as a hash:
984
1817
  #
985
1818
  # {
1819
+ # authentication_token: "AuthenticationHeaderType",
986
1820
  # folder_id: "IdType", # required
987
1821
  # limit: 1,
988
1822
  # fields: "FieldNamesType",
989
1823
  # marker: "PageMarkerType",
990
1824
  # }
991
1825
  #
1826
+ # @!attribute [rw] authentication_token
1827
+ # Amazon WorkDocs authentication token. This field should not be set
1828
+ # when using administrative API actions, as in accessing the API using
1829
+ # AWS credentials.
1830
+ # @return [String]
1831
+ #
992
1832
  # @!attribute [rw] folder_id
993
1833
  # The ID of the folder.
994
1834
  # @return [String]
@@ -1009,6 +1849,7 @@ module Aws::WorkDocs
1009
1849
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPathRequest AWS API Documentation
1010
1850
  #
1011
1851
  class GetFolderPathRequest < Struct.new(
1852
+ :authentication_token,
1012
1853
  :folder_id,
1013
1854
  :limit,
1014
1855
  :fields,
@@ -1031,17 +1872,31 @@ module Aws::WorkDocs
1031
1872
  # data as a hash:
1032
1873
  #
1033
1874
  # {
1875
+ # authentication_token: "AuthenticationHeaderType",
1034
1876
  # folder_id: "ResourceIdType", # required
1877
+ # include_custom_metadata: false,
1035
1878
  # }
1036
1879
  #
1880
+ # @!attribute [rw] authentication_token
1881
+ # Amazon WorkDocs authentication token. This field should not be set
1882
+ # when using administrative API actions, as in accessing the API using
1883
+ # AWS credentials.
1884
+ # @return [String]
1885
+ #
1037
1886
  # @!attribute [rw] folder_id
1038
1887
  # The ID of the folder.
1039
1888
  # @return [String]
1040
1889
  #
1890
+ # @!attribute [rw] include_custom_metadata
1891
+ # Set to TRUE to include custom metadata in the response.
1892
+ # @return [Boolean]
1893
+ #
1041
1894
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderRequest AWS API Documentation
1042
1895
  #
1043
1896
  class GetFolderRequest < Struct.new(
1044
- :folder_id)
1897
+ :authentication_token,
1898
+ :folder_id,
1899
+ :include_custom_metadata)
1045
1900
  include Aws::Structure
1046
1901
  end
1047
1902
 
@@ -1049,10 +1904,33 @@ module Aws::WorkDocs
1049
1904
  # The metadata of the folder.
1050
1905
  # @return [Types::FolderMetadata]
1051
1906
  #
1907
+ # @!attribute [rw] custom_metadata
1908
+ # The custom metadata on the folder.
1909
+ # @return [Hash<String,String>]
1910
+ #
1052
1911
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderResponse AWS API Documentation
1053
1912
  #
1054
1913
  class GetFolderResponse < Struct.new(
1055
- :metadata)
1914
+ :metadata,
1915
+ :custom_metadata)
1916
+ include Aws::Structure
1917
+ end
1918
+
1919
+ # Describes the metadata of a user group.
1920
+ #
1921
+ # @!attribute [rw] id
1922
+ # The ID of the user group.
1923
+ # @return [String]
1924
+ #
1925
+ # @!attribute [rw] name
1926
+ # The name of the group.
1927
+ # @return [String]
1928
+ #
1929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GroupMetadata AWS API Documentation
1930
+ #
1931
+ class GroupMetadata < Struct.new(
1932
+ :id,
1933
+ :name)
1056
1934
  include Aws::Structure
1057
1935
  end
1058
1936
 
@@ -1060,6 +1938,7 @@ module Aws::WorkDocs
1060
1938
  # data as a hash:
1061
1939
  #
1062
1940
  # {
1941
+ # authentication_token: "AuthenticationHeaderType",
1063
1942
  # id: "ResourceIdType",
1064
1943
  # name: "ResourceNameType",
1065
1944
  # content_created_timestamp: Time.now,
@@ -1069,6 +1948,12 @@ module Aws::WorkDocs
1069
1948
  # parent_folder_id: "ResourceIdType", # required
1070
1949
  # }
1071
1950
  #
1951
+ # @!attribute [rw] authentication_token
1952
+ # Amazon WorkDocs authentication token. This field should not be set
1953
+ # when using administrative API actions, as in accessing the API using
1954
+ # AWS credentials.
1955
+ # @return [String]
1956
+ #
1072
1957
  # @!attribute [rw] id
1073
1958
  # The ID of the document.
1074
1959
  # @return [String]
@@ -1101,6 +1986,7 @@ module Aws::WorkDocs
1101
1986
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUploadRequest AWS API Documentation
1102
1987
  #
1103
1988
  class InitiateDocumentVersionUploadRequest < Struct.new(
1989
+ :authentication_token,
1104
1990
  :id,
1105
1991
  :name,
1106
1992
  :content_created_timestamp,
@@ -1127,6 +2013,24 @@ module Aws::WorkDocs
1127
2013
  include Aws::Structure
1128
2014
  end
1129
2015
 
2016
+ # Describes the users and/or user groups.
2017
+ #
2018
+ # @!attribute [rw] users
2019
+ # The list of users.
2020
+ # @return [Array<Types::UserMetadata>]
2021
+ #
2022
+ # @!attribute [rw] groups
2023
+ # The list of user groups.
2024
+ # @return [Array<Types::GroupMetadata>]
2025
+ #
2026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Participants AWS API Documentation
2027
+ #
2028
+ class Participants < Struct.new(
2029
+ :users,
2030
+ :groups)
2031
+ include Aws::Structure
2032
+ end
2033
+
1130
2034
  # Describes the permissions.
1131
2035
  #
1132
2036
  # @!attribute [rw] role
@@ -1172,9 +2076,16 @@ module Aws::WorkDocs
1172
2076
  # data as a hash:
1173
2077
  #
1174
2078
  # {
2079
+ # authentication_token: "AuthenticationHeaderType",
1175
2080
  # resource_id: "ResourceIdType", # required
1176
2081
  # }
1177
2082
  #
2083
+ # @!attribute [rw] authentication_token
2084
+ # Amazon WorkDocs authentication token. This field should not be set
2085
+ # when using administrative API actions, as in accessing the API using
2086
+ # AWS credentials.
2087
+ # @return [String]
2088
+ #
1178
2089
  # @!attribute [rw] resource_id
1179
2090
  # The ID of the resource.
1180
2091
  # @return [String]
@@ -1182,6 +2093,7 @@ module Aws::WorkDocs
1182
2093
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissionsRequest AWS API Documentation
1183
2094
  #
1184
2095
  class RemoveAllResourcePermissionsRequest < Struct.new(
2096
+ :authentication_token,
1185
2097
  :resource_id)
1186
2098
  include Aws::Structure
1187
2099
  end
@@ -1190,11 +2102,18 @@ module Aws::WorkDocs
1190
2102
  # data as a hash:
1191
2103
  #
1192
2104
  # {
2105
+ # authentication_token: "AuthenticationHeaderType",
1193
2106
  # resource_id: "ResourceIdType", # required
1194
2107
  # principal_id: "IdType", # required
1195
2108
  # principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
1196
2109
  # }
1197
2110
  #
2111
+ # @!attribute [rw] authentication_token
2112
+ # Amazon WorkDocs authentication token. This field should not be set
2113
+ # when using administrative API actions, as in accessing the API using
2114
+ # AWS credentials.
2115
+ # @return [String]
2116
+ #
1198
2117
  # @!attribute [rw] resource_id
1199
2118
  # The ID of the resource.
1200
2119
  # @return [String]
@@ -1210,12 +2129,57 @@ module Aws::WorkDocs
1210
2129
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermissionRequest AWS API Documentation
1211
2130
  #
1212
2131
  class RemoveResourcePermissionRequest < Struct.new(
2132
+ :authentication_token,
1213
2133
  :resource_id,
1214
2134
  :principal_id,
1215
2135
  :principal_type)
1216
2136
  include Aws::Structure
1217
2137
  end
1218
2138
 
2139
+ # Describes the metadata of a resource.
2140
+ #
2141
+ # @!attribute [rw] type
2142
+ # The type of resource.
2143
+ # @return [String]
2144
+ #
2145
+ # @!attribute [rw] name
2146
+ # The name of the resource.
2147
+ # @return [String]
2148
+ #
2149
+ # @!attribute [rw] original_name
2150
+ # The original name of the resource prior to a rename operation.
2151
+ # @return [String]
2152
+ #
2153
+ # @!attribute [rw] id
2154
+ # The ID of the resource.
2155
+ # @return [String]
2156
+ #
2157
+ # @!attribute [rw] version_id
2158
+ # The version ID of the resource. This is an optional field and is
2159
+ # filled for action on document version.
2160
+ # @return [String]
2161
+ #
2162
+ # @!attribute [rw] owner
2163
+ # The owner of the resource.
2164
+ # @return [Types::UserMetadata]
2165
+ #
2166
+ # @!attribute [rw] parent_id
2167
+ # The parent ID of the resource before a rename operation.
2168
+ # @return [String]
2169
+ #
2170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourceMetadata AWS API Documentation
2171
+ #
2172
+ class ResourceMetadata < Struct.new(
2173
+ :type,
2174
+ :name,
2175
+ :original_name,
2176
+ :id,
2177
+ :version_id,
2178
+ :owner,
2179
+ :parent_id)
2180
+ include Aws::Structure
2181
+ end
2182
+
1219
2183
  # Describes the path information of a resource.
1220
2184
  #
1221
2185
  # @!attribute [rw] components
@@ -1365,12 +2329,19 @@ module Aws::WorkDocs
1365
2329
  # data as a hash:
1366
2330
  #
1367
2331
  # {
2332
+ # authentication_token: "AuthenticationHeaderType",
1368
2333
  # document_id: "ResourceIdType", # required
1369
2334
  # name: "ResourceNameType",
1370
2335
  # parent_folder_id: "ResourceIdType",
1371
2336
  # resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
1372
2337
  # }
1373
2338
  #
2339
+ # @!attribute [rw] authentication_token
2340
+ # Amazon WorkDocs authentication token. This field should not be set
2341
+ # when using administrative API actions, as in accessing the API using
2342
+ # AWS credentials.
2343
+ # @return [String]
2344
+ #
1374
2345
  # @!attribute [rw] document_id
1375
2346
  # The ID of the document.
1376
2347
  # @return [String]
@@ -1391,6 +2362,7 @@ module Aws::WorkDocs
1391
2362
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentRequest AWS API Documentation
1392
2363
  #
1393
2364
  class UpdateDocumentRequest < Struct.new(
2365
+ :authentication_token,
1394
2366
  :document_id,
1395
2367
  :name,
1396
2368
  :parent_folder_id,
@@ -1402,11 +2374,18 @@ module Aws::WorkDocs
1402
2374
  # data as a hash:
1403
2375
  #
1404
2376
  # {
2377
+ # authentication_token: "AuthenticationHeaderType",
1405
2378
  # document_id: "ResourceIdType", # required
1406
2379
  # version_id: "DocumentVersionIdType", # required
1407
2380
  # version_status: "ACTIVE", # accepts ACTIVE
1408
2381
  # }
1409
2382
  #
2383
+ # @!attribute [rw] authentication_token
2384
+ # Amazon WorkDocs authentication token. This field should not be set
2385
+ # when using administrative API actions, as in accessing the API using
2386
+ # AWS credentials.
2387
+ # @return [String]
2388
+ #
1410
2389
  # @!attribute [rw] document_id
1411
2390
  # The ID of the document.
1412
2391
  # @return [String]
@@ -1422,6 +2401,7 @@ module Aws::WorkDocs
1422
2401
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersionRequest AWS API Documentation
1423
2402
  #
1424
2403
  class UpdateDocumentVersionRequest < Struct.new(
2404
+ :authentication_token,
1425
2405
  :document_id,
1426
2406
  :version_id,
1427
2407
  :version_status)
@@ -1432,12 +2412,19 @@ module Aws::WorkDocs
1432
2412
  # data as a hash:
1433
2413
  #
1434
2414
  # {
2415
+ # authentication_token: "AuthenticationHeaderType",
1435
2416
  # folder_id: "ResourceIdType", # required
1436
2417
  # name: "ResourceNameType",
1437
2418
  # parent_folder_id: "ResourceIdType",
1438
2419
  # resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
1439
2420
  # }
1440
2421
  #
2422
+ # @!attribute [rw] authentication_token
2423
+ # Amazon WorkDocs authentication token. This field should not be set
2424
+ # when using administrative API actions, as in accessing the API using
2425
+ # AWS credentials.
2426
+ # @return [String]
2427
+ #
1441
2428
  # @!attribute [rw] folder_id
1442
2429
  # The ID of the folder.
1443
2430
  # @return [String]
@@ -1458,6 +2445,7 @@ module Aws::WorkDocs
1458
2445
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolderRequest AWS API Documentation
1459
2446
  #
1460
2447
  class UpdateFolderRequest < Struct.new(
2448
+ :authentication_token,
1461
2449
  :folder_id,
1462
2450
  :name,
1463
2451
  :parent_folder_id,
@@ -1469,6 +2457,7 @@ module Aws::WorkDocs
1469
2457
  # data as a hash:
1470
2458
  #
1471
2459
  # {
2460
+ # authentication_token: "AuthenticationHeaderType",
1472
2461
  # user_id: "IdType", # required
1473
2462
  # given_name: "UserAttributeValueType",
1474
2463
  # surname: "UserAttributeValueType",
@@ -1481,6 +2470,12 @@ module Aws::WorkDocs
1481
2470
  # locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
1482
2471
  # }
1483
2472
  #
2473
+ # @!attribute [rw] authentication_token
2474
+ # Amazon WorkDocs authentication token. This field should not be set
2475
+ # when using administrative API actions, as in accessing the API using
2476
+ # AWS credentials.
2477
+ # @return [String]
2478
+ #
1484
2479
  # @!attribute [rw] user_id
1485
2480
  # The ID of the user.
1486
2481
  # @return [String]
@@ -1512,6 +2507,7 @@ module Aws::WorkDocs
1512
2507
  # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserRequest AWS API Documentation
1513
2508
  #
1514
2509
  class UpdateUserRequest < Struct.new(
2510
+ :authentication_token,
1515
2511
  :user_id,
1516
2512
  :given_name,
1517
2513
  :surname,
@@ -1634,6 +2630,39 @@ module Aws::WorkDocs
1634
2630
  include Aws::Structure
1635
2631
  end
1636
2632
 
2633
+ # Describes the metadata of the user.
2634
+ #
2635
+ # @!attribute [rw] id
2636
+ # The ID of the user.
2637
+ # @return [String]
2638
+ #
2639
+ # @!attribute [rw] username
2640
+ # The username of the user.
2641
+ # @return [String]
2642
+ #
2643
+ # @!attribute [rw] given_name
2644
+ # The given name of the user before a rename operation.
2645
+ # @return [String]
2646
+ #
2647
+ # @!attribute [rw] surname
2648
+ # The surname of the user.
2649
+ # @return [String]
2650
+ #
2651
+ # @!attribute [rw] email_address
2652
+ # The email address of the user.
2653
+ # @return [String]
2654
+ #
2655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UserMetadata AWS API Documentation
2656
+ #
2657
+ class UserMetadata < Struct.new(
2658
+ :id,
2659
+ :username,
2660
+ :given_name,
2661
+ :surname,
2662
+ :email_address)
2663
+ include Aws::Structure
2664
+ end
2665
+
1637
2666
  # Describes the storage for a user.
1638
2667
  #
1639
2668
  # @!attribute [rw] storage_utilized_in_bytes