aws-sdk-workdocs 1.53.0 → 1.54.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workdocs/client.rb +1 -1
- data/lib/aws-sdk-workdocs/plugins/endpoints.rb +1 -0
- 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/client.rbs
ADDED
@@ -0,0 +1,671 @@
|
|
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
|
9
|
+
module WorkDocs
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?stub_responses: untyped,
|
52
|
+
?token_provider: untyped,
|
53
|
+
?use_dualstack_endpoint: bool,
|
54
|
+
?use_fips_endpoint: bool,
|
55
|
+
?validate_params: bool,
|
56
|
+
?endpoint_provider: untyped,
|
57
|
+
?http_proxy: String,
|
58
|
+
?http_open_timeout: (Float | Integer),
|
59
|
+
?http_read_timeout: (Float | Integer),
|
60
|
+
?http_idle_timeout: (Float | Integer),
|
61
|
+
?http_continue_timeout: (Float | Integer),
|
62
|
+
?ssl_timeout: (Float | Integer | nil),
|
63
|
+
?http_wire_trace: bool,
|
64
|
+
?ssl_verify_peer: bool,
|
65
|
+
?ssl_ca_bundle: String,
|
66
|
+
?ssl_ca_directory: String,
|
67
|
+
?ssl_ca_store: String,
|
68
|
+
?on_chunk_received: Proc,
|
69
|
+
?on_chunk_sent: Proc,
|
70
|
+
?raise_response_errors: bool
|
71
|
+
) -> instance
|
72
|
+
| (?Hash[Symbol, untyped]) -> instance
|
73
|
+
|
74
|
+
|
75
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#abort_document_version_upload-instance_method
|
76
|
+
def abort_document_version_upload: (
|
77
|
+
?authentication_token: ::String,
|
78
|
+
document_id: ::String,
|
79
|
+
version_id: ::String
|
80
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
81
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
82
|
+
|
83
|
+
interface _ActivateUserResponseSuccess
|
84
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ActivateUserResponse]
|
85
|
+
def user: () -> Types::User
|
86
|
+
end
|
87
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#activate_user-instance_method
|
88
|
+
def activate_user: (
|
89
|
+
user_id: ::String,
|
90
|
+
?authentication_token: ::String
|
91
|
+
) -> _ActivateUserResponseSuccess
|
92
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ActivateUserResponseSuccess
|
93
|
+
|
94
|
+
interface _AddResourcePermissionsResponseSuccess
|
95
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AddResourcePermissionsResponse]
|
96
|
+
def share_results: () -> ::Array[Types::ShareResult]
|
97
|
+
end
|
98
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#add_resource_permissions-instance_method
|
99
|
+
def add_resource_permissions: (
|
100
|
+
?authentication_token: ::String,
|
101
|
+
resource_id: ::String,
|
102
|
+
principals: Array[
|
103
|
+
{
|
104
|
+
id: ::String,
|
105
|
+
type: ("USER" | "GROUP" | "INVITE" | "ANONYMOUS" | "ORGANIZATION"),
|
106
|
+
role: ("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")
|
107
|
+
},
|
108
|
+
],
|
109
|
+
?notification_options: {
|
110
|
+
send_email: bool?,
|
111
|
+
email_message: ::String?
|
112
|
+
}
|
113
|
+
) -> _AddResourcePermissionsResponseSuccess
|
114
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AddResourcePermissionsResponseSuccess
|
115
|
+
|
116
|
+
interface _CreateCommentResponseSuccess
|
117
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCommentResponse]
|
118
|
+
def comment: () -> Types::Comment
|
119
|
+
end
|
120
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_comment-instance_method
|
121
|
+
def create_comment: (
|
122
|
+
?authentication_token: ::String,
|
123
|
+
document_id: ::String,
|
124
|
+
version_id: ::String,
|
125
|
+
?parent_id: ::String,
|
126
|
+
?thread_id: ::String,
|
127
|
+
text: ::String,
|
128
|
+
?visibility: ("PUBLIC" | "PRIVATE"),
|
129
|
+
?notify_collaborators: bool
|
130
|
+
) -> _CreateCommentResponseSuccess
|
131
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCommentResponseSuccess
|
132
|
+
|
133
|
+
interface _CreateCustomMetadataResponseSuccess
|
134
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCustomMetadataResponse]
|
135
|
+
end
|
136
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_custom_metadata-instance_method
|
137
|
+
def create_custom_metadata: (
|
138
|
+
?authentication_token: ::String,
|
139
|
+
resource_id: ::String,
|
140
|
+
?version_id: ::String,
|
141
|
+
custom_metadata: Hash[::String, ::String]
|
142
|
+
) -> _CreateCustomMetadataResponseSuccess
|
143
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCustomMetadataResponseSuccess
|
144
|
+
|
145
|
+
interface _CreateFolderResponseSuccess
|
146
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateFolderResponse]
|
147
|
+
def metadata: () -> Types::FolderMetadata
|
148
|
+
end
|
149
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_folder-instance_method
|
150
|
+
def create_folder: (
|
151
|
+
?authentication_token: ::String,
|
152
|
+
?name: ::String,
|
153
|
+
parent_folder_id: ::String
|
154
|
+
) -> _CreateFolderResponseSuccess
|
155
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFolderResponseSuccess
|
156
|
+
|
157
|
+
interface _CreateLabelsResponseSuccess
|
158
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateLabelsResponse]
|
159
|
+
end
|
160
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_labels-instance_method
|
161
|
+
def create_labels: (
|
162
|
+
resource_id: ::String,
|
163
|
+
labels: Array[::String],
|
164
|
+
?authentication_token: ::String
|
165
|
+
) -> _CreateLabelsResponseSuccess
|
166
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateLabelsResponseSuccess
|
167
|
+
|
168
|
+
interface _CreateNotificationSubscriptionResponseSuccess
|
169
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateNotificationSubscriptionResponse]
|
170
|
+
def subscription: () -> Types::Subscription
|
171
|
+
end
|
172
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_notification_subscription-instance_method
|
173
|
+
def create_notification_subscription: (
|
174
|
+
organization_id: ::String,
|
175
|
+
endpoint: ::String,
|
176
|
+
protocol: ("HTTPS" | "SQS"),
|
177
|
+
subscription_type: ("ALL")
|
178
|
+
) -> _CreateNotificationSubscriptionResponseSuccess
|
179
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateNotificationSubscriptionResponseSuccess
|
180
|
+
|
181
|
+
interface _CreateUserResponseSuccess
|
182
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
|
183
|
+
def user: () -> Types::User
|
184
|
+
end
|
185
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#create_user-instance_method
|
186
|
+
def create_user: (
|
187
|
+
?organization_id: ::String,
|
188
|
+
username: ::String,
|
189
|
+
?email_address: ::String,
|
190
|
+
given_name: ::String,
|
191
|
+
surname: ::String,
|
192
|
+
password: ::String,
|
193
|
+
?time_zone_id: ::String,
|
194
|
+
?storage_rule: {
|
195
|
+
storage_allocated_in_bytes: ::Integer?,
|
196
|
+
storage_type: ("UNLIMITED" | "QUOTA")?
|
197
|
+
},
|
198
|
+
?authentication_token: ::String
|
199
|
+
) -> _CreateUserResponseSuccess
|
200
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserResponseSuccess
|
201
|
+
|
202
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#deactivate_user-instance_method
|
203
|
+
def deactivate_user: (
|
204
|
+
user_id: ::String,
|
205
|
+
?authentication_token: ::String
|
206
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
207
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
208
|
+
|
209
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_comment-instance_method
|
210
|
+
def delete_comment: (
|
211
|
+
?authentication_token: ::String,
|
212
|
+
document_id: ::String,
|
213
|
+
version_id: ::String,
|
214
|
+
comment_id: ::String
|
215
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
216
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
217
|
+
|
218
|
+
interface _DeleteCustomMetadataResponseSuccess
|
219
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCustomMetadataResponse]
|
220
|
+
end
|
221
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_custom_metadata-instance_method
|
222
|
+
def delete_custom_metadata: (
|
223
|
+
?authentication_token: ::String,
|
224
|
+
resource_id: ::String,
|
225
|
+
?version_id: ::String,
|
226
|
+
?keys: Array[::String],
|
227
|
+
?delete_all: bool
|
228
|
+
) -> _DeleteCustomMetadataResponseSuccess
|
229
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCustomMetadataResponseSuccess
|
230
|
+
|
231
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_document-instance_method
|
232
|
+
def delete_document: (
|
233
|
+
?authentication_token: ::String,
|
234
|
+
document_id: ::String
|
235
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
236
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
237
|
+
|
238
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_document_version-instance_method
|
239
|
+
def delete_document_version: (
|
240
|
+
?authentication_token: ::String,
|
241
|
+
document_id: ::String,
|
242
|
+
version_id: ::String,
|
243
|
+
delete_prior_versions: bool
|
244
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
245
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
246
|
+
|
247
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_folder-instance_method
|
248
|
+
def delete_folder: (
|
249
|
+
?authentication_token: ::String,
|
250
|
+
folder_id: ::String
|
251
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
252
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
253
|
+
|
254
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_folder_contents-instance_method
|
255
|
+
def delete_folder_contents: (
|
256
|
+
?authentication_token: ::String,
|
257
|
+
folder_id: ::String
|
258
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
259
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
260
|
+
|
261
|
+
interface _DeleteLabelsResponseSuccess
|
262
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteLabelsResponse]
|
263
|
+
end
|
264
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_labels-instance_method
|
265
|
+
def delete_labels: (
|
266
|
+
resource_id: ::String,
|
267
|
+
?authentication_token: ::String,
|
268
|
+
?labels: Array[::String],
|
269
|
+
?delete_all: bool
|
270
|
+
) -> _DeleteLabelsResponseSuccess
|
271
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteLabelsResponseSuccess
|
272
|
+
|
273
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_notification_subscription-instance_method
|
274
|
+
def delete_notification_subscription: (
|
275
|
+
subscription_id: ::String,
|
276
|
+
organization_id: ::String
|
277
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
278
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
279
|
+
|
280
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#delete_user-instance_method
|
281
|
+
def delete_user: (
|
282
|
+
?authentication_token: ::String,
|
283
|
+
user_id: ::String
|
284
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
285
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
286
|
+
|
287
|
+
interface _DescribeActivitiesResponseSuccess
|
288
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeActivitiesResponse]
|
289
|
+
def user_activities: () -> ::Array[Types::Activity]
|
290
|
+
def marker: () -> ::String
|
291
|
+
end
|
292
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_activities-instance_method
|
293
|
+
def describe_activities: (
|
294
|
+
?authentication_token: ::String,
|
295
|
+
?start_time: ::Time,
|
296
|
+
?end_time: ::Time,
|
297
|
+
?organization_id: ::String,
|
298
|
+
?activity_types: ::String,
|
299
|
+
?resource_id: ::String,
|
300
|
+
?user_id: ::String,
|
301
|
+
?include_indirect_activities: bool,
|
302
|
+
?limit: ::Integer,
|
303
|
+
?marker: ::String
|
304
|
+
) -> _DescribeActivitiesResponseSuccess
|
305
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeActivitiesResponseSuccess
|
306
|
+
|
307
|
+
interface _DescribeCommentsResponseSuccess
|
308
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCommentsResponse]
|
309
|
+
def comments: () -> ::Array[Types::Comment]
|
310
|
+
def marker: () -> ::String
|
311
|
+
end
|
312
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_comments-instance_method
|
313
|
+
def describe_comments: (
|
314
|
+
?authentication_token: ::String,
|
315
|
+
document_id: ::String,
|
316
|
+
version_id: ::String,
|
317
|
+
?limit: ::Integer,
|
318
|
+
?marker: ::String
|
319
|
+
) -> _DescribeCommentsResponseSuccess
|
320
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCommentsResponseSuccess
|
321
|
+
|
322
|
+
interface _DescribeDocumentVersionsResponseSuccess
|
323
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeDocumentVersionsResponse]
|
324
|
+
def document_versions: () -> ::Array[Types::DocumentVersionMetadata]
|
325
|
+
def marker: () -> ::String
|
326
|
+
end
|
327
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_document_versions-instance_method
|
328
|
+
def describe_document_versions: (
|
329
|
+
?authentication_token: ::String,
|
330
|
+
document_id: ::String,
|
331
|
+
?marker: ::String,
|
332
|
+
?limit: ::Integer,
|
333
|
+
?include: ::String,
|
334
|
+
?fields: ::String
|
335
|
+
) -> _DescribeDocumentVersionsResponseSuccess
|
336
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeDocumentVersionsResponseSuccess
|
337
|
+
|
338
|
+
interface _DescribeFolderContentsResponseSuccess
|
339
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeFolderContentsResponse]
|
340
|
+
def folders: () -> ::Array[Types::FolderMetadata]
|
341
|
+
def documents: () -> ::Array[Types::DocumentMetadata]
|
342
|
+
def marker: () -> ::String
|
343
|
+
end
|
344
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_folder_contents-instance_method
|
345
|
+
def describe_folder_contents: (
|
346
|
+
?authentication_token: ::String,
|
347
|
+
folder_id: ::String,
|
348
|
+
?sort: ("DATE" | "NAME"),
|
349
|
+
?order: ("ASCENDING" | "DESCENDING"),
|
350
|
+
?limit: ::Integer,
|
351
|
+
?marker: ::String,
|
352
|
+
?type: ("ALL" | "DOCUMENT" | "FOLDER"),
|
353
|
+
?include: ::String
|
354
|
+
) -> _DescribeFolderContentsResponseSuccess
|
355
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeFolderContentsResponseSuccess
|
356
|
+
|
357
|
+
interface _DescribeGroupsResponseSuccess
|
358
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeGroupsResponse]
|
359
|
+
def groups: () -> ::Array[Types::GroupMetadata]
|
360
|
+
def marker: () -> ::String
|
361
|
+
end
|
362
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_groups-instance_method
|
363
|
+
def describe_groups: (
|
364
|
+
?authentication_token: ::String,
|
365
|
+
search_query: ::String,
|
366
|
+
?organization_id: ::String,
|
367
|
+
?marker: ::String,
|
368
|
+
?limit: ::Integer
|
369
|
+
) -> _DescribeGroupsResponseSuccess
|
370
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeGroupsResponseSuccess
|
371
|
+
|
372
|
+
interface _DescribeNotificationSubscriptionsResponseSuccess
|
373
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeNotificationSubscriptionsResponse]
|
374
|
+
def subscriptions: () -> ::Array[Types::Subscription]
|
375
|
+
def marker: () -> ::String
|
376
|
+
end
|
377
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_notification_subscriptions-instance_method
|
378
|
+
def describe_notification_subscriptions: (
|
379
|
+
organization_id: ::String,
|
380
|
+
?marker: ::String,
|
381
|
+
?limit: ::Integer
|
382
|
+
) -> _DescribeNotificationSubscriptionsResponseSuccess
|
383
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeNotificationSubscriptionsResponseSuccess
|
384
|
+
|
385
|
+
interface _DescribeResourcePermissionsResponseSuccess
|
386
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeResourcePermissionsResponse]
|
387
|
+
def principals: () -> ::Array[Types::Principal]
|
388
|
+
def marker: () -> ::String
|
389
|
+
end
|
390
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_resource_permissions-instance_method
|
391
|
+
def describe_resource_permissions: (
|
392
|
+
?authentication_token: ::String,
|
393
|
+
resource_id: ::String,
|
394
|
+
?principal_id: ::String,
|
395
|
+
?limit: ::Integer,
|
396
|
+
?marker: ::String
|
397
|
+
) -> _DescribeResourcePermissionsResponseSuccess
|
398
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeResourcePermissionsResponseSuccess
|
399
|
+
|
400
|
+
interface _DescribeRootFoldersResponseSuccess
|
401
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeRootFoldersResponse]
|
402
|
+
def folders: () -> ::Array[Types::FolderMetadata]
|
403
|
+
def marker: () -> ::String
|
404
|
+
end
|
405
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_root_folders-instance_method
|
406
|
+
def describe_root_folders: (
|
407
|
+
authentication_token: ::String,
|
408
|
+
?limit: ::Integer,
|
409
|
+
?marker: ::String
|
410
|
+
) -> _DescribeRootFoldersResponseSuccess
|
411
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRootFoldersResponseSuccess
|
412
|
+
|
413
|
+
interface _DescribeUsersResponseSuccess
|
414
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeUsersResponse]
|
415
|
+
def users: () -> ::Array[Types::User]
|
416
|
+
def total_number_of_users: () -> ::Integer
|
417
|
+
def marker: () -> ::String
|
418
|
+
end
|
419
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#describe_users-instance_method
|
420
|
+
def describe_users: (
|
421
|
+
?authentication_token: ::String,
|
422
|
+
?organization_id: ::String,
|
423
|
+
?user_ids: ::String,
|
424
|
+
?query: ::String,
|
425
|
+
?include: ("ALL" | "ACTIVE_PENDING"),
|
426
|
+
?order: ("ASCENDING" | "DESCENDING"),
|
427
|
+
?sort: ("USER_NAME" | "FULL_NAME" | "STORAGE_LIMIT" | "USER_STATUS" | "STORAGE_USED"),
|
428
|
+
?marker: ::String,
|
429
|
+
?limit: ::Integer,
|
430
|
+
?fields: ::String
|
431
|
+
) -> _DescribeUsersResponseSuccess
|
432
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeUsersResponseSuccess
|
433
|
+
|
434
|
+
interface _GetCurrentUserResponseSuccess
|
435
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCurrentUserResponse]
|
436
|
+
def user: () -> Types::User
|
437
|
+
end
|
438
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_current_user-instance_method
|
439
|
+
def get_current_user: (
|
440
|
+
authentication_token: ::String
|
441
|
+
) -> _GetCurrentUserResponseSuccess
|
442
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCurrentUserResponseSuccess
|
443
|
+
|
444
|
+
interface _GetDocumentResponseSuccess
|
445
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDocumentResponse]
|
446
|
+
def metadata: () -> Types::DocumentMetadata
|
447
|
+
def custom_metadata: () -> ::Hash[::String, ::String]
|
448
|
+
end
|
449
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_document-instance_method
|
450
|
+
def get_document: (
|
451
|
+
?authentication_token: ::String,
|
452
|
+
document_id: ::String,
|
453
|
+
?include_custom_metadata: bool
|
454
|
+
) -> _GetDocumentResponseSuccess
|
455
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDocumentResponseSuccess
|
456
|
+
|
457
|
+
interface _GetDocumentPathResponseSuccess
|
458
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDocumentPathResponse]
|
459
|
+
def path: () -> Types::ResourcePath
|
460
|
+
end
|
461
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_document_path-instance_method
|
462
|
+
def get_document_path: (
|
463
|
+
?authentication_token: ::String,
|
464
|
+
document_id: ::String,
|
465
|
+
?limit: ::Integer,
|
466
|
+
?fields: ::String,
|
467
|
+
?marker: ::String
|
468
|
+
) -> _GetDocumentPathResponseSuccess
|
469
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDocumentPathResponseSuccess
|
470
|
+
|
471
|
+
interface _GetDocumentVersionResponseSuccess
|
472
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetDocumentVersionResponse]
|
473
|
+
def metadata: () -> Types::DocumentVersionMetadata
|
474
|
+
def custom_metadata: () -> ::Hash[::String, ::String]
|
475
|
+
end
|
476
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_document_version-instance_method
|
477
|
+
def get_document_version: (
|
478
|
+
?authentication_token: ::String,
|
479
|
+
document_id: ::String,
|
480
|
+
version_id: ::String,
|
481
|
+
?fields: ::String,
|
482
|
+
?include_custom_metadata: bool
|
483
|
+
) -> _GetDocumentVersionResponseSuccess
|
484
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDocumentVersionResponseSuccess
|
485
|
+
|
486
|
+
interface _GetFolderResponseSuccess
|
487
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFolderResponse]
|
488
|
+
def metadata: () -> Types::FolderMetadata
|
489
|
+
def custom_metadata: () -> ::Hash[::String, ::String]
|
490
|
+
end
|
491
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_folder-instance_method
|
492
|
+
def get_folder: (
|
493
|
+
?authentication_token: ::String,
|
494
|
+
folder_id: ::String,
|
495
|
+
?include_custom_metadata: bool
|
496
|
+
) -> _GetFolderResponseSuccess
|
497
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFolderResponseSuccess
|
498
|
+
|
499
|
+
interface _GetFolderPathResponseSuccess
|
500
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFolderPathResponse]
|
501
|
+
def path: () -> Types::ResourcePath
|
502
|
+
end
|
503
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_folder_path-instance_method
|
504
|
+
def get_folder_path: (
|
505
|
+
?authentication_token: ::String,
|
506
|
+
folder_id: ::String,
|
507
|
+
?limit: ::Integer,
|
508
|
+
?fields: ::String,
|
509
|
+
?marker: ::String
|
510
|
+
) -> _GetFolderPathResponseSuccess
|
511
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFolderPathResponseSuccess
|
512
|
+
|
513
|
+
interface _GetResourcesResponseSuccess
|
514
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetResourcesResponse]
|
515
|
+
def folders: () -> ::Array[Types::FolderMetadata]
|
516
|
+
def documents: () -> ::Array[Types::DocumentMetadata]
|
517
|
+
def marker: () -> ::String
|
518
|
+
end
|
519
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#get_resources-instance_method
|
520
|
+
def get_resources: (
|
521
|
+
?authentication_token: ::String,
|
522
|
+
?user_id: ::String,
|
523
|
+
?collection_type: ("SHARED_WITH_ME"),
|
524
|
+
?limit: ::Integer,
|
525
|
+
?marker: ::String
|
526
|
+
) -> _GetResourcesResponseSuccess
|
527
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetResourcesResponseSuccess
|
528
|
+
|
529
|
+
interface _InitiateDocumentVersionUploadResponseSuccess
|
530
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::InitiateDocumentVersionUploadResponse]
|
531
|
+
def metadata: () -> Types::DocumentMetadata
|
532
|
+
def upload_metadata: () -> Types::UploadMetadata
|
533
|
+
end
|
534
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#initiate_document_version_upload-instance_method
|
535
|
+
def initiate_document_version_upload: (
|
536
|
+
?authentication_token: ::String,
|
537
|
+
?id: ::String,
|
538
|
+
?name: ::String,
|
539
|
+
?content_created_timestamp: ::Time,
|
540
|
+
?content_modified_timestamp: ::Time,
|
541
|
+
?content_type: ::String,
|
542
|
+
?document_size_in_bytes: ::Integer,
|
543
|
+
?parent_folder_id: ::String
|
544
|
+
) -> _InitiateDocumentVersionUploadResponseSuccess
|
545
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _InitiateDocumentVersionUploadResponseSuccess
|
546
|
+
|
547
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#remove_all_resource_permissions-instance_method
|
548
|
+
def remove_all_resource_permissions: (
|
549
|
+
?authentication_token: ::String,
|
550
|
+
resource_id: ::String
|
551
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
552
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
553
|
+
|
554
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#remove_resource_permission-instance_method
|
555
|
+
def remove_resource_permission: (
|
556
|
+
?authentication_token: ::String,
|
557
|
+
resource_id: ::String,
|
558
|
+
principal_id: ::String,
|
559
|
+
?principal_type: ("USER" | "GROUP" | "INVITE" | "ANONYMOUS" | "ORGANIZATION")
|
560
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
561
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
562
|
+
|
563
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#restore_document_versions-instance_method
|
564
|
+
def restore_document_versions: (
|
565
|
+
?authentication_token: ::String,
|
566
|
+
document_id: ::String
|
567
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
568
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
569
|
+
|
570
|
+
interface _SearchResourcesResponseSuccess
|
571
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchResourcesResponse]
|
572
|
+
def items: () -> ::Array[Types::ResponseItem]
|
573
|
+
def marker: () -> ::String
|
574
|
+
end
|
575
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#search_resources-instance_method
|
576
|
+
def search_resources: (
|
577
|
+
?authentication_token: ::String,
|
578
|
+
?query_text: ::String,
|
579
|
+
?query_scopes: Array[("NAME" | "CONTENT")],
|
580
|
+
?organization_id: ::String,
|
581
|
+
?additional_response_fields: Array[("WEBURL")],
|
582
|
+
?filters: {
|
583
|
+
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")]?,
|
584
|
+
content_categories: Array[("IMAGE" | "DOCUMENT" | "PDF" | "SPREADSHEET" | "PRESENTATION" | "AUDIO" | "VIDEO" | "SOURCE_CODE" | "OTHER")]?,
|
585
|
+
resource_types: Array[("FOLDER" | "DOCUMENT" | "COMMENT" | "DOCUMENT_VERSION")]?,
|
586
|
+
labels: Array[::String]?,
|
587
|
+
principals: Array[
|
588
|
+
{
|
589
|
+
id: ::String,
|
590
|
+
roles: Array[("VIEWER" | "CONTRIBUTOR" | "OWNER" | "COOWNER")]?
|
591
|
+
},
|
592
|
+
]?,
|
593
|
+
ancestor_ids: Array[::String]?,
|
594
|
+
search_collection_types: Array[("OWNED" | "SHARED_WITH_ME")]?,
|
595
|
+
size_range: {
|
596
|
+
start_value: ::Integer?,
|
597
|
+
end_value: ::Integer?
|
598
|
+
}?,
|
599
|
+
created_range: {
|
600
|
+
start_value: ::Time?,
|
601
|
+
end_value: ::Time?
|
602
|
+
}?,
|
603
|
+
modified_range: {
|
604
|
+
start_value: ::Time?,
|
605
|
+
end_value: ::Time?
|
606
|
+
}?
|
607
|
+
},
|
608
|
+
?order_by: Array[
|
609
|
+
{
|
610
|
+
field: ("RELEVANCE" | "NAME" | "SIZE" | "CREATED_TIMESTAMP" | "MODIFIED_TIMESTAMP")?,
|
611
|
+
order: ("ASC" | "DESC")?
|
612
|
+
},
|
613
|
+
],
|
614
|
+
?limit: ::Integer,
|
615
|
+
?marker: ::String
|
616
|
+
) -> _SearchResourcesResponseSuccess
|
617
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchResourcesResponseSuccess
|
618
|
+
|
619
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#update_document-instance_method
|
620
|
+
def update_document: (
|
621
|
+
?authentication_token: ::String,
|
622
|
+
document_id: ::String,
|
623
|
+
?name: ::String,
|
624
|
+
?parent_folder_id: ::String,
|
625
|
+
?resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
626
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
627
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
628
|
+
|
629
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#update_document_version-instance_method
|
630
|
+
def update_document_version: (
|
631
|
+
?authentication_token: ::String,
|
632
|
+
document_id: ::String,
|
633
|
+
version_id: ::String,
|
634
|
+
?version_status: ("ACTIVE")
|
635
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
636
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
637
|
+
|
638
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#update_folder-instance_method
|
639
|
+
def update_folder: (
|
640
|
+
?authentication_token: ::String,
|
641
|
+
folder_id: ::String,
|
642
|
+
?name: ::String,
|
643
|
+
?parent_folder_id: ::String,
|
644
|
+
?resource_state: ("ACTIVE" | "RESTORING" | "RECYCLING" | "RECYCLED")
|
645
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
646
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
647
|
+
|
648
|
+
interface _UpdateUserResponseSuccess
|
649
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateUserResponse]
|
650
|
+
def user: () -> Types::User
|
651
|
+
end
|
652
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs/Client.html#update_user-instance_method
|
653
|
+
def update_user: (
|
654
|
+
?authentication_token: ::String,
|
655
|
+
user_id: ::String,
|
656
|
+
?given_name: ::String,
|
657
|
+
?surname: ::String,
|
658
|
+
?type: ("USER" | "ADMIN" | "POWERUSER" | "MINIMALUSER" | "WORKSPACESUSER"),
|
659
|
+
?storage_rule: {
|
660
|
+
storage_allocated_in_bytes: ::Integer?,
|
661
|
+
storage_type: ("UNLIMITED" | "QUOTA")?
|
662
|
+
},
|
663
|
+
?time_zone_id: ::String,
|
664
|
+
?locale: ("en" | "fr" | "ko" | "de" | "es" | "ja" | "ru" | "zh_CN" | "zh_TW" | "pt_BR" | "default"),
|
665
|
+
?grant_poweruser_privileges: ("TRUE" | "FALSE")
|
666
|
+
) -> _UpdateUserResponseSuccess
|
667
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserResponseSuccess
|
668
|
+
end
|
669
|
+
end
|
670
|
+
end
|
671
|
+
|