aws-sdk-workdocs 1.52.0 → 1.54.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workdocs/client.rb +1 -1
- data/lib/aws-sdk-workdocs/plugins/endpoints.rb +4 -2
- data/lib/aws-sdk-workdocs.rb +1 -1
- data/sig/client.rbs +671 -0
- data/sig/errors.rbs +90 -0
- data/sig/resource.rbs +79 -0
- data/sig/types.rbs +914 -0
- data/sig/waiters.rbs +13 -0
- metadata +13 -8
data/sig/types.rbs
ADDED
@@ -0,0 +1,914 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkDocs
|
9
|
+
module Types
|
10
|
+
|
11
|
+
class AbortDocumentVersionUploadRequest
|
12
|
+
attr_accessor authentication_token: ::String
|
13
|
+
attr_accessor document_id: ::String
|
14
|
+
attr_accessor version_id: ::String
|
15
|
+
SENSITIVE: [:authentication_token]
|
16
|
+
end
|
17
|
+
|
18
|
+
class ActivateUserRequest
|
19
|
+
attr_accessor user_id: ::String
|
20
|
+
attr_accessor authentication_token: ::String
|
21
|
+
SENSITIVE: [:authentication_token]
|
22
|
+
end
|
23
|
+
|
24
|
+
class ActivateUserResponse
|
25
|
+
attr_accessor user: Types::User
|
26
|
+
SENSITIVE: []
|
27
|
+
end
|
28
|
+
|
29
|
+
class Activity
|
30
|
+
attr_accessor type: ("DOCUMENT_CHECKED_IN" | "DOCUMENT_CHECKED_OUT" | "DOCUMENT_RENAMED" | "DOCUMENT_VERSION_UPLOADED" | "DOCUMENT_VERSION_DELETED" | "DOCUMENT_VERSION_VIEWED" | "DOCUMENT_VERSION_DOWNLOADED" | "DOCUMENT_RECYCLED" | "DOCUMENT_RESTORED" | "DOCUMENT_REVERTED" | "DOCUMENT_SHARED" | "DOCUMENT_UNSHARED" | "DOCUMENT_SHARE_PERMISSION_CHANGED" | "DOCUMENT_SHAREABLE_LINK_CREATED" | "DOCUMENT_SHAREABLE_LINK_REMOVED" | "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED" | "DOCUMENT_MOVED" | "DOCUMENT_COMMENT_ADDED" | "DOCUMENT_COMMENT_DELETED" | "DOCUMENT_ANNOTATION_ADDED" | "DOCUMENT_ANNOTATION_DELETED" | "FOLDER_CREATED" | "FOLDER_DELETED" | "FOLDER_RENAMED" | "FOLDER_RECYCLED" | "FOLDER_RESTORED" | "FOLDER_SHARED" | "FOLDER_UNSHARED" | "FOLDER_SHARE_PERMISSION_CHANGED" | "FOLDER_SHAREABLE_LINK_CREATED" | "FOLDER_SHAREABLE_LINK_REMOVED" | "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED" | "FOLDER_MOVED")
|
31
|
+
attr_accessor time_stamp: ::Time
|
32
|
+
attr_accessor is_indirect_activity: bool
|
33
|
+
attr_accessor organization_id: ::String
|
34
|
+
attr_accessor initiator: Types::UserMetadata
|
35
|
+
attr_accessor participants: Types::Participants
|
36
|
+
attr_accessor resource_metadata: Types::ResourceMetadata
|
37
|
+
attr_accessor original_parent: Types::ResourceMetadata
|
38
|
+
attr_accessor comment_metadata: Types::CommentMetadata
|
39
|
+
SENSITIVE: []
|
40
|
+
end
|
41
|
+
|
42
|
+
class AddResourcePermissionsRequest
|
43
|
+
attr_accessor authentication_token: ::String
|
44
|
+
attr_accessor resource_id: ::String
|
45
|
+
attr_accessor principals: ::Array[Types::SharePrincipal]
|
46
|
+
attr_accessor notification_options: Types::NotificationOptions
|
47
|
+
SENSITIVE: [:authentication_token]
|
48
|
+
end
|
49
|
+
|
50
|
+
class AddResourcePermissionsResponse
|
51
|
+
attr_accessor share_results: ::Array[Types::ShareResult]
|
52
|
+
SENSITIVE: []
|
53
|
+
end
|
54
|
+
|
55
|
+
class Comment
|
56
|
+
attr_accessor comment_id: ::String
|
57
|
+
attr_accessor parent_id: ::String
|
58
|
+
attr_accessor thread_id: ::String
|
59
|
+
attr_accessor text: ::String
|
60
|
+
attr_accessor contributor: Types::User
|
61
|
+
attr_accessor created_timestamp: ::Time
|
62
|
+
attr_accessor status: ("DRAFT" | "PUBLISHED" | "DELETED")
|
63
|
+
attr_accessor visibility: ("PUBLIC" | "PRIVATE")
|
64
|
+
attr_accessor recipient_id: ::String
|
65
|
+
SENSITIVE: [:text]
|
66
|
+
end
|
67
|
+
|
68
|
+
class CommentMetadata
|
69
|
+
attr_accessor comment_id: ::String
|
70
|
+
attr_accessor contributor: Types::User
|
71
|
+
attr_accessor created_timestamp: ::Time
|
72
|
+
attr_accessor comment_status: ("DRAFT" | "PUBLISHED" | "DELETED")
|
73
|
+
attr_accessor recipient_id: ::String
|
74
|
+
attr_accessor contributor_id: ::String
|
75
|
+
SENSITIVE: []
|
76
|
+
end
|
77
|
+
|
78
|
+
class ConcurrentModificationException
|
79
|
+
attr_accessor message: ::String
|
80
|
+
SENSITIVE: []
|
81
|
+
end
|
82
|
+
|
83
|
+
class ConflictingOperationException
|
84
|
+
attr_accessor message: ::String
|
85
|
+
SENSITIVE: []
|
86
|
+
end
|
87
|
+
|
88
|
+
class CreateCommentRequest
|
89
|
+
attr_accessor authentication_token: ::String
|
90
|
+
attr_accessor document_id: ::String
|
91
|
+
attr_accessor version_id: ::String
|
92
|
+
attr_accessor parent_id: ::String
|
93
|
+
attr_accessor thread_id: ::String
|
94
|
+
attr_accessor text: ::String
|
95
|
+
attr_accessor visibility: ("PUBLIC" | "PRIVATE")
|
96
|
+
attr_accessor notify_collaborators: bool
|
97
|
+
SENSITIVE: [:authentication_token, :text]
|
98
|
+
end
|
99
|
+
|
100
|
+
class CreateCommentResponse
|
101
|
+
attr_accessor comment: Types::Comment
|
102
|
+
SENSITIVE: []
|
103
|
+
end
|
104
|
+
|
105
|
+
class CreateCustomMetadataRequest
|
106
|
+
attr_accessor authentication_token: ::String
|
107
|
+
attr_accessor resource_id: ::String
|
108
|
+
attr_accessor version_id: ::String
|
109
|
+
attr_accessor custom_metadata: ::Hash[::String, ::String]
|
110
|
+
SENSITIVE: [:authentication_token]
|
111
|
+
end
|
112
|
+
|
113
|
+
class CreateCustomMetadataResponse < Aws::EmptyStructure
|
114
|
+
end
|
115
|
+
|
116
|
+
class CreateFolderRequest
|
117
|
+
attr_accessor authentication_token: ::String
|
118
|
+
attr_accessor name: ::String
|
119
|
+
attr_accessor parent_folder_id: ::String
|
120
|
+
SENSITIVE: [:authentication_token, :name]
|
121
|
+
end
|
122
|
+
|
123
|
+
class CreateFolderResponse
|
124
|
+
attr_accessor metadata: Types::FolderMetadata
|
125
|
+
SENSITIVE: []
|
126
|
+
end
|
127
|
+
|
128
|
+
class CreateLabelsRequest
|
129
|
+
attr_accessor resource_id: ::String
|
130
|
+
attr_accessor labels: ::Array[::String]
|
131
|
+
attr_accessor authentication_token: ::String
|
132
|
+
SENSITIVE: [:authentication_token]
|
133
|
+
end
|
134
|
+
|
135
|
+
class CreateLabelsResponse < Aws::EmptyStructure
|
136
|
+
end
|
137
|
+
|
138
|
+
class CreateNotificationSubscriptionRequest
|
139
|
+
attr_accessor organization_id: ::String
|
140
|
+
attr_accessor endpoint: ::String
|
141
|
+
attr_accessor protocol: ("HTTPS" | "SQS")
|
142
|
+
attr_accessor subscription_type: ("ALL")
|
143
|
+
SENSITIVE: []
|
144
|
+
end
|
145
|
+
|
146
|
+
class CreateNotificationSubscriptionResponse
|
147
|
+
attr_accessor subscription: Types::Subscription
|
148
|
+
SENSITIVE: []
|
149
|
+
end
|
150
|
+
|
151
|
+
class CreateUserRequest
|
152
|
+
attr_accessor organization_id: ::String
|
153
|
+
attr_accessor username: ::String
|
154
|
+
attr_accessor email_address: ::String
|
155
|
+
attr_accessor given_name: ::String
|
156
|
+
attr_accessor surname: ::String
|
157
|
+
attr_accessor password: ::String
|
158
|
+
attr_accessor time_zone_id: ::String
|
159
|
+
attr_accessor storage_rule: Types::StorageRuleType
|
160
|
+
attr_accessor authentication_token: ::String
|
161
|
+
SENSITIVE: [:username, :email_address, :given_name, :surname, :password, :authentication_token]
|
162
|
+
end
|
163
|
+
|
164
|
+
class CreateUserResponse
|
165
|
+
attr_accessor user: Types::User
|
166
|
+
SENSITIVE: []
|
167
|
+
end
|
168
|
+
|
169
|
+
class CustomMetadataLimitExceededException
|
170
|
+
attr_accessor message: ::String
|
171
|
+
SENSITIVE: []
|
172
|
+
end
|
173
|
+
|
174
|
+
class DateRangeType
|
175
|
+
attr_accessor start_value: ::Time
|
176
|
+
attr_accessor end_value: ::Time
|
177
|
+
SENSITIVE: []
|
178
|
+
end
|
179
|
+
|
180
|
+
class DeactivateUserRequest
|
181
|
+
attr_accessor user_id: ::String
|
182
|
+
attr_accessor authentication_token: ::String
|
183
|
+
SENSITIVE: [:authentication_token]
|
184
|
+
end
|
185
|
+
|
186
|
+
class DeactivatingLastSystemUserException < Aws::EmptyStructure
|
187
|
+
end
|
188
|
+
|
189
|
+
class DeleteCommentRequest
|
190
|
+
attr_accessor authentication_token: ::String
|
191
|
+
attr_accessor document_id: ::String
|
192
|
+
attr_accessor version_id: ::String
|
193
|
+
attr_accessor comment_id: ::String
|
194
|
+
SENSITIVE: [:authentication_token]
|
195
|
+
end
|
196
|
+
|
197
|
+
class DeleteCustomMetadataRequest
|
198
|
+
attr_accessor authentication_token: ::String
|
199
|
+
attr_accessor resource_id: ::String
|
200
|
+
attr_accessor version_id: ::String
|
201
|
+
attr_accessor keys: ::Array[::String]
|
202
|
+
attr_accessor delete_all: bool
|
203
|
+
SENSITIVE: [:authentication_token]
|
204
|
+
end
|
205
|
+
|
206
|
+
class DeleteCustomMetadataResponse < Aws::EmptyStructure
|
207
|
+
end
|
208
|
+
|
209
|
+
class DeleteDocumentRequest
|
210
|
+
attr_accessor authentication_token: ::String
|
211
|
+
attr_accessor document_id: ::String
|
212
|
+
SENSITIVE: [:authentication_token]
|
213
|
+
end
|
214
|
+
|
215
|
+
class DeleteDocumentVersionRequest
|
216
|
+
attr_accessor authentication_token: ::String
|
217
|
+
attr_accessor document_id: ::String
|
218
|
+
attr_accessor version_id: ::String
|
219
|
+
attr_accessor delete_prior_versions: bool
|
220
|
+
SENSITIVE: [:authentication_token]
|
221
|
+
end
|
222
|
+
|
223
|
+
class DeleteFolderContentsRequest
|
224
|
+
attr_accessor authentication_token: ::String
|
225
|
+
attr_accessor folder_id: ::String
|
226
|
+
SENSITIVE: [:authentication_token]
|
227
|
+
end
|
228
|
+
|
229
|
+
class DeleteFolderRequest
|
230
|
+
attr_accessor authentication_token: ::String
|
231
|
+
attr_accessor folder_id: ::String
|
232
|
+
SENSITIVE: [:authentication_token]
|
233
|
+
end
|
234
|
+
|
235
|
+
class DeleteLabelsRequest
|
236
|
+
attr_accessor resource_id: ::String
|
237
|
+
attr_accessor authentication_token: ::String
|
238
|
+
attr_accessor labels: ::Array[::String]
|
239
|
+
attr_accessor delete_all: bool
|
240
|
+
SENSITIVE: [:authentication_token]
|
241
|
+
end
|
242
|
+
|
243
|
+
class DeleteLabelsResponse < Aws::EmptyStructure
|
244
|
+
end
|
245
|
+
|
246
|
+
class DeleteNotificationSubscriptionRequest
|
247
|
+
attr_accessor subscription_id: ::String
|
248
|
+
attr_accessor organization_id: ::String
|
249
|
+
SENSITIVE: []
|
250
|
+
end
|
251
|
+
|
252
|
+
class DeleteUserRequest
|
253
|
+
attr_accessor authentication_token: ::String
|
254
|
+
attr_accessor user_id: ::String
|
255
|
+
SENSITIVE: [:authentication_token]
|
256
|
+
end
|
257
|
+
|
258
|
+
class DescribeActivitiesRequest
|
259
|
+
attr_accessor authentication_token: ::String
|
260
|
+
attr_accessor start_time: ::Time
|
261
|
+
attr_accessor end_time: ::Time
|
262
|
+
attr_accessor organization_id: ::String
|
263
|
+
attr_accessor activity_types: ::String
|
264
|
+
attr_accessor resource_id: ::String
|
265
|
+
attr_accessor user_id: ::String
|
266
|
+
attr_accessor include_indirect_activities: bool
|
267
|
+
attr_accessor limit: ::Integer
|
268
|
+
attr_accessor marker: ::String
|
269
|
+
SENSITIVE: [:authentication_token]
|
270
|
+
end
|
271
|
+
|
272
|
+
class DescribeActivitiesResponse
|
273
|
+
attr_accessor user_activities: ::Array[Types::Activity]
|
274
|
+
attr_accessor marker: ::String
|
275
|
+
SENSITIVE: []
|
276
|
+
end
|
277
|
+
|
278
|
+
class DescribeCommentsRequest
|
279
|
+
attr_accessor authentication_token: ::String
|
280
|
+
attr_accessor document_id: ::String
|
281
|
+
attr_accessor version_id: ::String
|
282
|
+
attr_accessor limit: ::Integer
|
283
|
+
attr_accessor marker: ::String
|
284
|
+
SENSITIVE: [:authentication_token]
|
285
|
+
end
|
286
|
+
|
287
|
+
class DescribeCommentsResponse
|
288
|
+
attr_accessor comments: ::Array[Types::Comment]
|
289
|
+
attr_accessor marker: ::String
|
290
|
+
SENSITIVE: []
|
291
|
+
end
|
292
|
+
|
293
|
+
class DescribeDocumentVersionsRequest
|
294
|
+
attr_accessor authentication_token: ::String
|
295
|
+
attr_accessor document_id: ::String
|
296
|
+
attr_accessor marker: ::String
|
297
|
+
attr_accessor limit: ::Integer
|
298
|
+
attr_accessor include: ::String
|
299
|
+
attr_accessor fields: ::String
|
300
|
+
SENSITIVE: [:authentication_token]
|
301
|
+
end
|
302
|
+
|
303
|
+
class DescribeDocumentVersionsResponse
|
304
|
+
attr_accessor document_versions: ::Array[Types::DocumentVersionMetadata]
|
305
|
+
attr_accessor marker: ::String
|
306
|
+
SENSITIVE: []
|
307
|
+
end
|
308
|
+
|
309
|
+
class DescribeFolderContentsRequest
|
310
|
+
attr_accessor authentication_token: ::String
|
311
|
+
attr_accessor folder_id: ::String
|
312
|
+
attr_accessor sort: ("DATE" | "NAME")
|
313
|
+
attr_accessor order: ("ASCENDING" | "DESCENDING")
|
314
|
+
attr_accessor limit: ::Integer
|
315
|
+
attr_accessor marker: ::String
|
316
|
+
attr_accessor type: ("ALL" | "DOCUMENT" | "FOLDER")
|
317
|
+
attr_accessor include: ::String
|
318
|
+
SENSITIVE: [:authentication_token]
|
319
|
+
end
|
320
|
+
|
321
|
+
class DescribeFolderContentsResponse
|
322
|
+
attr_accessor folders: ::Array[Types::FolderMetadata]
|
323
|
+
attr_accessor documents: ::Array[Types::DocumentMetadata]
|
324
|
+
attr_accessor marker: ::String
|
325
|
+
SENSITIVE: []
|
326
|
+
end
|
327
|
+
|
328
|
+
class DescribeGroupsRequest
|
329
|
+
attr_accessor authentication_token: ::String
|
330
|
+
attr_accessor search_query: ::String
|
331
|
+
attr_accessor organization_id: ::String
|
332
|
+
attr_accessor marker: ::String
|
333
|
+
attr_accessor limit: ::Integer
|
334
|
+
SENSITIVE: [:authentication_token, :search_query]
|
335
|
+
end
|
336
|
+
|
337
|
+
class DescribeGroupsResponse
|
338
|
+
attr_accessor groups: ::Array[Types::GroupMetadata]
|
339
|
+
attr_accessor marker: ::String
|
340
|
+
SENSITIVE: []
|
341
|
+
end
|
342
|
+
|
343
|
+
class DescribeNotificationSubscriptionsRequest
|
344
|
+
attr_accessor organization_id: ::String
|
345
|
+
attr_accessor marker: ::String
|
346
|
+
attr_accessor limit: ::Integer
|
347
|
+
SENSITIVE: []
|
348
|
+
end
|
349
|
+
|
350
|
+
class DescribeNotificationSubscriptionsResponse
|
351
|
+
attr_accessor subscriptions: ::Array[Types::Subscription]
|
352
|
+
attr_accessor marker: ::String
|
353
|
+
SENSITIVE: []
|
354
|
+
end
|
355
|
+
|
356
|
+
class DescribeResourcePermissionsRequest
|
357
|
+
attr_accessor authentication_token: ::String
|
358
|
+
attr_accessor resource_id: ::String
|
359
|
+
attr_accessor principal_id: ::String
|
360
|
+
attr_accessor limit: ::Integer
|
361
|
+
attr_accessor marker: ::String
|
362
|
+
SENSITIVE: [:authentication_token]
|
363
|
+
end
|
364
|
+
|
365
|
+
class DescribeResourcePermissionsResponse
|
366
|
+
attr_accessor principals: ::Array[Types::Principal]
|
367
|
+
attr_accessor marker: ::String
|
368
|
+
SENSITIVE: []
|
369
|
+
end
|
370
|
+
|
371
|
+
class DescribeRootFoldersRequest
|
372
|
+
attr_accessor authentication_token: ::String
|
373
|
+
attr_accessor limit: ::Integer
|
374
|
+
attr_accessor marker: ::String
|
375
|
+
SENSITIVE: [:authentication_token]
|
376
|
+
end
|
377
|
+
|
378
|
+
class DescribeRootFoldersResponse
|
379
|
+
attr_accessor folders: ::Array[Types::FolderMetadata]
|
380
|
+
attr_accessor marker: ::String
|
381
|
+
SENSITIVE: []
|
382
|
+
end
|
383
|
+
|
384
|
+
class DescribeUsersRequest
|
385
|
+
attr_accessor authentication_token: ::String
|
386
|
+
attr_accessor organization_id: ::String
|
387
|
+
attr_accessor user_ids: ::String
|
388
|
+
attr_accessor query: ::String
|
389
|
+
attr_accessor include: ("ALL" | "ACTIVE_PENDING")
|
390
|
+
attr_accessor order: ("ASCENDING" | "DESCENDING")
|
391
|
+
attr_accessor sort: ("USER_NAME" | "FULL_NAME" | "STORAGE_LIMIT" | "USER_STATUS" | "STORAGE_USED")
|
392
|
+
attr_accessor marker: ::String
|
393
|
+
attr_accessor limit: ::Integer
|
394
|
+
attr_accessor fields: ::String
|
395
|
+
SENSITIVE: [:authentication_token, :query]
|
396
|
+
end
|
397
|
+
|
398
|
+
class DescribeUsersResponse
|
399
|
+
attr_accessor users: ::Array[Types::User]
|
400
|
+
attr_accessor total_number_of_users: ::Integer
|
401
|
+
attr_accessor marker: ::String
|
402
|
+
SENSITIVE: []
|
403
|
+
end
|
404
|
+
|
405
|
+
class DocumentLockedForCommentsException
|
406
|
+
attr_accessor message: ::String
|
407
|
+
SENSITIVE: []
|
408
|
+
end
|
409
|
+
|
410
|
+
class DocumentMetadata
|
411
|
+
attr_accessor id: ::String
|
412
|
+
attr_accessor creator_id: ::String
|
413
|
+
attr_accessor parent_folder_id: ::String
|
414
|
+
attr_accessor created_timestamp: ::Time
|
415
|
+
attr_accessor modified_timestamp: ::Time
|
416
|
+
attr_accessor latest_version_metadata: Types::DocumentVersionMetadata
|
417
|
+
attr_accessor resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
418
|
+
attr_accessor labels: ::Array[::String]
|
419
|
+
SENSITIVE: []
|
420
|
+
end
|
421
|
+
|
422
|
+
class DocumentVersionMetadata
|
423
|
+
attr_accessor id: ::String
|
424
|
+
attr_accessor name: ::String
|
425
|
+
attr_accessor content_type: ::String
|
426
|
+
attr_accessor size: ::Integer
|
427
|
+
attr_accessor signature: ::String
|
428
|
+
attr_accessor status: ("INITIALIZED" | "ACTIVE")
|
429
|
+
attr_accessor created_timestamp: ::Time
|
430
|
+
attr_accessor modified_timestamp: ::Time
|
431
|
+
attr_accessor content_created_timestamp: ::Time
|
432
|
+
attr_accessor content_modified_timestamp: ::Time
|
433
|
+
attr_accessor creator_id: ::String
|
434
|
+
attr_accessor thumbnail: ::Hash[("SMALL" | "SMALL_HQ" | "LARGE"), ::String]
|
435
|
+
attr_accessor source: ::Hash[("ORIGINAL" | "WITH_COMMENTS"), ::String]
|
436
|
+
SENSITIVE: [:name]
|
437
|
+
end
|
438
|
+
|
439
|
+
class DraftUploadOutOfSyncException
|
440
|
+
attr_accessor message: ::String
|
441
|
+
SENSITIVE: []
|
442
|
+
end
|
443
|
+
|
444
|
+
class EntityAlreadyExistsException
|
445
|
+
attr_accessor message: ::String
|
446
|
+
SENSITIVE: []
|
447
|
+
end
|
448
|
+
|
449
|
+
class EntityNotExistsException
|
450
|
+
attr_accessor message: ::String
|
451
|
+
attr_accessor entity_ids: ::Array[::String]
|
452
|
+
SENSITIVE: []
|
453
|
+
end
|
454
|
+
|
455
|
+
class FailedDependencyException
|
456
|
+
attr_accessor message: ::String
|
457
|
+
SENSITIVE: []
|
458
|
+
end
|
459
|
+
|
460
|
+
class Filters
|
461
|
+
attr_accessor text_locales: ::Array[("AR" | "BG" | "BN" | "DA" | "DE" | "CS" | "EL" | "EN" | "ES" | "FA" | "FI" | "FR" | "HI" | "HU" | "ID" | "IT" | "JA" | "KO" | "LT" | "LV" | "NL" | "NO" | "PT" | "RO" | "RU" | "SV" | "SW" | "TH" | "TR" | "ZH" | "DEFAULT")]
|
462
|
+
attr_accessor content_categories: ::Array[("IMAGE" | "DOCUMENT" | "PDF" | "SPREADSHEET" | "PRESENTATION" | "AUDIO" | "VIDEO" | "SOURCE_CODE" | "OTHER")]
|
463
|
+
attr_accessor resource_types: ::Array[("FOLDER" | "DOCUMENT" | "COMMENT" | "DOCUMENT_VERSION")]
|
464
|
+
attr_accessor labels: ::Array[::String]
|
465
|
+
attr_accessor principals: ::Array[Types::SearchPrincipalType]
|
466
|
+
attr_accessor ancestor_ids: ::Array[::String]
|
467
|
+
attr_accessor search_collection_types: ::Array[("OWNED" | "SHARED_WITH_ME")]
|
468
|
+
attr_accessor size_range: Types::LongRangeType
|
469
|
+
attr_accessor created_range: Types::DateRangeType
|
470
|
+
attr_accessor modified_range: Types::DateRangeType
|
471
|
+
SENSITIVE: []
|
472
|
+
end
|
473
|
+
|
474
|
+
class FolderMetadata
|
475
|
+
attr_accessor id: ::String
|
476
|
+
attr_accessor name: ::String
|
477
|
+
attr_accessor creator_id: ::String
|
478
|
+
attr_accessor parent_folder_id: ::String
|
479
|
+
attr_accessor created_timestamp: ::Time
|
480
|
+
attr_accessor modified_timestamp: ::Time
|
481
|
+
attr_accessor resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
482
|
+
attr_accessor signature: ::String
|
483
|
+
attr_accessor labels: ::Array[::String]
|
484
|
+
attr_accessor size: ::Integer
|
485
|
+
attr_accessor latest_version_size: ::Integer
|
486
|
+
SENSITIVE: [:name]
|
487
|
+
end
|
488
|
+
|
489
|
+
class GetCurrentUserRequest
|
490
|
+
attr_accessor authentication_token: ::String
|
491
|
+
SENSITIVE: [:authentication_token]
|
492
|
+
end
|
493
|
+
|
494
|
+
class GetCurrentUserResponse
|
495
|
+
attr_accessor user: Types::User
|
496
|
+
SENSITIVE: []
|
497
|
+
end
|
498
|
+
|
499
|
+
class GetDocumentPathRequest
|
500
|
+
attr_accessor authentication_token: ::String
|
501
|
+
attr_accessor document_id: ::String
|
502
|
+
attr_accessor limit: ::Integer
|
503
|
+
attr_accessor fields: ::String
|
504
|
+
attr_accessor marker: ::String
|
505
|
+
SENSITIVE: [:authentication_token]
|
506
|
+
end
|
507
|
+
|
508
|
+
class GetDocumentPathResponse
|
509
|
+
attr_accessor path: Types::ResourcePath
|
510
|
+
SENSITIVE: []
|
511
|
+
end
|
512
|
+
|
513
|
+
class GetDocumentRequest
|
514
|
+
attr_accessor authentication_token: ::String
|
515
|
+
attr_accessor document_id: ::String
|
516
|
+
attr_accessor include_custom_metadata: bool
|
517
|
+
SENSITIVE: [:authentication_token]
|
518
|
+
end
|
519
|
+
|
520
|
+
class GetDocumentResponse
|
521
|
+
attr_accessor metadata: Types::DocumentMetadata
|
522
|
+
attr_accessor custom_metadata: ::Hash[::String, ::String]
|
523
|
+
SENSITIVE: []
|
524
|
+
end
|
525
|
+
|
526
|
+
class GetDocumentVersionRequest
|
527
|
+
attr_accessor authentication_token: ::String
|
528
|
+
attr_accessor document_id: ::String
|
529
|
+
attr_accessor version_id: ::String
|
530
|
+
attr_accessor fields: ::String
|
531
|
+
attr_accessor include_custom_metadata: bool
|
532
|
+
SENSITIVE: [:authentication_token]
|
533
|
+
end
|
534
|
+
|
535
|
+
class GetDocumentVersionResponse
|
536
|
+
attr_accessor metadata: Types::DocumentVersionMetadata
|
537
|
+
attr_accessor custom_metadata: ::Hash[::String, ::String]
|
538
|
+
SENSITIVE: []
|
539
|
+
end
|
540
|
+
|
541
|
+
class GetFolderPathRequest
|
542
|
+
attr_accessor authentication_token: ::String
|
543
|
+
attr_accessor folder_id: ::String
|
544
|
+
attr_accessor limit: ::Integer
|
545
|
+
attr_accessor fields: ::String
|
546
|
+
attr_accessor marker: ::String
|
547
|
+
SENSITIVE: [:authentication_token]
|
548
|
+
end
|
549
|
+
|
550
|
+
class GetFolderPathResponse
|
551
|
+
attr_accessor path: Types::ResourcePath
|
552
|
+
SENSITIVE: []
|
553
|
+
end
|
554
|
+
|
555
|
+
class GetFolderRequest
|
556
|
+
attr_accessor authentication_token: ::String
|
557
|
+
attr_accessor folder_id: ::String
|
558
|
+
attr_accessor include_custom_metadata: bool
|
559
|
+
SENSITIVE: [:authentication_token]
|
560
|
+
end
|
561
|
+
|
562
|
+
class GetFolderResponse
|
563
|
+
attr_accessor metadata: Types::FolderMetadata
|
564
|
+
attr_accessor custom_metadata: ::Hash[::String, ::String]
|
565
|
+
SENSITIVE: []
|
566
|
+
end
|
567
|
+
|
568
|
+
class GetResourcesRequest
|
569
|
+
attr_accessor authentication_token: ::String
|
570
|
+
attr_accessor user_id: ::String
|
571
|
+
attr_accessor collection_type: ("SHARED_WITH_ME")
|
572
|
+
attr_accessor limit: ::Integer
|
573
|
+
attr_accessor marker: ::String
|
574
|
+
SENSITIVE: [:authentication_token]
|
575
|
+
end
|
576
|
+
|
577
|
+
class GetResourcesResponse
|
578
|
+
attr_accessor folders: ::Array[Types::FolderMetadata]
|
579
|
+
attr_accessor documents: ::Array[Types::DocumentMetadata]
|
580
|
+
attr_accessor marker: ::String
|
581
|
+
SENSITIVE: []
|
582
|
+
end
|
583
|
+
|
584
|
+
class GroupMetadata
|
585
|
+
attr_accessor id: ::String
|
586
|
+
attr_accessor name: ::String
|
587
|
+
SENSITIVE: []
|
588
|
+
end
|
589
|
+
|
590
|
+
class IllegalUserStateException
|
591
|
+
attr_accessor message: ::String
|
592
|
+
SENSITIVE: []
|
593
|
+
end
|
594
|
+
|
595
|
+
class InitiateDocumentVersionUploadRequest
|
596
|
+
attr_accessor authentication_token: ::String
|
597
|
+
attr_accessor id: ::String
|
598
|
+
attr_accessor name: ::String
|
599
|
+
attr_accessor content_created_timestamp: ::Time
|
600
|
+
attr_accessor content_modified_timestamp: ::Time
|
601
|
+
attr_accessor content_type: ::String
|
602
|
+
attr_accessor document_size_in_bytes: ::Integer
|
603
|
+
attr_accessor parent_folder_id: ::String
|
604
|
+
SENSITIVE: [:authentication_token, :name]
|
605
|
+
end
|
606
|
+
|
607
|
+
class InitiateDocumentVersionUploadResponse
|
608
|
+
attr_accessor metadata: Types::DocumentMetadata
|
609
|
+
attr_accessor upload_metadata: Types::UploadMetadata
|
610
|
+
SENSITIVE: []
|
611
|
+
end
|
612
|
+
|
613
|
+
class InvalidArgumentException
|
614
|
+
attr_accessor message: ::String
|
615
|
+
SENSITIVE: []
|
616
|
+
end
|
617
|
+
|
618
|
+
class InvalidCommentOperationException
|
619
|
+
attr_accessor message: ::String
|
620
|
+
SENSITIVE: []
|
621
|
+
end
|
622
|
+
|
623
|
+
class InvalidOperationException
|
624
|
+
attr_accessor message: ::String
|
625
|
+
SENSITIVE: []
|
626
|
+
end
|
627
|
+
|
628
|
+
class InvalidPasswordException
|
629
|
+
attr_accessor message: ::String
|
630
|
+
SENSITIVE: []
|
631
|
+
end
|
632
|
+
|
633
|
+
class LimitExceededException
|
634
|
+
attr_accessor message: ::String
|
635
|
+
SENSITIVE: []
|
636
|
+
end
|
637
|
+
|
638
|
+
class LongRangeType
|
639
|
+
attr_accessor start_value: ::Integer
|
640
|
+
attr_accessor end_value: ::Integer
|
641
|
+
SENSITIVE: []
|
642
|
+
end
|
643
|
+
|
644
|
+
class NotificationOptions
|
645
|
+
attr_accessor send_email: bool
|
646
|
+
attr_accessor email_message: ::String
|
647
|
+
SENSITIVE: [:email_message]
|
648
|
+
end
|
649
|
+
|
650
|
+
class Participants
|
651
|
+
attr_accessor users: ::Array[Types::UserMetadata]
|
652
|
+
attr_accessor groups: ::Array[Types::GroupMetadata]
|
653
|
+
SENSITIVE: []
|
654
|
+
end
|
655
|
+
|
656
|
+
class PermissionInfo
|
657
|
+
attr_accessor role: ("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")
|
658
|
+
attr_accessor type: ("DIRECT" | "INHERITED")
|
659
|
+
SENSITIVE: []
|
660
|
+
end
|
661
|
+
|
662
|
+
class Principal
|
663
|
+
attr_accessor id: ::String
|
664
|
+
attr_accessor type: ("USER" | "GROUP" | "INVITE" | "ANONYMOUS" | "ORGANIZATION")
|
665
|
+
attr_accessor roles: ::Array[Types::PermissionInfo]
|
666
|
+
SENSITIVE: []
|
667
|
+
end
|
668
|
+
|
669
|
+
class ProhibitedStateException
|
670
|
+
attr_accessor message: ::String
|
671
|
+
SENSITIVE: []
|
672
|
+
end
|
673
|
+
|
674
|
+
class RemoveAllResourcePermissionsRequest
|
675
|
+
attr_accessor authentication_token: ::String
|
676
|
+
attr_accessor resource_id: ::String
|
677
|
+
SENSITIVE: [:authentication_token]
|
678
|
+
end
|
679
|
+
|
680
|
+
class RemoveResourcePermissionRequest
|
681
|
+
attr_accessor authentication_token: ::String
|
682
|
+
attr_accessor resource_id: ::String
|
683
|
+
attr_accessor principal_id: ::String
|
684
|
+
attr_accessor principal_type: ("USER" | "GROUP" | "INVITE" | "ANONYMOUS" | "ORGANIZATION")
|
685
|
+
SENSITIVE: [:authentication_token]
|
686
|
+
end
|
687
|
+
|
688
|
+
class RequestedEntityTooLargeException
|
689
|
+
attr_accessor message: ::String
|
690
|
+
SENSITIVE: []
|
691
|
+
end
|
692
|
+
|
693
|
+
class ResourceAlreadyCheckedOutException
|
694
|
+
attr_accessor message: ::String
|
695
|
+
SENSITIVE: []
|
696
|
+
end
|
697
|
+
|
698
|
+
class ResourceMetadata
|
699
|
+
attr_accessor type: ("FOLDER" | "DOCUMENT")
|
700
|
+
attr_accessor name: ::String
|
701
|
+
attr_accessor original_name: ::String
|
702
|
+
attr_accessor id: ::String
|
703
|
+
attr_accessor version_id: ::String
|
704
|
+
attr_accessor owner: Types::UserMetadata
|
705
|
+
attr_accessor parent_id: ::String
|
706
|
+
SENSITIVE: [:name, :original_name]
|
707
|
+
end
|
708
|
+
|
709
|
+
class ResourcePath
|
710
|
+
attr_accessor components: ::Array[Types::ResourcePathComponent]
|
711
|
+
SENSITIVE: []
|
712
|
+
end
|
713
|
+
|
714
|
+
class ResourcePathComponent
|
715
|
+
attr_accessor id: ::String
|
716
|
+
attr_accessor name: ::String
|
717
|
+
SENSITIVE: [:name]
|
718
|
+
end
|
719
|
+
|
720
|
+
class ResponseItem
|
721
|
+
attr_accessor resource_type: ("DOCUMENT" | "FOLDER" | "COMMENT" | "DOCUMENT_VERSION")
|
722
|
+
attr_accessor web_url: ::String
|
723
|
+
attr_accessor document_metadata: Types::DocumentMetadata
|
724
|
+
attr_accessor folder_metadata: Types::FolderMetadata
|
725
|
+
attr_accessor comment_metadata: Types::CommentMetadata
|
726
|
+
attr_accessor document_version_metadata: Types::DocumentVersionMetadata
|
727
|
+
SENSITIVE: [:web_url]
|
728
|
+
end
|
729
|
+
|
730
|
+
class RestoreDocumentVersionsRequest
|
731
|
+
attr_accessor authentication_token: ::String
|
732
|
+
attr_accessor document_id: ::String
|
733
|
+
SENSITIVE: [:authentication_token]
|
734
|
+
end
|
735
|
+
|
736
|
+
class SearchPrincipalType
|
737
|
+
attr_accessor id: ::String
|
738
|
+
attr_accessor roles: ::Array[("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")]
|
739
|
+
SENSITIVE: []
|
740
|
+
end
|
741
|
+
|
742
|
+
class SearchResourcesRequest
|
743
|
+
attr_accessor authentication_token: ::String
|
744
|
+
attr_accessor query_text: ::String
|
745
|
+
attr_accessor query_scopes: ::Array[("NAME" | "CONTENT")]
|
746
|
+
attr_accessor organization_id: ::String
|
747
|
+
attr_accessor additional_response_fields: ::Array[("WEBURL")]
|
748
|
+
attr_accessor filters: Types::Filters
|
749
|
+
attr_accessor order_by: ::Array[Types::SearchSortResult]
|
750
|
+
attr_accessor limit: ::Integer
|
751
|
+
attr_accessor marker: ::String
|
752
|
+
SENSITIVE: [:authentication_token, :query_text]
|
753
|
+
end
|
754
|
+
|
755
|
+
class SearchResourcesResponse
|
756
|
+
attr_accessor items: ::Array[Types::ResponseItem]
|
757
|
+
attr_accessor marker: ::String
|
758
|
+
SENSITIVE: []
|
759
|
+
end
|
760
|
+
|
761
|
+
class SearchSortResult
|
762
|
+
attr_accessor field: ("RELEVANCE" | "NAME" | "SIZE" | "CREATED_TIMESTAMP" | "MODIFIED_TIMESTAMP")
|
763
|
+
attr_accessor order: ("ASC" | "DESC")
|
764
|
+
SENSITIVE: []
|
765
|
+
end
|
766
|
+
|
767
|
+
class ServiceUnavailableException
|
768
|
+
attr_accessor message: ::String
|
769
|
+
SENSITIVE: []
|
770
|
+
end
|
771
|
+
|
772
|
+
class SharePrincipal
|
773
|
+
attr_accessor id: ::String
|
774
|
+
attr_accessor type: ("USER" | "GROUP" | "INVITE" | "ANONYMOUS" | "ORGANIZATION")
|
775
|
+
attr_accessor role: ("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")
|
776
|
+
SENSITIVE: []
|
777
|
+
end
|
778
|
+
|
779
|
+
class ShareResult
|
780
|
+
attr_accessor principal_id: ::String
|
781
|
+
attr_accessor invitee_principal_id: ::String
|
782
|
+
attr_accessor role: ("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")
|
783
|
+
attr_accessor status: ("SUCCESS" | "FAILURE")
|
784
|
+
attr_accessor share_id: ::String
|
785
|
+
attr_accessor status_message: ::String
|
786
|
+
SENSITIVE: [:status_message]
|
787
|
+
end
|
788
|
+
|
789
|
+
class StorageLimitExceededException
|
790
|
+
attr_accessor message: ::String
|
791
|
+
SENSITIVE: []
|
792
|
+
end
|
793
|
+
|
794
|
+
class StorageLimitWillExceedException
|
795
|
+
attr_accessor message: ::String
|
796
|
+
SENSITIVE: []
|
797
|
+
end
|
798
|
+
|
799
|
+
class StorageRuleType
|
800
|
+
attr_accessor storage_allocated_in_bytes: ::Integer
|
801
|
+
attr_accessor storage_type: ("UNLIMITED" | "QUOTA")
|
802
|
+
SENSITIVE: []
|
803
|
+
end
|
804
|
+
|
805
|
+
class Subscription
|
806
|
+
attr_accessor subscription_id: ::String
|
807
|
+
attr_accessor end_point: ::String
|
808
|
+
attr_accessor protocol: ("HTTPS" | "SQS")
|
809
|
+
SENSITIVE: []
|
810
|
+
end
|
811
|
+
|
812
|
+
class TooManyLabelsException
|
813
|
+
attr_accessor message: ::String
|
814
|
+
SENSITIVE: []
|
815
|
+
end
|
816
|
+
|
817
|
+
class TooManySubscriptionsException
|
818
|
+
attr_accessor message: ::String
|
819
|
+
SENSITIVE: []
|
820
|
+
end
|
821
|
+
|
822
|
+
class UnauthorizedOperationException < Aws::EmptyStructure
|
823
|
+
end
|
824
|
+
|
825
|
+
class UnauthorizedResourceAccessException
|
826
|
+
attr_accessor message: ::String
|
827
|
+
SENSITIVE: []
|
828
|
+
end
|
829
|
+
|
830
|
+
class UpdateDocumentRequest
|
831
|
+
attr_accessor authentication_token: ::String
|
832
|
+
attr_accessor document_id: ::String
|
833
|
+
attr_accessor name: ::String
|
834
|
+
attr_accessor parent_folder_id: ::String
|
835
|
+
attr_accessor resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
836
|
+
SENSITIVE: [:authentication_token, :name]
|
837
|
+
end
|
838
|
+
|
839
|
+
class UpdateDocumentVersionRequest
|
840
|
+
attr_accessor authentication_token: ::String
|
841
|
+
attr_accessor document_id: ::String
|
842
|
+
attr_accessor version_id: ::String
|
843
|
+
attr_accessor version_status: ("ACTIVE")
|
844
|
+
SENSITIVE: [:authentication_token]
|
845
|
+
end
|
846
|
+
|
847
|
+
class UpdateFolderRequest
|
848
|
+
attr_accessor authentication_token: ::String
|
849
|
+
attr_accessor folder_id: ::String
|
850
|
+
attr_accessor name: ::String
|
851
|
+
attr_accessor parent_folder_id: ::String
|
852
|
+
attr_accessor resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
853
|
+
SENSITIVE: [:authentication_token, :name]
|
854
|
+
end
|
855
|
+
|
856
|
+
class UpdateUserRequest
|
857
|
+
attr_accessor authentication_token: ::String
|
858
|
+
attr_accessor user_id: ::String
|
859
|
+
attr_accessor given_name: ::String
|
860
|
+
attr_accessor surname: ::String
|
861
|
+
attr_accessor type: ("USER" | "ADMIN" | "POWERUSER" | "MINIMALUSER" | "WORKSPACESUSER")
|
862
|
+
attr_accessor storage_rule: Types::StorageRuleType
|
863
|
+
attr_accessor time_zone_id: ::String
|
864
|
+
attr_accessor locale: ("en" | "fr" | "ko" | "de" | "es" | "ja" | "ru" | "zh_CN" | "zh_TW" | "pt_BR" | "default")
|
865
|
+
attr_accessor grant_poweruser_privileges: ("TRUE" | "FALSE")
|
866
|
+
SENSITIVE: [:authentication_token, :given_name, :surname]
|
867
|
+
end
|
868
|
+
|
869
|
+
class UpdateUserResponse
|
870
|
+
attr_accessor user: Types::User
|
871
|
+
SENSITIVE: []
|
872
|
+
end
|
873
|
+
|
874
|
+
class UploadMetadata
|
875
|
+
attr_accessor upload_url: ::String
|
876
|
+
attr_accessor signed_headers: ::Hash[::String, ::String]
|
877
|
+
SENSITIVE: [:upload_url]
|
878
|
+
end
|
879
|
+
|
880
|
+
class User
|
881
|
+
attr_accessor id: ::String
|
882
|
+
attr_accessor username: ::String
|
883
|
+
attr_accessor email_address: ::String
|
884
|
+
attr_accessor given_name: ::String
|
885
|
+
attr_accessor surname: ::String
|
886
|
+
attr_accessor organization_id: ::String
|
887
|
+
attr_accessor root_folder_id: ::String
|
888
|
+
attr_accessor recycle_bin_folder_id: ::String
|
889
|
+
attr_accessor status: ("ACTIVE" | "INACTIVE" | "PENDING")
|
890
|
+
attr_accessor type: ("USER" | "ADMIN" | "POWERUSER" | "MINIMALUSER" | "WORKSPACESUSER")
|
891
|
+
attr_accessor created_timestamp: ::Time
|
892
|
+
attr_accessor modified_timestamp: ::Time
|
893
|
+
attr_accessor time_zone_id: ::String
|
894
|
+
attr_accessor locale: ("en" | "fr" | "ko" | "de" | "es" | "ja" | "ru" | "zh_CN" | "zh_TW" | "pt_BR" | "default")
|
895
|
+
attr_accessor storage: Types::UserStorageMetadata
|
896
|
+
SENSITIVE: [:username, :email_address, :given_name, :surname]
|
897
|
+
end
|
898
|
+
|
899
|
+
class UserMetadata
|
900
|
+
attr_accessor id: ::String
|
901
|
+
attr_accessor username: ::String
|
902
|
+
attr_accessor given_name: ::String
|
903
|
+
attr_accessor surname: ::String
|
904
|
+
attr_accessor email_address: ::String
|
905
|
+
SENSITIVE: [:username, :given_name, :surname, :email_address]
|
906
|
+
end
|
907
|
+
|
908
|
+
class UserStorageMetadata
|
909
|
+
attr_accessor storage_utilized_in_bytes: ::Integer
|
910
|
+
attr_accessor storage_rule: Types::StorageRuleType
|
911
|
+
SENSITIVE: []
|
912
|
+
end
|
913
|
+
end
|
914
|
+
end
|