aws-sdk-workdocs 1.0.0.rc1
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 +7 -0
- data/lib/aws-sdk-workdocs.rb +47 -0
- data/lib/aws-sdk-workdocs/client.rb +1486 -0
- data/lib/aws-sdk-workdocs/client_api.rb +922 -0
- data/lib/aws-sdk-workdocs/customizations.rb +0 -0
- data/lib/aws-sdk-workdocs/errors.rb +14 -0
- data/lib/aws-sdk-workdocs/resource.rb +23 -0
- data/lib/aws-sdk-workdocs/types.rb +1656 -0
- metadata +80 -0
File without changes
|
@@ -0,0 +1,14 @@
|
|
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/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkDocs
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
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/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkDocs
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1656 @@
|
|
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/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::WorkDocs
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass AbortDocumentVersionUploadRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# document_id: "ResourceIdType", # required
|
16
|
+
# version_id: "DocumentVersionIdType", # required
|
17
|
+
# }
|
18
|
+
#
|
19
|
+
# @!attribute [rw] document_id
|
20
|
+
# The ID of the document.
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @!attribute [rw] version_id
|
24
|
+
# The ID of the version.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AbortDocumentVersionUploadRequest AWS API Documentation
|
28
|
+
#
|
29
|
+
class AbortDocumentVersionUploadRequest < Struct.new(
|
30
|
+
:document_id,
|
31
|
+
:version_id)
|
32
|
+
include Aws::Structure
|
33
|
+
end
|
34
|
+
|
35
|
+
# @note When making an API call, you may pass ActivateUserRequest
|
36
|
+
# data as a hash:
|
37
|
+
#
|
38
|
+
# {
|
39
|
+
# user_id: "IdType", # required
|
40
|
+
# }
|
41
|
+
#
|
42
|
+
# @!attribute [rw] user_id
|
43
|
+
# The ID of the user.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest AWS API Documentation
|
47
|
+
#
|
48
|
+
class ActivateUserRequest < Struct.new(
|
49
|
+
:user_id)
|
50
|
+
include Aws::Structure
|
51
|
+
end
|
52
|
+
|
53
|
+
# @!attribute [rw] user
|
54
|
+
# The user information.
|
55
|
+
# @return [Types::User]
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserResponse AWS API Documentation
|
58
|
+
#
|
59
|
+
class ActivateUserResponse < Struct.new(
|
60
|
+
:user)
|
61
|
+
include Aws::Structure
|
62
|
+
end
|
63
|
+
|
64
|
+
# @note When making an API call, you may pass AddResourcePermissionsRequest
|
65
|
+
# data as a hash:
|
66
|
+
#
|
67
|
+
# {
|
68
|
+
# resource_id: "ResourceIdType", # required
|
69
|
+
# principals: [ # required
|
70
|
+
# {
|
71
|
+
# id: "IdType", # required
|
72
|
+
# type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
73
|
+
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
74
|
+
# },
|
75
|
+
# ],
|
76
|
+
# }
|
77
|
+
#
|
78
|
+
# @!attribute [rw] resource_id
|
79
|
+
# The ID of the resource.
|
80
|
+
# @return [String]
|
81
|
+
#
|
82
|
+
# @!attribute [rw] principals
|
83
|
+
# The users, groups, or organization being granted permission.
|
84
|
+
# @return [Array<Types::SharePrincipal>]
|
85
|
+
#
|
86
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsRequest AWS API Documentation
|
87
|
+
#
|
88
|
+
class AddResourcePermissionsRequest < Struct.new(
|
89
|
+
:resource_id,
|
90
|
+
:principals)
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
93
|
+
|
94
|
+
# @!attribute [rw] share_results
|
95
|
+
# The share results.
|
96
|
+
# @return [Array<Types::ShareResult>]
|
97
|
+
#
|
98
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/AddResourcePermissionsResponse AWS API Documentation
|
99
|
+
#
|
100
|
+
class AddResourcePermissionsResponse < Struct.new(
|
101
|
+
:share_results)
|
102
|
+
include Aws::Structure
|
103
|
+
end
|
104
|
+
|
105
|
+
# @note When making an API call, you may pass CreateFolderRequest
|
106
|
+
# data as a hash:
|
107
|
+
#
|
108
|
+
# {
|
109
|
+
# name: "ResourceNameType",
|
110
|
+
# parent_folder_id: "ResourceIdType", # required
|
111
|
+
# }
|
112
|
+
#
|
113
|
+
# @!attribute [rw] name
|
114
|
+
# The name of the new folder.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] parent_folder_id
|
118
|
+
# The ID of the parent folder.
|
119
|
+
# @return [String]
|
120
|
+
#
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolderRequest AWS API Documentation
|
122
|
+
#
|
123
|
+
class CreateFolderRequest < Struct.new(
|
124
|
+
:name,
|
125
|
+
:parent_folder_id)
|
126
|
+
include Aws::Structure
|
127
|
+
end
|
128
|
+
|
129
|
+
# @!attribute [rw] metadata
|
130
|
+
# The metadata of the folder.
|
131
|
+
# @return [Types::FolderMetadata]
|
132
|
+
#
|
133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateFolderResponse AWS API Documentation
|
134
|
+
#
|
135
|
+
class CreateFolderResponse < Struct.new(
|
136
|
+
:metadata)
|
137
|
+
include Aws::Structure
|
138
|
+
end
|
139
|
+
|
140
|
+
# @note When making an API call, you may pass CreateNotificationSubscriptionRequest
|
141
|
+
# data as a hash:
|
142
|
+
#
|
143
|
+
# {
|
144
|
+
# organization_id: "IdType", # required
|
145
|
+
# endpoint: "SubscriptionEndPointType", # required
|
146
|
+
# protocol: "HTTPS", # required, accepts HTTPS
|
147
|
+
# subscription_type: "ALL", # required, accepts ALL
|
148
|
+
# }
|
149
|
+
#
|
150
|
+
# @!attribute [rw] organization_id
|
151
|
+
# The ID of the organization.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] endpoint
|
155
|
+
# The endpoint to receive the notifications. If the protocol is HTTPS,
|
156
|
+
# the endpoint is a URL that begins with "https://".
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] protocol
|
160
|
+
# The protocol to use. The supported value is https, which delivers
|
161
|
+
# JSON-encoded messasges using HTTPS POST.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] subscription_type
|
165
|
+
# The notification type.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscriptionRequest AWS API Documentation
|
169
|
+
#
|
170
|
+
class CreateNotificationSubscriptionRequest < Struct.new(
|
171
|
+
:organization_id,
|
172
|
+
:endpoint,
|
173
|
+
:protocol,
|
174
|
+
:subscription_type)
|
175
|
+
include Aws::Structure
|
176
|
+
end
|
177
|
+
|
178
|
+
# @!attribute [rw] subscription
|
179
|
+
# The subscription.
|
180
|
+
# @return [Types::Subscription]
|
181
|
+
#
|
182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscriptionResponse AWS API Documentation
|
183
|
+
#
|
184
|
+
class CreateNotificationSubscriptionResponse < Struct.new(
|
185
|
+
:subscription)
|
186
|
+
include Aws::Structure
|
187
|
+
end
|
188
|
+
|
189
|
+
# @note When making an API call, you may pass CreateUserRequest
|
190
|
+
# data as a hash:
|
191
|
+
#
|
192
|
+
# {
|
193
|
+
# organization_id: "IdType",
|
194
|
+
# username: "UsernameType", # required
|
195
|
+
# given_name: "UserAttributeValueType", # required
|
196
|
+
# surname: "UserAttributeValueType", # required
|
197
|
+
# password: "PasswordType", # required
|
198
|
+
# time_zone_id: "TimeZoneIdType",
|
199
|
+
# storage_rule: {
|
200
|
+
# storage_allocated_in_bytes: 1,
|
201
|
+
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
202
|
+
# },
|
203
|
+
# }
|
204
|
+
#
|
205
|
+
# @!attribute [rw] organization_id
|
206
|
+
# The ID of the organization.
|
207
|
+
# @return [String]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] username
|
210
|
+
# The login name of the user.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] given_name
|
214
|
+
# The given name of the user.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] surname
|
218
|
+
# The surname of the user.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] password
|
222
|
+
# The password of the user.
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @!attribute [rw] time_zone_id
|
226
|
+
# The time zone ID of the user.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] storage_rule
|
230
|
+
# The amount of storage for the user.
|
231
|
+
# @return [Types::StorageRuleType]
|
232
|
+
#
|
233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest AWS API Documentation
|
234
|
+
#
|
235
|
+
class CreateUserRequest < Struct.new(
|
236
|
+
:organization_id,
|
237
|
+
:username,
|
238
|
+
:given_name,
|
239
|
+
:surname,
|
240
|
+
:password,
|
241
|
+
:time_zone_id,
|
242
|
+
:storage_rule)
|
243
|
+
include Aws::Structure
|
244
|
+
end
|
245
|
+
|
246
|
+
# @!attribute [rw] user
|
247
|
+
# The user information.
|
248
|
+
# @return [Types::User]
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserResponse AWS API Documentation
|
251
|
+
#
|
252
|
+
class CreateUserResponse < Struct.new(
|
253
|
+
:user)
|
254
|
+
include Aws::Structure
|
255
|
+
end
|
256
|
+
|
257
|
+
# @note When making an API call, you may pass DeactivateUserRequest
|
258
|
+
# data as a hash:
|
259
|
+
#
|
260
|
+
# {
|
261
|
+
# user_id: "IdType", # required
|
262
|
+
# }
|
263
|
+
#
|
264
|
+
# @!attribute [rw] user_id
|
265
|
+
# The ID of the user.
|
266
|
+
# @return [String]
|
267
|
+
#
|
268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest AWS API Documentation
|
269
|
+
#
|
270
|
+
class DeactivateUserRequest < Struct.new(
|
271
|
+
:user_id)
|
272
|
+
include Aws::Structure
|
273
|
+
end
|
274
|
+
|
275
|
+
# @note When making an API call, you may pass DeleteDocumentRequest
|
276
|
+
# data as a hash:
|
277
|
+
#
|
278
|
+
# {
|
279
|
+
# document_id: "ResourceIdType", # required
|
280
|
+
# }
|
281
|
+
#
|
282
|
+
# @!attribute [rw] document_id
|
283
|
+
# The ID of the document.
|
284
|
+
# @return [String]
|
285
|
+
#
|
286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentRequest AWS API Documentation
|
287
|
+
#
|
288
|
+
class DeleteDocumentRequest < Struct.new(
|
289
|
+
:document_id)
|
290
|
+
include Aws::Structure
|
291
|
+
end
|
292
|
+
|
293
|
+
# @note When making an API call, you may pass DeleteFolderContentsRequest
|
294
|
+
# data as a hash:
|
295
|
+
#
|
296
|
+
# {
|
297
|
+
# folder_id: "ResourceIdType", # required
|
298
|
+
# }
|
299
|
+
#
|
300
|
+
# @!attribute [rw] folder_id
|
301
|
+
# The ID of the folder.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderContentsRequest AWS API Documentation
|
305
|
+
#
|
306
|
+
class DeleteFolderContentsRequest < Struct.new(
|
307
|
+
:folder_id)
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# @note When making an API call, you may pass DeleteFolderRequest
|
312
|
+
# data as a hash:
|
313
|
+
#
|
314
|
+
# {
|
315
|
+
# folder_id: "ResourceIdType", # required
|
316
|
+
# }
|
317
|
+
#
|
318
|
+
# @!attribute [rw] folder_id
|
319
|
+
# The ID of the folder.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteFolderRequest AWS API Documentation
|
323
|
+
#
|
324
|
+
class DeleteFolderRequest < Struct.new(
|
325
|
+
:folder_id)
|
326
|
+
include Aws::Structure
|
327
|
+
end
|
328
|
+
|
329
|
+
# @note When making an API call, you may pass DeleteNotificationSubscriptionRequest
|
330
|
+
# data as a hash:
|
331
|
+
#
|
332
|
+
# {
|
333
|
+
# subscription_id: "IdType", # required
|
334
|
+
# organization_id: "IdType", # required
|
335
|
+
# }
|
336
|
+
#
|
337
|
+
# @!attribute [rw] subscription_id
|
338
|
+
# The ID of the subscription.
|
339
|
+
# @return [String]
|
340
|
+
#
|
341
|
+
# @!attribute [rw] organization_id
|
342
|
+
# The ID of the organization.
|
343
|
+
# @return [String]
|
344
|
+
#
|
345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteNotificationSubscriptionRequest AWS API Documentation
|
346
|
+
#
|
347
|
+
class DeleteNotificationSubscriptionRequest < Struct.new(
|
348
|
+
:subscription_id,
|
349
|
+
:organization_id)
|
350
|
+
include Aws::Structure
|
351
|
+
end
|
352
|
+
|
353
|
+
# @note When making an API call, you may pass DeleteUserRequest
|
354
|
+
# data as a hash:
|
355
|
+
#
|
356
|
+
# {
|
357
|
+
# user_id: "IdType", # required
|
358
|
+
# }
|
359
|
+
#
|
360
|
+
# @!attribute [rw] user_id
|
361
|
+
# The ID of the user.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteUserRequest AWS API Documentation
|
365
|
+
#
|
366
|
+
class DeleteUserRequest < Struct.new(
|
367
|
+
:user_id)
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
# @note When making an API call, you may pass DescribeDocumentVersionsRequest
|
372
|
+
# data as a hash:
|
373
|
+
#
|
374
|
+
# {
|
375
|
+
# document_id: "ResourceIdType", # required
|
376
|
+
# marker: "PageMarkerType",
|
377
|
+
# limit: 1,
|
378
|
+
# include: "FieldNamesType",
|
379
|
+
# fields: "FieldNamesType",
|
380
|
+
# }
|
381
|
+
#
|
382
|
+
# @!attribute [rw] document_id
|
383
|
+
# The ID of the document.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] marker
|
387
|
+
# The marker for the next set of results. (You received this marker
|
388
|
+
# from a previous call.)
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] limit
|
392
|
+
# The maximum number of versions to return with this call.
|
393
|
+
# @return [Integer]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] include
|
396
|
+
# A comma-separated list of values. Specify "INITIALIZED" to include
|
397
|
+
# incomplete versions.
|
398
|
+
# @return [String]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] fields
|
401
|
+
# Specify "SOURCE" to include initialized versions and a URL for the
|
402
|
+
# source document.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersionsRequest AWS API Documentation
|
406
|
+
#
|
407
|
+
class DescribeDocumentVersionsRequest < Struct.new(
|
408
|
+
:document_id,
|
409
|
+
:marker,
|
410
|
+
:limit,
|
411
|
+
:include,
|
412
|
+
:fields)
|
413
|
+
include Aws::Structure
|
414
|
+
end
|
415
|
+
|
416
|
+
# @!attribute [rw] document_versions
|
417
|
+
# The document versions.
|
418
|
+
# @return [Array<Types::DocumentVersionMetadata>]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] marker
|
421
|
+
# The marker to use when requesting the next set of results. If there
|
422
|
+
# are no additional results, the string is empty.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeDocumentVersionsResponse AWS API Documentation
|
426
|
+
#
|
427
|
+
class DescribeDocumentVersionsResponse < Struct.new(
|
428
|
+
:document_versions,
|
429
|
+
:marker)
|
430
|
+
include Aws::Structure
|
431
|
+
end
|
432
|
+
|
433
|
+
# @note When making an API call, you may pass DescribeFolderContentsRequest
|
434
|
+
# data as a hash:
|
435
|
+
#
|
436
|
+
# {
|
437
|
+
# folder_id: "ResourceIdType", # required
|
438
|
+
# sort: "DATE", # accepts DATE, NAME
|
439
|
+
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
440
|
+
# limit: 1,
|
441
|
+
# marker: "PageMarkerType",
|
442
|
+
# type: "ALL", # accepts ALL, DOCUMENT, FOLDER
|
443
|
+
# include: "FieldNamesType",
|
444
|
+
# }
|
445
|
+
#
|
446
|
+
# @!attribute [rw] folder_id
|
447
|
+
# The ID of the folder.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] sort
|
451
|
+
# The sorting criteria.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] order
|
455
|
+
# The order for the contents of the folder.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] limit
|
459
|
+
# The maximum number of items to return with this call.
|
460
|
+
# @return [Integer]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] marker
|
463
|
+
# The marker for the next set of results. (You received this marker
|
464
|
+
# from a previous call.)
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] type
|
468
|
+
# The type of items.
|
469
|
+
# @return [String]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] include
|
472
|
+
# The contents to include. Specify "INITIALIZED" to include
|
473
|
+
# initialized documents.
|
474
|
+
# @return [String]
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContentsRequest AWS API Documentation
|
477
|
+
#
|
478
|
+
class DescribeFolderContentsRequest < Struct.new(
|
479
|
+
:folder_id,
|
480
|
+
:sort,
|
481
|
+
:order,
|
482
|
+
:limit,
|
483
|
+
:marker,
|
484
|
+
:type,
|
485
|
+
:include)
|
486
|
+
include Aws::Structure
|
487
|
+
end
|
488
|
+
|
489
|
+
# @!attribute [rw] folders
|
490
|
+
# The sub-folders in the specified folder.
|
491
|
+
# @return [Array<Types::FolderMetadata>]
|
492
|
+
#
|
493
|
+
# @!attribute [rw] documents
|
494
|
+
# The documents in the specified folder.
|
495
|
+
# @return [Array<Types::DocumentMetadata>]
|
496
|
+
#
|
497
|
+
# @!attribute [rw] marker
|
498
|
+
# The marker to use when requesting the next set of results. If there
|
499
|
+
# are no additional results, the string is empty.
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeFolderContentsResponse AWS API Documentation
|
503
|
+
#
|
504
|
+
class DescribeFolderContentsResponse < Struct.new(
|
505
|
+
:folders,
|
506
|
+
:documents,
|
507
|
+
:marker)
|
508
|
+
include Aws::Structure
|
509
|
+
end
|
510
|
+
|
511
|
+
# @note When making an API call, you may pass DescribeNotificationSubscriptionsRequest
|
512
|
+
# data as a hash:
|
513
|
+
#
|
514
|
+
# {
|
515
|
+
# organization_id: "IdType", # required
|
516
|
+
# marker: "PageMarkerType",
|
517
|
+
# limit: 1,
|
518
|
+
# }
|
519
|
+
#
|
520
|
+
# @!attribute [rw] organization_id
|
521
|
+
# The ID of the organization.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] marker
|
525
|
+
# The marker for the next set of results. (You received this marker
|
526
|
+
# from a previous call.)
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] limit
|
530
|
+
# The maximum number of items to return with this call.
|
531
|
+
# @return [Integer]
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptionsRequest AWS API Documentation
|
534
|
+
#
|
535
|
+
class DescribeNotificationSubscriptionsRequest < Struct.new(
|
536
|
+
:organization_id,
|
537
|
+
:marker,
|
538
|
+
:limit)
|
539
|
+
include Aws::Structure
|
540
|
+
end
|
541
|
+
|
542
|
+
# @!attribute [rw] subscriptions
|
543
|
+
# The subscriptions.
|
544
|
+
# @return [Array<Types::Subscription>]
|
545
|
+
#
|
546
|
+
# @!attribute [rw] marker
|
547
|
+
# The marker to use when requesting the next set of results. If there
|
548
|
+
# are no additional results, the string is empty.
|
549
|
+
# @return [String]
|
550
|
+
#
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptionsResponse AWS API Documentation
|
552
|
+
#
|
553
|
+
class DescribeNotificationSubscriptionsResponse < Struct.new(
|
554
|
+
:subscriptions,
|
555
|
+
:marker)
|
556
|
+
include Aws::Structure
|
557
|
+
end
|
558
|
+
|
559
|
+
# @note When making an API call, you may pass DescribeResourcePermissionsRequest
|
560
|
+
# data as a hash:
|
561
|
+
#
|
562
|
+
# {
|
563
|
+
# resource_id: "ResourceIdType", # required
|
564
|
+
# limit: 1,
|
565
|
+
# marker: "PageMarkerType",
|
566
|
+
# }
|
567
|
+
#
|
568
|
+
# @!attribute [rw] resource_id
|
569
|
+
# The ID of the resource.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] limit
|
573
|
+
# The maximum number of items to return with this call.
|
574
|
+
# @return [Integer]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] marker
|
577
|
+
# The marker for the next set of results. (You received this marker
|
578
|
+
# from a previous call)
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissionsRequest AWS API Documentation
|
582
|
+
#
|
583
|
+
class DescribeResourcePermissionsRequest < Struct.new(
|
584
|
+
:resource_id,
|
585
|
+
:limit,
|
586
|
+
:marker)
|
587
|
+
include Aws::Structure
|
588
|
+
end
|
589
|
+
|
590
|
+
# @!attribute [rw] principals
|
591
|
+
# The principals.
|
592
|
+
# @return [Array<Types::Principal>]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] marker
|
595
|
+
# The marker to use when requesting the next set of results. If there
|
596
|
+
# are no additional results, the string is empty.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissionsResponse AWS API Documentation
|
600
|
+
#
|
601
|
+
class DescribeResourcePermissionsResponse < Struct.new(
|
602
|
+
:principals,
|
603
|
+
:marker)
|
604
|
+
include Aws::Structure
|
605
|
+
end
|
606
|
+
|
607
|
+
# @note When making an API call, you may pass DescribeUsersRequest
|
608
|
+
# data as a hash:
|
609
|
+
#
|
610
|
+
# {
|
611
|
+
# organization_id: "IdType",
|
612
|
+
# user_ids: "UserIdsType",
|
613
|
+
# query: "SearchQueryType",
|
614
|
+
# include: "ALL", # accepts ALL, ACTIVE_PENDING
|
615
|
+
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
616
|
+
# sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
|
617
|
+
# marker: "PageMarkerType",
|
618
|
+
# limit: 1,
|
619
|
+
# fields: "FieldNamesType",
|
620
|
+
# }
|
621
|
+
#
|
622
|
+
# @!attribute [rw] organization_id
|
623
|
+
# The ID of the organization.
|
624
|
+
# @return [String]
|
625
|
+
#
|
626
|
+
# @!attribute [rw] user_ids
|
627
|
+
# The IDs of the users.
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @!attribute [rw] query
|
631
|
+
# A query to filter users by user name.
|
632
|
+
# @return [String]
|
633
|
+
#
|
634
|
+
# @!attribute [rw] include
|
635
|
+
# The state of the users. Specify "ALL" to include inactive users.
|
636
|
+
# @return [String]
|
637
|
+
#
|
638
|
+
# @!attribute [rw] order
|
639
|
+
# The order for the results.
|
640
|
+
# @return [String]
|
641
|
+
#
|
642
|
+
# @!attribute [rw] sort
|
643
|
+
# The sorting criteria.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @!attribute [rw] marker
|
647
|
+
# The marker for the next set of results. (You received this marker
|
648
|
+
# from a previous call.)
|
649
|
+
# @return [String]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] limit
|
652
|
+
# The maximum number of items to return.
|
653
|
+
# @return [Integer]
|
654
|
+
#
|
655
|
+
# @!attribute [rw] fields
|
656
|
+
# A comma-separated list of values. Specify "STORAGE\_METADATA" to
|
657
|
+
# include the user storage quota and utilization information.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersRequest AWS API Documentation
|
661
|
+
#
|
662
|
+
class DescribeUsersRequest < Struct.new(
|
663
|
+
:organization_id,
|
664
|
+
:user_ids,
|
665
|
+
:query,
|
666
|
+
:include,
|
667
|
+
:order,
|
668
|
+
:sort,
|
669
|
+
:marker,
|
670
|
+
:limit,
|
671
|
+
:fields)
|
672
|
+
include Aws::Structure
|
673
|
+
end
|
674
|
+
|
675
|
+
# @!attribute [rw] users
|
676
|
+
# The users.
|
677
|
+
# @return [Array<Types::User>]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] total_number_of_users
|
680
|
+
# The total number of users included in the results.
|
681
|
+
# @return [Integer]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] marker
|
684
|
+
# The marker to use when requesting the next set of results. If there
|
685
|
+
# are no additional results, the string is empty.
|
686
|
+
# @return [String]
|
687
|
+
#
|
688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeUsersResponse AWS API Documentation
|
689
|
+
#
|
690
|
+
class DescribeUsersResponse < Struct.new(
|
691
|
+
:users,
|
692
|
+
:total_number_of_users,
|
693
|
+
:marker)
|
694
|
+
include Aws::Structure
|
695
|
+
end
|
696
|
+
|
697
|
+
# Describes the document.
|
698
|
+
#
|
699
|
+
# @!attribute [rw] id
|
700
|
+
# The ID of the document.
|
701
|
+
# @return [String]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] creator_id
|
704
|
+
# The ID of the creator.
|
705
|
+
# @return [String]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] parent_folder_id
|
708
|
+
# The ID of the parent folder.
|
709
|
+
# @return [String]
|
710
|
+
#
|
711
|
+
# @!attribute [rw] created_timestamp
|
712
|
+
# The time when the document was created.
|
713
|
+
# @return [Time]
|
714
|
+
#
|
715
|
+
# @!attribute [rw] modified_timestamp
|
716
|
+
# The time when the document was updated.
|
717
|
+
# @return [Time]
|
718
|
+
#
|
719
|
+
# @!attribute [rw] latest_version_metadata
|
720
|
+
# The latest version of the document.
|
721
|
+
# @return [Types::DocumentVersionMetadata]
|
722
|
+
#
|
723
|
+
# @!attribute [rw] resource_state
|
724
|
+
# The resource state.
|
725
|
+
# @return [String]
|
726
|
+
#
|
727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DocumentMetadata AWS API Documentation
|
728
|
+
#
|
729
|
+
class DocumentMetadata < Struct.new(
|
730
|
+
:id,
|
731
|
+
:creator_id,
|
732
|
+
:parent_folder_id,
|
733
|
+
:created_timestamp,
|
734
|
+
:modified_timestamp,
|
735
|
+
:latest_version_metadata,
|
736
|
+
:resource_state)
|
737
|
+
include Aws::Structure
|
738
|
+
end
|
739
|
+
|
740
|
+
# Describes a version of a document.
|
741
|
+
#
|
742
|
+
# @!attribute [rw] id
|
743
|
+
# The ID of the version.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] name
|
747
|
+
# The name of the version.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] content_type
|
751
|
+
# The content type of the document.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] size
|
755
|
+
# The size of the document, in bytes.
|
756
|
+
# @return [Integer]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] signature
|
759
|
+
# The signature of the document.
|
760
|
+
# @return [String]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] status
|
763
|
+
# The status of the document.
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] created_timestamp
|
767
|
+
# The time stamp when the document was first uploaded.
|
768
|
+
# @return [Time]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] modified_timestamp
|
771
|
+
# The time stamp when the document was last uploaded.
|
772
|
+
# @return [Time]
|
773
|
+
#
|
774
|
+
# @!attribute [rw] content_created_timestamp
|
775
|
+
# The time stamp when the content of the document was originally
|
776
|
+
# created.
|
777
|
+
# @return [Time]
|
778
|
+
#
|
779
|
+
# @!attribute [rw] content_modified_timestamp
|
780
|
+
# The time stamp when the content of the document was modified.
|
781
|
+
# @return [Time]
|
782
|
+
#
|
783
|
+
# @!attribute [rw] creator_id
|
784
|
+
# The ID of the creator.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @!attribute [rw] thumbnail
|
788
|
+
# The thumbnail of the document.
|
789
|
+
# @return [Hash<String,String>]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] source
|
792
|
+
# The source of the document.
|
793
|
+
# @return [Hash<String,String>]
|
794
|
+
#
|
795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DocumentVersionMetadata AWS API Documentation
|
796
|
+
#
|
797
|
+
class DocumentVersionMetadata < Struct.new(
|
798
|
+
:id,
|
799
|
+
:name,
|
800
|
+
:content_type,
|
801
|
+
:size,
|
802
|
+
:signature,
|
803
|
+
:status,
|
804
|
+
:created_timestamp,
|
805
|
+
:modified_timestamp,
|
806
|
+
:content_created_timestamp,
|
807
|
+
:content_modified_timestamp,
|
808
|
+
:creator_id,
|
809
|
+
:thumbnail,
|
810
|
+
:source)
|
811
|
+
include Aws::Structure
|
812
|
+
end
|
813
|
+
|
814
|
+
# Describes a folder.
|
815
|
+
#
|
816
|
+
# @!attribute [rw] id
|
817
|
+
# The ID of the folder.
|
818
|
+
# @return [String]
|
819
|
+
#
|
820
|
+
# @!attribute [rw] name
|
821
|
+
# The name of the folder.
|
822
|
+
# @return [String]
|
823
|
+
#
|
824
|
+
# @!attribute [rw] creator_id
|
825
|
+
# The ID of the creator.
|
826
|
+
# @return [String]
|
827
|
+
#
|
828
|
+
# @!attribute [rw] parent_folder_id
|
829
|
+
# The ID of the parent folder.
|
830
|
+
# @return [String]
|
831
|
+
#
|
832
|
+
# @!attribute [rw] created_timestamp
|
833
|
+
# The time when the folder was created.
|
834
|
+
# @return [Time]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] modified_timestamp
|
837
|
+
# The time when the folder was updated.
|
838
|
+
# @return [Time]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] resource_state
|
841
|
+
# The resource state of the folder.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] signature
|
845
|
+
# The unique identifier created from the subfolders and documents of
|
846
|
+
# the folder.
|
847
|
+
# @return [String]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/FolderMetadata AWS API Documentation
|
850
|
+
#
|
851
|
+
class FolderMetadata < Struct.new(
|
852
|
+
:id,
|
853
|
+
:name,
|
854
|
+
:creator_id,
|
855
|
+
:parent_folder_id,
|
856
|
+
:created_timestamp,
|
857
|
+
:modified_timestamp,
|
858
|
+
:resource_state,
|
859
|
+
:signature)
|
860
|
+
include Aws::Structure
|
861
|
+
end
|
862
|
+
|
863
|
+
# @note When making an API call, you may pass GetDocumentPathRequest
|
864
|
+
# data as a hash:
|
865
|
+
#
|
866
|
+
# {
|
867
|
+
# document_id: "IdType", # required
|
868
|
+
# limit: 1,
|
869
|
+
# fields: "FieldNamesType",
|
870
|
+
# marker: "PageMarkerType",
|
871
|
+
# }
|
872
|
+
#
|
873
|
+
# @!attribute [rw] document_id
|
874
|
+
# The ID of the document.
|
875
|
+
# @return [String]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] limit
|
878
|
+
# The maximum number of levels in the hierarchy to return.
|
879
|
+
# @return [Integer]
|
880
|
+
#
|
881
|
+
# @!attribute [rw] fields
|
882
|
+
# A comma-separated list of values. Specify "NAME" to include the
|
883
|
+
# names of the parent folders.
|
884
|
+
# @return [String]
|
885
|
+
#
|
886
|
+
# @!attribute [rw] marker
|
887
|
+
# This value is not supported.
|
888
|
+
# @return [String]
|
889
|
+
#
|
890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPathRequest AWS API Documentation
|
891
|
+
#
|
892
|
+
class GetDocumentPathRequest < Struct.new(
|
893
|
+
:document_id,
|
894
|
+
:limit,
|
895
|
+
:fields,
|
896
|
+
:marker)
|
897
|
+
include Aws::Structure
|
898
|
+
end
|
899
|
+
|
900
|
+
# @!attribute [rw] path
|
901
|
+
# The path information.
|
902
|
+
# @return [Types::ResourcePath]
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentPathResponse AWS API Documentation
|
905
|
+
#
|
906
|
+
class GetDocumentPathResponse < Struct.new(
|
907
|
+
:path)
|
908
|
+
include Aws::Structure
|
909
|
+
end
|
910
|
+
|
911
|
+
# @note When making an API call, you may pass GetDocumentRequest
|
912
|
+
# data as a hash:
|
913
|
+
#
|
914
|
+
# {
|
915
|
+
# document_id: "ResourceIdType", # required
|
916
|
+
# }
|
917
|
+
#
|
918
|
+
# @!attribute [rw] document_id
|
919
|
+
# The ID of the document object.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentRequest AWS API Documentation
|
923
|
+
#
|
924
|
+
class GetDocumentRequest < Struct.new(
|
925
|
+
:document_id)
|
926
|
+
include Aws::Structure
|
927
|
+
end
|
928
|
+
|
929
|
+
# @!attribute [rw] metadata
|
930
|
+
# The document object.
|
931
|
+
# @return [Types::DocumentMetadata]
|
932
|
+
#
|
933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentResponse AWS API Documentation
|
934
|
+
#
|
935
|
+
class GetDocumentResponse < Struct.new(
|
936
|
+
:metadata)
|
937
|
+
include Aws::Structure
|
938
|
+
end
|
939
|
+
|
940
|
+
# @note When making an API call, you may pass GetDocumentVersionRequest
|
941
|
+
# data as a hash:
|
942
|
+
#
|
943
|
+
# {
|
944
|
+
# document_id: "ResourceIdType", # required
|
945
|
+
# version_id: "DocumentVersionIdType", # required
|
946
|
+
# fields: "FieldNamesType",
|
947
|
+
# }
|
948
|
+
#
|
949
|
+
# @!attribute [rw] document_id
|
950
|
+
# The ID of the document.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] version_id
|
954
|
+
# The version ID of the document.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @!attribute [rw] fields
|
958
|
+
# A comma-separated list of values. Specify "SOURCE" to include a
|
959
|
+
# URL for the source document.
|
960
|
+
# @return [String]
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionRequest AWS API Documentation
|
963
|
+
#
|
964
|
+
class GetDocumentVersionRequest < Struct.new(
|
965
|
+
:document_id,
|
966
|
+
:version_id,
|
967
|
+
:fields)
|
968
|
+
include Aws::Structure
|
969
|
+
end
|
970
|
+
|
971
|
+
# @!attribute [rw] metadata
|
972
|
+
# The version metadata.
|
973
|
+
# @return [Types::DocumentVersionMetadata]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetDocumentVersionResponse AWS API Documentation
|
976
|
+
#
|
977
|
+
class GetDocumentVersionResponse < Struct.new(
|
978
|
+
:metadata)
|
979
|
+
include Aws::Structure
|
980
|
+
end
|
981
|
+
|
982
|
+
# @note When making an API call, you may pass GetFolderPathRequest
|
983
|
+
# data as a hash:
|
984
|
+
#
|
985
|
+
# {
|
986
|
+
# folder_id: "IdType", # required
|
987
|
+
# limit: 1,
|
988
|
+
# fields: "FieldNamesType",
|
989
|
+
# marker: "PageMarkerType",
|
990
|
+
# }
|
991
|
+
#
|
992
|
+
# @!attribute [rw] folder_id
|
993
|
+
# The ID of the folder.
|
994
|
+
# @return [String]
|
995
|
+
#
|
996
|
+
# @!attribute [rw] limit
|
997
|
+
# The maximum number of levels in the hierarchy to return.
|
998
|
+
# @return [Integer]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] fields
|
1001
|
+
# A comma-separated list of values. Specify "NAME" to include the
|
1002
|
+
# names of the parent folders.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] marker
|
1006
|
+
# This value is not supported.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPathRequest AWS API Documentation
|
1010
|
+
#
|
1011
|
+
class GetFolderPathRequest < Struct.new(
|
1012
|
+
:folder_id,
|
1013
|
+
:limit,
|
1014
|
+
:fields,
|
1015
|
+
:marker)
|
1016
|
+
include Aws::Structure
|
1017
|
+
end
|
1018
|
+
|
1019
|
+
# @!attribute [rw] path
|
1020
|
+
# The path information.
|
1021
|
+
# @return [Types::ResourcePath]
|
1022
|
+
#
|
1023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderPathResponse AWS API Documentation
|
1024
|
+
#
|
1025
|
+
class GetFolderPathResponse < Struct.new(
|
1026
|
+
:path)
|
1027
|
+
include Aws::Structure
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# @note When making an API call, you may pass GetFolderRequest
|
1031
|
+
# data as a hash:
|
1032
|
+
#
|
1033
|
+
# {
|
1034
|
+
# folder_id: "ResourceIdType", # required
|
1035
|
+
# }
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] folder_id
|
1038
|
+
# The ID of the folder.
|
1039
|
+
# @return [String]
|
1040
|
+
#
|
1041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderRequest AWS API Documentation
|
1042
|
+
#
|
1043
|
+
class GetFolderRequest < Struct.new(
|
1044
|
+
:folder_id)
|
1045
|
+
include Aws::Structure
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# @!attribute [rw] metadata
|
1049
|
+
# The metadata of the folder.
|
1050
|
+
# @return [Types::FolderMetadata]
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/GetFolderResponse AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class GetFolderResponse < Struct.new(
|
1055
|
+
:metadata)
|
1056
|
+
include Aws::Structure
|
1057
|
+
end
|
1058
|
+
|
1059
|
+
# @note When making an API call, you may pass InitiateDocumentVersionUploadRequest
|
1060
|
+
# data as a hash:
|
1061
|
+
#
|
1062
|
+
# {
|
1063
|
+
# id: "ResourceIdType",
|
1064
|
+
# name: "ResourceNameType",
|
1065
|
+
# content_created_timestamp: Time.now,
|
1066
|
+
# content_modified_timestamp: Time.now,
|
1067
|
+
# content_type: "DocumentContentType",
|
1068
|
+
# document_size_in_bytes: 1,
|
1069
|
+
# parent_folder_id: "ResourceIdType", # required
|
1070
|
+
# }
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] id
|
1073
|
+
# The ID of the document.
|
1074
|
+
# @return [String]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] name
|
1077
|
+
# The name of the document.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] content_created_timestamp
|
1081
|
+
# The time stamp when the content of the document was originally
|
1082
|
+
# created.
|
1083
|
+
# @return [Time]
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] content_modified_timestamp
|
1086
|
+
# The time stamp when the content of the document was modified.
|
1087
|
+
# @return [Time]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] content_type
|
1090
|
+
# The content type of the document.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] document_size_in_bytes
|
1094
|
+
# The size of the document, in bytes.
|
1095
|
+
# @return [Integer]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] parent_folder_id
|
1098
|
+
# The ID of the parent folder.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUploadRequest AWS API Documentation
|
1102
|
+
#
|
1103
|
+
class InitiateDocumentVersionUploadRequest < Struct.new(
|
1104
|
+
:id,
|
1105
|
+
:name,
|
1106
|
+
:content_created_timestamp,
|
1107
|
+
:content_modified_timestamp,
|
1108
|
+
:content_type,
|
1109
|
+
:document_size_in_bytes,
|
1110
|
+
:parent_folder_id)
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
# @!attribute [rw] metadata
|
1115
|
+
# The document metadata.
|
1116
|
+
# @return [Types::DocumentMetadata]
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] upload_metadata
|
1119
|
+
# The upload metadata.
|
1120
|
+
# @return [Types::UploadMetadata]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/InitiateDocumentVersionUploadResponse AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class InitiateDocumentVersionUploadResponse < Struct.new(
|
1125
|
+
:metadata,
|
1126
|
+
:upload_metadata)
|
1127
|
+
include Aws::Structure
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# Describes the permissions.
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] role
|
1133
|
+
# The role of the user.
|
1134
|
+
# @return [String]
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] type
|
1137
|
+
# The type of permissions.
|
1138
|
+
# @return [String]
|
1139
|
+
#
|
1140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/PermissionInfo AWS API Documentation
|
1141
|
+
#
|
1142
|
+
class PermissionInfo < Struct.new(
|
1143
|
+
:role,
|
1144
|
+
:type)
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
# Describes a resource.
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] id
|
1151
|
+
# The ID of the resource.
|
1152
|
+
# @return [String]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] type
|
1155
|
+
# The type of resource.
|
1156
|
+
# @return [String]
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] roles
|
1159
|
+
# The permission information for the resource.
|
1160
|
+
# @return [Array<Types::PermissionInfo>]
|
1161
|
+
#
|
1162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Principal AWS API Documentation
|
1163
|
+
#
|
1164
|
+
class Principal < Struct.new(
|
1165
|
+
:id,
|
1166
|
+
:type,
|
1167
|
+
:roles)
|
1168
|
+
include Aws::Structure
|
1169
|
+
end
|
1170
|
+
|
1171
|
+
# @note When making an API call, you may pass RemoveAllResourcePermissionsRequest
|
1172
|
+
# data as a hash:
|
1173
|
+
#
|
1174
|
+
# {
|
1175
|
+
# resource_id: "ResourceIdType", # required
|
1176
|
+
# }
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] resource_id
|
1179
|
+
# The ID of the resource.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveAllResourcePermissionsRequest AWS API Documentation
|
1183
|
+
#
|
1184
|
+
class RemoveAllResourcePermissionsRequest < Struct.new(
|
1185
|
+
:resource_id)
|
1186
|
+
include Aws::Structure
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# @note When making an API call, you may pass RemoveResourcePermissionRequest
|
1190
|
+
# data as a hash:
|
1191
|
+
#
|
1192
|
+
# {
|
1193
|
+
# resource_id: "ResourceIdType", # required
|
1194
|
+
# principal_id: "IdType", # required
|
1195
|
+
# principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
1196
|
+
# }
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] resource_id
|
1199
|
+
# The ID of the resource.
|
1200
|
+
# @return [String]
|
1201
|
+
#
|
1202
|
+
# @!attribute [rw] principal_id
|
1203
|
+
# The principal ID of the resource.
|
1204
|
+
# @return [String]
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] principal_type
|
1207
|
+
# The principal type of the resource.
|
1208
|
+
# @return [String]
|
1209
|
+
#
|
1210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RemoveResourcePermissionRequest AWS API Documentation
|
1211
|
+
#
|
1212
|
+
class RemoveResourcePermissionRequest < Struct.new(
|
1213
|
+
:resource_id,
|
1214
|
+
:principal_id,
|
1215
|
+
:principal_type)
|
1216
|
+
include Aws::Structure
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# Describes the path information of a resource.
|
1220
|
+
#
|
1221
|
+
# @!attribute [rw] components
|
1222
|
+
# The components of the resource path.
|
1223
|
+
# @return [Array<Types::ResourcePathComponent>]
|
1224
|
+
#
|
1225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourcePath AWS API Documentation
|
1226
|
+
#
|
1227
|
+
class ResourcePath < Struct.new(
|
1228
|
+
:components)
|
1229
|
+
include Aws::Structure
|
1230
|
+
end
|
1231
|
+
|
1232
|
+
# Describes the resource path.
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] id
|
1235
|
+
# The ID of the resource path.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] name
|
1239
|
+
# The name of the resource path.
|
1240
|
+
# @return [String]
|
1241
|
+
#
|
1242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResourcePathComponent AWS API Documentation
|
1243
|
+
#
|
1244
|
+
class ResourcePathComponent < Struct.new(
|
1245
|
+
:id,
|
1246
|
+
:name)
|
1247
|
+
include Aws::Structure
|
1248
|
+
end
|
1249
|
+
|
1250
|
+
# Describes the recipient type and ID, if available.
|
1251
|
+
#
|
1252
|
+
# @note When making an API call, you may pass SharePrincipal
|
1253
|
+
# data as a hash:
|
1254
|
+
#
|
1255
|
+
# {
|
1256
|
+
# id: "IdType", # required
|
1257
|
+
# type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
1258
|
+
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
1259
|
+
# }
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] id
|
1262
|
+
# The ID of the recipient.
|
1263
|
+
# @return [String]
|
1264
|
+
#
|
1265
|
+
# @!attribute [rw] type
|
1266
|
+
# The type of the recipient.
|
1267
|
+
# @return [String]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] role
|
1270
|
+
# The role of the recipient.
|
1271
|
+
# @return [String]
|
1272
|
+
#
|
1273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SharePrincipal AWS API Documentation
|
1274
|
+
#
|
1275
|
+
class SharePrincipal < Struct.new(
|
1276
|
+
:id,
|
1277
|
+
:type,
|
1278
|
+
:role)
|
1279
|
+
include Aws::Structure
|
1280
|
+
end
|
1281
|
+
|
1282
|
+
# Describes the share results of a resource.
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] principal_id
|
1285
|
+
# The ID of the principal.
|
1286
|
+
# @return [String]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] role
|
1289
|
+
# The role.
|
1290
|
+
# @return [String]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] status
|
1293
|
+
# The status.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] share_id
|
1297
|
+
# The ID of the resource that was shared.
|
1298
|
+
# @return [String]
|
1299
|
+
#
|
1300
|
+
# @!attribute [rw] status_message
|
1301
|
+
# The status message.
|
1302
|
+
# @return [String]
|
1303
|
+
#
|
1304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ShareResult AWS API Documentation
|
1305
|
+
#
|
1306
|
+
class ShareResult < Struct.new(
|
1307
|
+
:principal_id,
|
1308
|
+
:role,
|
1309
|
+
:status,
|
1310
|
+
:share_id,
|
1311
|
+
:status_message)
|
1312
|
+
include Aws::Structure
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# Describes the storage for a user.
|
1316
|
+
#
|
1317
|
+
# @note When making an API call, you may pass StorageRuleType
|
1318
|
+
# data as a hash:
|
1319
|
+
#
|
1320
|
+
# {
|
1321
|
+
# storage_allocated_in_bytes: 1,
|
1322
|
+
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
1323
|
+
# }
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] storage_allocated_in_bytes
|
1326
|
+
# The amount of storage allocated, in bytes.
|
1327
|
+
# @return [Integer]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] storage_type
|
1330
|
+
# The type of storage.
|
1331
|
+
# @return [String]
|
1332
|
+
#
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/StorageRuleType AWS API Documentation
|
1334
|
+
#
|
1335
|
+
class StorageRuleType < Struct.new(
|
1336
|
+
:storage_allocated_in_bytes,
|
1337
|
+
:storage_type)
|
1338
|
+
include Aws::Structure
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
# Describes a subscription.
|
1342
|
+
#
|
1343
|
+
# @!attribute [rw] subscription_id
|
1344
|
+
# The ID of the subscription.
|
1345
|
+
# @return [String]
|
1346
|
+
#
|
1347
|
+
# @!attribute [rw] end_point
|
1348
|
+
# The endpoint of the subscription.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] protocol
|
1352
|
+
# The protocol of the subscription.
|
1353
|
+
# @return [String]
|
1354
|
+
#
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Subscription AWS API Documentation
|
1356
|
+
#
|
1357
|
+
class Subscription < Struct.new(
|
1358
|
+
:subscription_id,
|
1359
|
+
:end_point,
|
1360
|
+
:protocol)
|
1361
|
+
include Aws::Structure
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
# @note When making an API call, you may pass UpdateDocumentRequest
|
1365
|
+
# data as a hash:
|
1366
|
+
#
|
1367
|
+
# {
|
1368
|
+
# document_id: "ResourceIdType", # required
|
1369
|
+
# name: "ResourceNameType",
|
1370
|
+
# parent_folder_id: "ResourceIdType",
|
1371
|
+
# resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
|
1372
|
+
# }
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] document_id
|
1375
|
+
# The ID of the document.
|
1376
|
+
# @return [String]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] name
|
1379
|
+
# The name of the document.
|
1380
|
+
# @return [String]
|
1381
|
+
#
|
1382
|
+
# @!attribute [rw] parent_folder_id
|
1383
|
+
# The ID of the parent folder.
|
1384
|
+
# @return [String]
|
1385
|
+
#
|
1386
|
+
# @!attribute [rw] resource_state
|
1387
|
+
# The resource state of the document. Note that only ACTIVE and
|
1388
|
+
# RECYCLED are supported.
|
1389
|
+
# @return [String]
|
1390
|
+
#
|
1391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentRequest AWS API Documentation
|
1392
|
+
#
|
1393
|
+
class UpdateDocumentRequest < Struct.new(
|
1394
|
+
:document_id,
|
1395
|
+
:name,
|
1396
|
+
:parent_folder_id,
|
1397
|
+
:resource_state)
|
1398
|
+
include Aws::Structure
|
1399
|
+
end
|
1400
|
+
|
1401
|
+
# @note When making an API call, you may pass UpdateDocumentVersionRequest
|
1402
|
+
# data as a hash:
|
1403
|
+
#
|
1404
|
+
# {
|
1405
|
+
# document_id: "ResourceIdType", # required
|
1406
|
+
# version_id: "DocumentVersionIdType", # required
|
1407
|
+
# version_status: "ACTIVE", # accepts ACTIVE
|
1408
|
+
# }
|
1409
|
+
#
|
1410
|
+
# @!attribute [rw] document_id
|
1411
|
+
# The ID of the document.
|
1412
|
+
# @return [String]
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] version_id
|
1415
|
+
# The version ID of the document.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] version_status
|
1419
|
+
# The status of the version.
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateDocumentVersionRequest AWS API Documentation
|
1423
|
+
#
|
1424
|
+
class UpdateDocumentVersionRequest < Struct.new(
|
1425
|
+
:document_id,
|
1426
|
+
:version_id,
|
1427
|
+
:version_status)
|
1428
|
+
include Aws::Structure
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# @note When making an API call, you may pass UpdateFolderRequest
|
1432
|
+
# data as a hash:
|
1433
|
+
#
|
1434
|
+
# {
|
1435
|
+
# folder_id: "ResourceIdType", # required
|
1436
|
+
# name: "ResourceNameType",
|
1437
|
+
# parent_folder_id: "ResourceIdType",
|
1438
|
+
# resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
|
1439
|
+
# }
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] folder_id
|
1442
|
+
# The ID of the folder.
|
1443
|
+
# @return [String]
|
1444
|
+
#
|
1445
|
+
# @!attribute [rw] name
|
1446
|
+
# The name of the folder.
|
1447
|
+
# @return [String]
|
1448
|
+
#
|
1449
|
+
# @!attribute [rw] parent_folder_id
|
1450
|
+
# The ID of the parent folder.
|
1451
|
+
# @return [String]
|
1452
|
+
#
|
1453
|
+
# @!attribute [rw] resource_state
|
1454
|
+
# The resource state of the folder. Note that only ACTIVE and RECYCLED
|
1455
|
+
# are accepted values from the API.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateFolderRequest AWS API Documentation
|
1459
|
+
#
|
1460
|
+
class UpdateFolderRequest < Struct.new(
|
1461
|
+
:folder_id,
|
1462
|
+
:name,
|
1463
|
+
:parent_folder_id,
|
1464
|
+
:resource_state)
|
1465
|
+
include Aws::Structure
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
# @note When making an API call, you may pass UpdateUserRequest
|
1469
|
+
# data as a hash:
|
1470
|
+
#
|
1471
|
+
# {
|
1472
|
+
# user_id: "IdType", # required
|
1473
|
+
# given_name: "UserAttributeValueType",
|
1474
|
+
# surname: "UserAttributeValueType",
|
1475
|
+
# type: "USER", # accepts USER, ADMIN
|
1476
|
+
# storage_rule: {
|
1477
|
+
# storage_allocated_in_bytes: 1,
|
1478
|
+
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
1479
|
+
# },
|
1480
|
+
# time_zone_id: "TimeZoneIdType",
|
1481
|
+
# locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
|
1482
|
+
# }
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] user_id
|
1485
|
+
# The ID of the user.
|
1486
|
+
# @return [String]
|
1487
|
+
#
|
1488
|
+
# @!attribute [rw] given_name
|
1489
|
+
# The given name of the user.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] surname
|
1493
|
+
# The surname of the user.
|
1494
|
+
# @return [String]
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] type
|
1497
|
+
# The type of the user.
|
1498
|
+
# @return [String]
|
1499
|
+
#
|
1500
|
+
# @!attribute [rw] storage_rule
|
1501
|
+
# The amount of storage for the user.
|
1502
|
+
# @return [Types::StorageRuleType]
|
1503
|
+
#
|
1504
|
+
# @!attribute [rw] time_zone_id
|
1505
|
+
# The time zone ID of the user.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] locale
|
1509
|
+
# The locale of the user.
|
1510
|
+
# @return [String]
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserRequest AWS API Documentation
|
1513
|
+
#
|
1514
|
+
class UpdateUserRequest < Struct.new(
|
1515
|
+
:user_id,
|
1516
|
+
:given_name,
|
1517
|
+
:surname,
|
1518
|
+
:type,
|
1519
|
+
:storage_rule,
|
1520
|
+
:time_zone_id,
|
1521
|
+
:locale)
|
1522
|
+
include Aws::Structure
|
1523
|
+
end
|
1524
|
+
|
1525
|
+
# @!attribute [rw] user
|
1526
|
+
# The user information.
|
1527
|
+
# @return [Types::User]
|
1528
|
+
#
|
1529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UpdateUserResponse AWS API Documentation
|
1530
|
+
#
|
1531
|
+
class UpdateUserResponse < Struct.new(
|
1532
|
+
:user)
|
1533
|
+
include Aws::Structure
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# Describes the upload.
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] upload_url
|
1539
|
+
# The URL of the upload.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @!attribute [rw] signed_headers
|
1543
|
+
# The signed headers.
|
1544
|
+
# @return [Hash<String,String>]
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UploadMetadata AWS API Documentation
|
1547
|
+
#
|
1548
|
+
class UploadMetadata < Struct.new(
|
1549
|
+
:upload_url,
|
1550
|
+
:signed_headers)
|
1551
|
+
include Aws::Structure
|
1552
|
+
end
|
1553
|
+
|
1554
|
+
# Describes a user.
|
1555
|
+
#
|
1556
|
+
# @!attribute [rw] id
|
1557
|
+
# The ID of the user.
|
1558
|
+
# @return [String]
|
1559
|
+
#
|
1560
|
+
# @!attribute [rw] username
|
1561
|
+
# The login name of the user.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] email_address
|
1565
|
+
# The email address of the user.
|
1566
|
+
# @return [String]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] given_name
|
1569
|
+
# The given name of the user.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] surname
|
1573
|
+
# The surname of the user.
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1576
|
+
# @!attribute [rw] organization_id
|
1577
|
+
# The ID of the organization.
|
1578
|
+
# @return [String]
|
1579
|
+
#
|
1580
|
+
# @!attribute [rw] root_folder_id
|
1581
|
+
# The ID of the root folder.
|
1582
|
+
# @return [String]
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] recycle_bin_folder_id
|
1585
|
+
# The ID of the recycle bin folder.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] status
|
1589
|
+
# The status of the user.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] type
|
1593
|
+
# The type of user.
|
1594
|
+
# @return [String]
|
1595
|
+
#
|
1596
|
+
# @!attribute [rw] created_timestamp
|
1597
|
+
# The time when the user was created.
|
1598
|
+
# @return [Time]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] modified_timestamp
|
1601
|
+
# The time when the user was modified.
|
1602
|
+
# @return [Time]
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] time_zone_id
|
1605
|
+
# The time zone ID of the user.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] locale
|
1609
|
+
# The locale of the user.
|
1610
|
+
# @return [String]
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] storage
|
1613
|
+
# The storage for the user.
|
1614
|
+
# @return [Types::UserStorageMetadata]
|
1615
|
+
#
|
1616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/User AWS API Documentation
|
1617
|
+
#
|
1618
|
+
class User < Struct.new(
|
1619
|
+
:id,
|
1620
|
+
:username,
|
1621
|
+
:email_address,
|
1622
|
+
:given_name,
|
1623
|
+
:surname,
|
1624
|
+
:organization_id,
|
1625
|
+
:root_folder_id,
|
1626
|
+
:recycle_bin_folder_id,
|
1627
|
+
:status,
|
1628
|
+
:type,
|
1629
|
+
:created_timestamp,
|
1630
|
+
:modified_timestamp,
|
1631
|
+
:time_zone_id,
|
1632
|
+
:locale,
|
1633
|
+
:storage)
|
1634
|
+
include Aws::Structure
|
1635
|
+
end
|
1636
|
+
|
1637
|
+
# Describes the storage for a user.
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] storage_utilized_in_bytes
|
1640
|
+
# The amount of storage utilized, in bytes.
|
1641
|
+
# @return [Integer]
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] storage_rule
|
1644
|
+
# The storage for a user.
|
1645
|
+
# @return [Types::StorageRuleType]
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/UserStorageMetadata AWS API Documentation
|
1648
|
+
#
|
1649
|
+
class UserStorageMetadata < Struct.new(
|
1650
|
+
:storage_utilized_in_bytes,
|
1651
|
+
:storage_rule)
|
1652
|
+
include Aws::Structure
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
end
|
1656
|
+
end
|