aws-sdk-workdocs 1.16.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workdocs.rb +7 -4
- data/lib/aws-sdk-workdocs/client.rb +142 -121
- data/lib/aws-sdk-workdocs/client_api.rb +4 -0
- data/lib/aws-sdk-workdocs/errors.rb +65 -21
- data/lib/aws-sdk-workdocs/resource.rb +7 -0
- data/lib/aws-sdk-workdocs/types.rb +84 -111
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d77d4bcf2d2f21de41597b348508cfcabaa50334
|
4
|
+
data.tar.gz: f085a275c315ae9f69e0df80ee20bcccbf88dd81
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 79548abfaa2829dcd7b2dc010431251580564c0994be8698086cc8fe4f4d35642ca61374d8b7e96172444dad6daa14e3fc3b672ff2f6593a9bfb3599053f6ab3
|
7
|
+
data.tar.gz: 7695d30807a99575789c30848c672b40605a0262cee4a8908c3ec47ce4d5235ceff87d4f1e574604a04c16078a6250874b2e0c84bdf2efe331f0f038ea2f59bd
|
data/lib/aws-sdk-workdocs.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-workdocs/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# work_docs = Aws::WorkDocs::Client.new
|
28
|
+
# resp = work_docs.abort_document_version_upload(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon WorkDocs
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon WorkDocs are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::WorkDocs::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon WorkDocs API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-workdocs/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::WorkDocs
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.21.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:workdocs)
|
31
31
|
|
32
32
|
module Aws::WorkDocs
|
33
|
+
# An API client for WorkDocs. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::WorkDocs::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -108,6 +120,12 @@ module Aws::WorkDocs
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::WorkDocs
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -166,15 +188,29 @@ module Aws::WorkDocs
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,26 @@ module Aws::WorkDocs
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
233
|
+
# no retry mode is provided.
|
234
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
235
|
+
# This includes support for retry quotas, which limit the number of
|
236
|
+
# unsuccessful retries a client can make.
|
237
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
238
|
+
# functionality of `standard` mode along with automatic client side
|
239
|
+
# throttling. This is a provisional mode that may change behavior
|
240
|
+
# in the future.
|
190
241
|
#
|
191
242
|
# @option options [String] :secret_access_key
|
192
243
|
#
|
@@ -209,16 +260,16 @@ module Aws::WorkDocs
|
|
209
260
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
261
|
#
|
211
262
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
263
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
264
|
# `Timeout::Error`.
|
214
265
|
#
|
215
266
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
267
|
# number of seconds to wait for response data. This value can
|
217
268
|
# safely be set
|
218
|
-
# per-request on the session
|
269
|
+
# per-request on the session yielded by {#session_for}.
|
219
270
|
#
|
220
271
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
272
|
+
# seconds a connection is allowed to sit idle before it is
|
222
273
|
# considered stale. Stale connections are closed and removed
|
223
274
|
# from the pool before making a request.
|
224
275
|
#
|
@@ -227,7 +278,7 @@ module Aws::WorkDocs
|
|
227
278
|
# request body. This option has no effect unless the request has
|
228
279
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
280
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
281
|
+
# request on the session yielded by {#session_for}.
|
231
282
|
#
|
232
283
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
284
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -260,9 +311,8 @@ module Aws::WorkDocs
|
|
260
311
|
# document version, or fails to do so.
|
261
312
|
#
|
262
313
|
# @option params [String] :authentication_token
|
263
|
-
# Amazon WorkDocs authentication token.
|
264
|
-
#
|
265
|
-
# credentials.
|
314
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
315
|
+
# administrator credentials to access the API.
|
266
316
|
#
|
267
317
|
# @option params [required, String] :document_id
|
268
318
|
# The ID of the document.
|
@@ -296,9 +346,8 @@ module Aws::WorkDocs
|
|
296
346
|
# The ID of the user.
|
297
347
|
#
|
298
348
|
# @option params [String] :authentication_token
|
299
|
-
# Amazon WorkDocs authentication token.
|
300
|
-
#
|
301
|
-
# credentials.
|
349
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
350
|
+
# administrator credentials to access the API.
|
302
351
|
#
|
303
352
|
# @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
304
353
|
#
|
@@ -345,9 +394,8 @@ module Aws::WorkDocs
|
|
345
394
|
# different permissions.
|
346
395
|
#
|
347
396
|
# @option params [String] :authentication_token
|
348
|
-
# Amazon WorkDocs authentication token.
|
349
|
-
#
|
350
|
-
# credentials.
|
397
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
398
|
+
# administrator credentials to access the API.
|
351
399
|
#
|
352
400
|
# @option params [required, String] :resource_id
|
353
401
|
# The ID of the resource.
|
@@ -402,9 +450,8 @@ module Aws::WorkDocs
|
|
402
450
|
# Adds a new comment to the specified document version.
|
403
451
|
#
|
404
452
|
# @option params [String] :authentication_token
|
405
|
-
# Amazon WorkDocs authentication token.
|
406
|
-
#
|
407
|
-
# credentials.
|
453
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
454
|
+
# administrator credentials to access the API.
|
408
455
|
#
|
409
456
|
# @option params [required, String] :document_id
|
410
457
|
# The ID of the document.
|
@@ -489,9 +536,8 @@ module Aws::WorkDocs
|
|
489
536
|
# folder, document, or version).
|
490
537
|
#
|
491
538
|
# @option params [String] :authentication_token
|
492
|
-
# Amazon WorkDocs authentication token.
|
493
|
-
#
|
494
|
-
# credentials.
|
539
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
540
|
+
# administrator credentials to access the API.
|
495
541
|
#
|
496
542
|
# @option params [required, String] :resource_id
|
497
543
|
# The ID of the resource.
|
@@ -528,9 +574,8 @@ module Aws::WorkDocs
|
|
528
574
|
# Creates a folder with the specified name and parent folder.
|
529
575
|
#
|
530
576
|
# @option params [String] :authentication_token
|
531
|
-
# Amazon WorkDocs authentication token.
|
532
|
-
#
|
533
|
-
# credentials.
|
577
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
578
|
+
# administrator credentials to access the API.
|
534
579
|
#
|
535
580
|
# @option params [String] :name
|
536
581
|
# The name of the new folder.
|
@@ -584,9 +629,8 @@ module Aws::WorkDocs
|
|
584
629
|
# List of labels to add to the resource.
|
585
630
|
#
|
586
631
|
# @option params [String] :authentication_token
|
587
|
-
# Amazon WorkDocs authentication token.
|
588
|
-
#
|
589
|
-
# credentials.
|
632
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
633
|
+
# administrator credentials to access the API.
|
590
634
|
#
|
591
635
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
592
636
|
#
|
@@ -689,9 +733,8 @@ module Aws::WorkDocs
|
|
689
733
|
# The amount of storage for the user.
|
690
734
|
#
|
691
735
|
# @option params [String] :authentication_token
|
692
|
-
# Amazon WorkDocs authentication token.
|
693
|
-
#
|
694
|
-
# credentials.
|
736
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
737
|
+
# administrator credentials to access the API.
|
695
738
|
#
|
696
739
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
697
740
|
#
|
@@ -750,9 +793,8 @@ module Aws::WorkDocs
|
|
750
793
|
# The ID of the user.
|
751
794
|
#
|
752
795
|
# @option params [String] :authentication_token
|
753
|
-
# Amazon WorkDocs authentication token.
|
754
|
-
#
|
755
|
-
# credentials.
|
796
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
797
|
+
# administrator credentials to access the API.
|
756
798
|
#
|
757
799
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
758
800
|
#
|
@@ -775,9 +817,8 @@ module Aws::WorkDocs
|
|
775
817
|
# Deletes the specified comment from the document version.
|
776
818
|
#
|
777
819
|
# @option params [String] :authentication_token
|
778
|
-
# Amazon WorkDocs authentication token.
|
779
|
-
#
|
780
|
-
# credentials.
|
820
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
821
|
+
# administrator credentials to access the API.
|
781
822
|
#
|
782
823
|
# @option params [required, String] :document_id
|
783
824
|
# The ID of the document.
|
@@ -811,9 +852,8 @@ module Aws::WorkDocs
|
|
811
852
|
# Deletes custom metadata from the specified resource.
|
812
853
|
#
|
813
854
|
# @option params [String] :authentication_token
|
814
|
-
# Amazon WorkDocs authentication token.
|
815
|
-
#
|
816
|
-
# credentials.
|
855
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
856
|
+
# administrator credentials to access the API.
|
817
857
|
#
|
818
858
|
# @option params [required, String] :resource_id
|
819
859
|
# The ID of the resource, either a document or folder.
|
@@ -854,9 +894,8 @@ module Aws::WorkDocs
|
|
854
894
|
# metadata.
|
855
895
|
#
|
856
896
|
# @option params [String] :authentication_token
|
857
|
-
# Amazon WorkDocs authentication token.
|
858
|
-
#
|
859
|
-
# credentials.
|
897
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
898
|
+
# administrator credentials to access the API.
|
860
899
|
#
|
861
900
|
# @option params [required, String] :document_id
|
862
901
|
# The ID of the document.
|
@@ -882,9 +921,8 @@ module Aws::WorkDocs
|
|
882
921
|
# Permanently deletes the specified folder and its contents.
|
883
922
|
#
|
884
923
|
# @option params [String] :authentication_token
|
885
|
-
# Amazon WorkDocs authentication token.
|
886
|
-
#
|
887
|
-
# credentials.
|
924
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
925
|
+
# administrator credentials to access the API.
|
888
926
|
#
|
889
927
|
# @option params [required, String] :folder_id
|
890
928
|
# The ID of the folder.
|
@@ -910,9 +948,8 @@ module Aws::WorkDocs
|
|
910
948
|
# Deletes the contents of the specified folder.
|
911
949
|
#
|
912
950
|
# @option params [String] :authentication_token
|
913
|
-
# Amazon WorkDocs authentication token.
|
914
|
-
#
|
915
|
-
# credentials.
|
951
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
952
|
+
# administrator credentials to access the API.
|
916
953
|
#
|
917
954
|
# @option params [required, String] :folder_id
|
918
955
|
# The ID of the folder.
|
@@ -941,9 +978,8 @@ module Aws::WorkDocs
|
|
941
978
|
# The ID of the resource.
|
942
979
|
#
|
943
980
|
# @option params [String] :authentication_token
|
944
|
-
# Amazon WorkDocs authentication token.
|
945
|
-
#
|
946
|
-
# credentials.
|
981
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
982
|
+
# administrator credentials to access the API.
|
947
983
|
#
|
948
984
|
# @option params [Array<String>] :labels
|
949
985
|
# List of labels to delete from the resource.
|
@@ -1028,9 +1064,8 @@ module Aws::WorkDocs
|
|
1028
1064
|
# Describes the user activities in a specified time period.
|
1029
1065
|
#
|
1030
1066
|
# @option params [String] :authentication_token
|
1031
|
-
# Amazon WorkDocs authentication token.
|
1032
|
-
#
|
1033
|
-
# credentials.
|
1067
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1068
|
+
# administrator credentials to access the API.
|
1034
1069
|
#
|
1035
1070
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1036
1071
|
# The timestamp that determines the starting time of the activities. The
|
@@ -1168,9 +1203,8 @@ module Aws::WorkDocs
|
|
1168
1203
|
# List all the comments for the specified document version.
|
1169
1204
|
#
|
1170
1205
|
# @option params [String] :authentication_token
|
1171
|
-
# Amazon WorkDocs authentication token.
|
1172
|
-
#
|
1173
|
-
# credentials.
|
1206
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1207
|
+
# administrator credentials to access the API.
|
1174
1208
|
#
|
1175
1209
|
# @option params [required, String] :document_id
|
1176
1210
|
# The ID of the document.
|
@@ -1244,9 +1278,8 @@ module Aws::WorkDocs
|
|
1244
1278
|
# By default, only active versions are returned.
|
1245
1279
|
#
|
1246
1280
|
# @option params [String] :authentication_token
|
1247
|
-
# Amazon WorkDocs authentication token.
|
1248
|
-
#
|
1249
|
-
# credentials.
|
1281
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1282
|
+
# administrator credentials to access the API.
|
1250
1283
|
#
|
1251
1284
|
# @option params [required, String] :document_id
|
1252
1285
|
# The ID of the document.
|
@@ -1320,9 +1353,8 @@ module Aws::WorkDocs
|
|
1320
1353
|
# You can also request initialized documents.
|
1321
1354
|
#
|
1322
1355
|
# @option params [String] :authentication_token
|
1323
|
-
# Amazon WorkDocs authentication token.
|
1324
|
-
#
|
1325
|
-
# credentials.
|
1356
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1357
|
+
# administrator credentials to access the API.
|
1326
1358
|
#
|
1327
1359
|
# @option params [required, String] :folder_id
|
1328
1360
|
# The ID of the folder.
|
@@ -1420,9 +1452,8 @@ module Aws::WorkDocs
|
|
1420
1452
|
# underlying Active Directory.
|
1421
1453
|
#
|
1422
1454
|
# @option params [String] :authentication_token
|
1423
|
-
# Amazon WorkDocs authentication token.
|
1424
|
-
#
|
1425
|
-
# credentials.
|
1455
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1456
|
+
# administrator credentials to access the API.
|
1426
1457
|
#
|
1427
1458
|
# @option params [required, String] :search_query
|
1428
1459
|
# A query to describe groups by group name.
|
@@ -1513,9 +1544,8 @@ module Aws::WorkDocs
|
|
1513
1544
|
# Describes the permissions of a specified resource.
|
1514
1545
|
#
|
1515
1546
|
# @option params [String] :authentication_token
|
1516
|
-
# Amazon WorkDocs authentication token.
|
1517
|
-
#
|
1518
|
-
# credentials.
|
1547
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1548
|
+
# administrator credentials to access the API.
|
1519
1549
|
#
|
1520
1550
|
# @option params [required, String] :resource_id
|
1521
1551
|
# The ID of the resource.
|
@@ -1579,9 +1609,7 @@ module Aws::WorkDocs
|
|
1579
1609
|
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
|
1580
1610
|
#
|
1581
1611
|
# @option params [required, String] :authentication_token
|
1582
|
-
# Amazon WorkDocs authentication token.
|
1583
|
-
# administrative API actions, as in accessing the API using AWS
|
1584
|
-
# credentials.
|
1612
|
+
# Amazon WorkDocs authentication token.
|
1585
1613
|
#
|
1586
1614
|
# @option params [Integer] :limit
|
1587
1615
|
# The maximum number of items to return.
|
@@ -1637,9 +1665,8 @@ module Aws::WorkDocs
|
|
1637
1665
|
# you can use to request the next set of results.
|
1638
1666
|
#
|
1639
1667
|
# @option params [String] :authentication_token
|
1640
|
-
# Amazon WorkDocs authentication token.
|
1641
|
-
#
|
1642
|
-
# credentials.
|
1668
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1669
|
+
# administrator credentials to access the API.
|
1643
1670
|
#
|
1644
1671
|
# @option params [String] :organization_id
|
1645
1672
|
# The ID of the organization.
|
@@ -1727,10 +1754,17 @@ module Aws::WorkDocs
|
|
1727
1754
|
# token was generated. This is not a valid action for SigV4
|
1728
1755
|
# (administrative API) clients.
|
1729
1756
|
#
|
1757
|
+
# This action requires an authentication token. To get an authentication
|
1758
|
+
# token, register an application with Amazon WorkDocs. For more
|
1759
|
+
# information, see [Authentication and Access Control for User
|
1760
|
+
# Applications][1] in the *Amazon WorkDocs Developer Guide*.
|
1761
|
+
#
|
1762
|
+
#
|
1763
|
+
#
|
1764
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
|
1765
|
+
#
|
1730
1766
|
# @option params [required, String] :authentication_token
|
1731
|
-
# Amazon WorkDocs authentication token.
|
1732
|
-
# administrative API actions, as in accessing the API using AWS
|
1733
|
-
# credentials.
|
1767
|
+
# Amazon WorkDocs authentication token.
|
1734
1768
|
#
|
1735
1769
|
# @return [Types::GetCurrentUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1736
1770
|
#
|
@@ -1774,9 +1808,8 @@ module Aws::WorkDocs
|
|
1774
1808
|
# Retrieves details of a document.
|
1775
1809
|
#
|
1776
1810
|
# @option params [String] :authentication_token
|
1777
|
-
# Amazon WorkDocs authentication token.
|
1778
|
-
#
|
1779
|
-
# credentials.
|
1811
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1812
|
+
# administrator credentials to access the API.
|
1780
1813
|
#
|
1781
1814
|
# @option params [required, String] :document_id
|
1782
1815
|
# The ID of the document.
|
@@ -1843,9 +1876,8 @@ module Aws::WorkDocs
|
|
1843
1876
|
# can also request the names of the parent folders.
|
1844
1877
|
#
|
1845
1878
|
# @option params [String] :authentication_token
|
1846
|
-
# Amazon WorkDocs authentication token.
|
1847
|
-
#
|
1848
|
-
# credentials.
|
1879
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1880
|
+
# administrator credentials to access the API.
|
1849
1881
|
#
|
1850
1882
|
# @option params [required, String] :document_id
|
1851
1883
|
# The ID of the document.
|
@@ -1892,9 +1924,8 @@ module Aws::WorkDocs
|
|
1892
1924
|
# Retrieves version metadata for the specified document.
|
1893
1925
|
#
|
1894
1926
|
# @option params [String] :authentication_token
|
1895
|
-
# Amazon WorkDocs authentication token.
|
1896
|
-
#
|
1897
|
-
# credentials.
|
1927
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1928
|
+
# administrator credentials to access the API.
|
1898
1929
|
#
|
1899
1930
|
# @option params [required, String] :document_id
|
1900
1931
|
# The ID of the document.
|
@@ -1956,9 +1987,8 @@ module Aws::WorkDocs
|
|
1956
1987
|
# Retrieves the metadata of the specified folder.
|
1957
1988
|
#
|
1958
1989
|
# @option params [String] :authentication_token
|
1959
|
-
# Amazon WorkDocs authentication token.
|
1960
|
-
#
|
1961
|
-
# credentials.
|
1990
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1991
|
+
# administrator credentials to access the API.
|
1962
1992
|
#
|
1963
1993
|
# @option params [required, String] :folder_id
|
1964
1994
|
# The ID of the folder.
|
@@ -2014,9 +2044,8 @@ module Aws::WorkDocs
|
|
2014
2044
|
# can also request the parent folder names.
|
2015
2045
|
#
|
2016
2046
|
# @option params [String] :authentication_token
|
2017
|
-
# Amazon WorkDocs authentication token.
|
2018
|
-
#
|
2019
|
-
# credentials.
|
2047
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2048
|
+
# administrator credentials to access the API.
|
2020
2049
|
#
|
2021
2050
|
# @option params [required, String] :folder_id
|
2022
2051
|
# The ID of the folder.
|
@@ -2064,9 +2093,8 @@ module Aws::WorkDocs
|
|
2064
2093
|
# The only `CollectionType` supported is `SHARED_WITH_ME`.
|
2065
2094
|
#
|
2066
2095
|
# @option params [String] :authentication_token
|
2067
|
-
# The Amazon WorkDocs authentication token.
|
2068
|
-
#
|
2069
|
-
# using AWS credentials.
|
2096
|
+
# The Amazon WorkDocs authentication token. Not required when using AWS
|
2097
|
+
# administrator credentials to access the API.
|
2070
2098
|
#
|
2071
2099
|
# @option params [String] :user_id
|
2072
2100
|
# The user ID for the resource collection. This is a required field for
|
@@ -2159,9 +2187,8 @@ module Aws::WorkDocs
|
|
2159
2187
|
# To cancel the document upload, call AbortDocumentVersionUpload.
|
2160
2188
|
#
|
2161
2189
|
# @option params [String] :authentication_token
|
2162
|
-
# Amazon WorkDocs authentication token.
|
2163
|
-
#
|
2164
|
-
# credentials.
|
2190
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2191
|
+
# administrator credentials to access the API.
|
2165
2192
|
#
|
2166
2193
|
# @option params [String] :id
|
2167
2194
|
# The ID of the document.
|
@@ -2243,9 +2270,8 @@ module Aws::WorkDocs
|
|
2243
2270
|
# Removes all the permissions from the specified resource.
|
2244
2271
|
#
|
2245
2272
|
# @option params [String] :authentication_token
|
2246
|
-
# Amazon WorkDocs authentication token.
|
2247
|
-
#
|
2248
|
-
# credentials.
|
2273
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2274
|
+
# administrator credentials to access the API.
|
2249
2275
|
#
|
2250
2276
|
# @option params [required, String] :resource_id
|
2251
2277
|
# The ID of the resource.
|
@@ -2272,9 +2298,8 @@ module Aws::WorkDocs
|
|
2272
2298
|
# resource.
|
2273
2299
|
#
|
2274
2300
|
# @option params [String] :authentication_token
|
2275
|
-
# Amazon WorkDocs authentication token.
|
2276
|
-
#
|
2277
|
-
# credentials.
|
2301
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2302
|
+
# administrator credentials to access the API.
|
2278
2303
|
#
|
2279
2304
|
# @option params [required, String] :resource_id
|
2280
2305
|
# The ID of the resource.
|
@@ -2309,9 +2334,8 @@ module Aws::WorkDocs
|
|
2309
2334
|
# access to both the document and its parent folder, if applicable.
|
2310
2335
|
#
|
2311
2336
|
# @option params [String] :authentication_token
|
2312
|
-
# Amazon WorkDocs authentication token.
|
2313
|
-
#
|
2314
|
-
# credentials.
|
2337
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2338
|
+
# administrator credentials to access the API.
|
2315
2339
|
#
|
2316
2340
|
# @option params [required, String] :document_id
|
2317
2341
|
# The ID of the document.
|
@@ -2355,9 +2379,8 @@ module Aws::WorkDocs
|
|
2355
2379
|
# InitiateDocumentVersionUpload.
|
2356
2380
|
#
|
2357
2381
|
# @option params [String] :authentication_token
|
2358
|
-
# Amazon WorkDocs authentication token.
|
2359
|
-
#
|
2360
|
-
# credentials.
|
2382
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2383
|
+
# administrator credentials to access the API.
|
2361
2384
|
#
|
2362
2385
|
# @option params [required, String] :document_id
|
2363
2386
|
# The ID of the document.
|
@@ -2393,9 +2416,8 @@ module Aws::WorkDocs
|
|
2393
2416
|
# applicable.
|
2394
2417
|
#
|
2395
2418
|
# @option params [String] :authentication_token
|
2396
|
-
# Amazon WorkDocs authentication token.
|
2397
|
-
#
|
2398
|
-
# credentials.
|
2419
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2420
|
+
# administrator credentials to access the API.
|
2399
2421
|
#
|
2400
2422
|
# @option params [required, String] :folder_id
|
2401
2423
|
# The ID of the folder.
|
@@ -2435,9 +2457,8 @@ module Aws::WorkDocs
|
|
2435
2457
|
# revokes administrative privileges to the Amazon WorkDocs site.
|
2436
2458
|
#
|
2437
2459
|
# @option params [String] :authentication_token
|
2438
|
-
# Amazon WorkDocs authentication token.
|
2439
|
-
#
|
2440
|
-
# credentials.
|
2460
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2461
|
+
# administrator credentials to access the API.
|
2441
2462
|
#
|
2442
2463
|
# @option params [required, String] :user_id
|
2443
2464
|
# The ID of the user.
|
@@ -2527,7 +2548,7 @@ module Aws::WorkDocs
|
|
2527
2548
|
params: params,
|
2528
2549
|
config: config)
|
2529
2550
|
context[:gem_name] = 'aws-sdk-workdocs'
|
2530
|
-
context[:gem_version] = '1.
|
2551
|
+
context[:gem_version] = '1.21.0'
|
2531
2552
|
Seahorse::Client::Request.new(handlers, context)
|
2532
2553
|
end
|
2533
2554
|
|