aws-sdk-workdocs 1.19.0 → 1.24.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-workdocs.rb +7 -4
- data/lib/aws-sdk-workdocs/client.rb +157 -125
- 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 +1 -0
- data/lib/aws-sdk-workdocs/types.rb +84 -111
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: f57e75b0bc960d9cf52786fa8f71c6d7dad1fc56f0fbd1c84aa3e577b1a8f35b
|
4
|
+
data.tar.gz: 8a1b05b0ee2b579fcf27dac0b614a4f9c814f21740d4fc7b6431d7dcd05358cb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 97385c53ecd3d827a52405856702bbc02f245853c25897b42d1d0a472673bdfa076aa8cb70d69bed62b196157b998cac7ef04c329b700fe73bd5aef7cfcfa9e5
|
7
|
+
data.tar.gz: 773f74a5bcba152195a0d0eab4ec1eb6630537619ef10da57ccbd565d7b8947a66899688479b965b482fc4778965469825628b49d5d2d74a15e753f0f69cc75b
|
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.24.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:workdocs)
|
31
32
|
|
32
33
|
module Aws::WorkDocs
|
34
|
+
# An API client for WorkDocs. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::WorkDocs::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::WorkDocs
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::WorkDocs
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::WorkDocs
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::WorkDocs
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::WorkDocs
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::WorkDocs
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::WorkDocs
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::WorkDocs
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -209,16 +266,15 @@ module Aws::WorkDocs
|
|
209
266
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
267
|
#
|
211
268
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
269
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
270
|
# `Timeout::Error`.
|
214
271
|
#
|
215
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
273
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
219
275
|
#
|
220
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
277
|
+
# seconds a connection is allowed to sit idle before it is
|
222
278
|
# considered stale. Stale connections are closed and removed
|
223
279
|
# from the pool before making a request.
|
224
280
|
#
|
@@ -227,7 +283,7 @@ module Aws::WorkDocs
|
|
227
283
|
# request body. This option has no effect unless the request has
|
228
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
285
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
286
|
+
# request on the session.
|
231
287
|
#
|
232
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -260,9 +316,8 @@ module Aws::WorkDocs
|
|
260
316
|
# document version, or fails to do so.
|
261
317
|
#
|
262
318
|
# @option params [String] :authentication_token
|
263
|
-
# Amazon WorkDocs authentication token.
|
264
|
-
#
|
265
|
-
# credentials.
|
319
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
320
|
+
# administrator credentials to access the API.
|
266
321
|
#
|
267
322
|
# @option params [required, String] :document_id
|
268
323
|
# The ID of the document.
|
@@ -296,9 +351,8 @@ module Aws::WorkDocs
|
|
296
351
|
# The ID of the user.
|
297
352
|
#
|
298
353
|
# @option params [String] :authentication_token
|
299
|
-
# Amazon WorkDocs authentication token.
|
300
|
-
#
|
301
|
-
# credentials.
|
354
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
355
|
+
# administrator credentials to access the API.
|
302
356
|
#
|
303
357
|
# @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
304
358
|
#
|
@@ -345,9 +399,8 @@ module Aws::WorkDocs
|
|
345
399
|
# different permissions.
|
346
400
|
#
|
347
401
|
# @option params [String] :authentication_token
|
348
|
-
# Amazon WorkDocs authentication token.
|
349
|
-
#
|
350
|
-
# credentials.
|
402
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
403
|
+
# administrator credentials to access the API.
|
351
404
|
#
|
352
405
|
# @option params [required, String] :resource_id
|
353
406
|
# The ID of the resource.
|
@@ -402,9 +455,8 @@ module Aws::WorkDocs
|
|
402
455
|
# Adds a new comment to the specified document version.
|
403
456
|
#
|
404
457
|
# @option params [String] :authentication_token
|
405
|
-
# Amazon WorkDocs authentication token.
|
406
|
-
#
|
407
|
-
# credentials.
|
458
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
459
|
+
# administrator credentials to access the API.
|
408
460
|
#
|
409
461
|
# @option params [required, String] :document_id
|
410
462
|
# The ID of the document.
|
@@ -489,9 +541,8 @@ module Aws::WorkDocs
|
|
489
541
|
# folder, document, or version).
|
490
542
|
#
|
491
543
|
# @option params [String] :authentication_token
|
492
|
-
# Amazon WorkDocs authentication token.
|
493
|
-
#
|
494
|
-
# credentials.
|
544
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
545
|
+
# administrator credentials to access the API.
|
495
546
|
#
|
496
547
|
# @option params [required, String] :resource_id
|
497
548
|
# The ID of the resource.
|
@@ -528,9 +579,8 @@ module Aws::WorkDocs
|
|
528
579
|
# Creates a folder with the specified name and parent folder.
|
529
580
|
#
|
530
581
|
# @option params [String] :authentication_token
|
531
|
-
# Amazon WorkDocs authentication token.
|
532
|
-
#
|
533
|
-
# credentials.
|
582
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
583
|
+
# administrator credentials to access the API.
|
534
584
|
#
|
535
585
|
# @option params [String] :name
|
536
586
|
# The name of the new folder.
|
@@ -584,9 +634,8 @@ module Aws::WorkDocs
|
|
584
634
|
# List of labels to add to the resource.
|
585
635
|
#
|
586
636
|
# @option params [String] :authentication_token
|
587
|
-
# Amazon WorkDocs authentication token.
|
588
|
-
#
|
589
|
-
# credentials.
|
637
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
638
|
+
# administrator credentials to access the API.
|
590
639
|
#
|
591
640
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
592
641
|
#
|
@@ -689,9 +738,8 @@ module Aws::WorkDocs
|
|
689
738
|
# The amount of storage for the user.
|
690
739
|
#
|
691
740
|
# @option params [String] :authentication_token
|
692
|
-
# Amazon WorkDocs authentication token.
|
693
|
-
#
|
694
|
-
# credentials.
|
741
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
742
|
+
# administrator credentials to access the API.
|
695
743
|
#
|
696
744
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
697
745
|
#
|
@@ -750,9 +798,8 @@ module Aws::WorkDocs
|
|
750
798
|
# The ID of the user.
|
751
799
|
#
|
752
800
|
# @option params [String] :authentication_token
|
753
|
-
# Amazon WorkDocs authentication token.
|
754
|
-
#
|
755
|
-
# credentials.
|
801
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
802
|
+
# administrator credentials to access the API.
|
756
803
|
#
|
757
804
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
758
805
|
#
|
@@ -775,9 +822,8 @@ module Aws::WorkDocs
|
|
775
822
|
# Deletes the specified comment from the document version.
|
776
823
|
#
|
777
824
|
# @option params [String] :authentication_token
|
778
|
-
# Amazon WorkDocs authentication token.
|
779
|
-
#
|
780
|
-
# credentials.
|
825
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
826
|
+
# administrator credentials to access the API.
|
781
827
|
#
|
782
828
|
# @option params [required, String] :document_id
|
783
829
|
# The ID of the document.
|
@@ -811,9 +857,8 @@ module Aws::WorkDocs
|
|
811
857
|
# Deletes custom metadata from the specified resource.
|
812
858
|
#
|
813
859
|
# @option params [String] :authentication_token
|
814
|
-
# Amazon WorkDocs authentication token.
|
815
|
-
#
|
816
|
-
# credentials.
|
860
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
861
|
+
# administrator credentials to access the API.
|
817
862
|
#
|
818
863
|
# @option params [required, String] :resource_id
|
819
864
|
# The ID of the resource, either a document or folder.
|
@@ -854,9 +899,8 @@ module Aws::WorkDocs
|
|
854
899
|
# metadata.
|
855
900
|
#
|
856
901
|
# @option params [String] :authentication_token
|
857
|
-
# Amazon WorkDocs authentication token.
|
858
|
-
#
|
859
|
-
# credentials.
|
902
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
903
|
+
# administrator credentials to access the API.
|
860
904
|
#
|
861
905
|
# @option params [required, String] :document_id
|
862
906
|
# The ID of the document.
|
@@ -882,9 +926,8 @@ module Aws::WorkDocs
|
|
882
926
|
# Permanently deletes the specified folder and its contents.
|
883
927
|
#
|
884
928
|
# @option params [String] :authentication_token
|
885
|
-
# Amazon WorkDocs authentication token.
|
886
|
-
#
|
887
|
-
# credentials.
|
929
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
930
|
+
# administrator credentials to access the API.
|
888
931
|
#
|
889
932
|
# @option params [required, String] :folder_id
|
890
933
|
# The ID of the folder.
|
@@ -910,9 +953,8 @@ module Aws::WorkDocs
|
|
910
953
|
# Deletes the contents of the specified folder.
|
911
954
|
#
|
912
955
|
# @option params [String] :authentication_token
|
913
|
-
# Amazon WorkDocs authentication token.
|
914
|
-
#
|
915
|
-
# credentials.
|
956
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
957
|
+
# administrator credentials to access the API.
|
916
958
|
#
|
917
959
|
# @option params [required, String] :folder_id
|
918
960
|
# The ID of the folder.
|
@@ -941,9 +983,8 @@ module Aws::WorkDocs
|
|
941
983
|
# The ID of the resource.
|
942
984
|
#
|
943
985
|
# @option params [String] :authentication_token
|
944
|
-
# Amazon WorkDocs authentication token.
|
945
|
-
#
|
946
|
-
# credentials.
|
986
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
987
|
+
# administrator credentials to access the API.
|
947
988
|
#
|
948
989
|
# @option params [Array<String>] :labels
|
949
990
|
# List of labels to delete from the resource.
|
@@ -1028,9 +1069,8 @@ module Aws::WorkDocs
|
|
1028
1069
|
# Describes the user activities in a specified time period.
|
1029
1070
|
#
|
1030
1071
|
# @option params [String] :authentication_token
|
1031
|
-
# Amazon WorkDocs authentication token.
|
1032
|
-
#
|
1033
|
-
# credentials.
|
1072
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1073
|
+
# administrator credentials to access the API.
|
1034
1074
|
#
|
1035
1075
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1036
1076
|
# The timestamp that determines the starting time of the activities. The
|
@@ -1168,9 +1208,8 @@ module Aws::WorkDocs
|
|
1168
1208
|
# List all the comments for the specified document version.
|
1169
1209
|
#
|
1170
1210
|
# @option params [String] :authentication_token
|
1171
|
-
# Amazon WorkDocs authentication token.
|
1172
|
-
#
|
1173
|
-
# credentials.
|
1211
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1212
|
+
# administrator credentials to access the API.
|
1174
1213
|
#
|
1175
1214
|
# @option params [required, String] :document_id
|
1176
1215
|
# The ID of the document.
|
@@ -1244,9 +1283,8 @@ module Aws::WorkDocs
|
|
1244
1283
|
# By default, only active versions are returned.
|
1245
1284
|
#
|
1246
1285
|
# @option params [String] :authentication_token
|
1247
|
-
# Amazon WorkDocs authentication token.
|
1248
|
-
#
|
1249
|
-
# credentials.
|
1286
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1287
|
+
# administrator credentials to access the API.
|
1250
1288
|
#
|
1251
1289
|
# @option params [required, String] :document_id
|
1252
1290
|
# The ID of the document.
|
@@ -1271,6 +1309,8 @@ module Aws::WorkDocs
|
|
1271
1309
|
# * {Types::DescribeDocumentVersionsResponse#document_versions #document_versions} => Array<Types::DocumentVersionMetadata>
|
1272
1310
|
# * {Types::DescribeDocumentVersionsResponse#marker #marker} => String
|
1273
1311
|
#
|
1312
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1313
|
+
#
|
1274
1314
|
# @example Request syntax with placeholder values
|
1275
1315
|
#
|
1276
1316
|
# resp = client.describe_document_versions({
|
@@ -1320,9 +1360,8 @@ module Aws::WorkDocs
|
|
1320
1360
|
# You can also request initialized documents.
|
1321
1361
|
#
|
1322
1362
|
# @option params [String] :authentication_token
|
1323
|
-
# Amazon WorkDocs authentication token.
|
1324
|
-
#
|
1325
|
-
# credentials.
|
1363
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1364
|
+
# administrator credentials to access the API.
|
1326
1365
|
#
|
1327
1366
|
# @option params [required, String] :folder_id
|
1328
1367
|
# The ID of the folder.
|
@@ -1353,6 +1392,8 @@ module Aws::WorkDocs
|
|
1353
1392
|
# * {Types::DescribeFolderContentsResponse#documents #documents} => Array<Types::DocumentMetadata>
|
1354
1393
|
# * {Types::DescribeFolderContentsResponse#marker #marker} => String
|
1355
1394
|
#
|
1395
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1396
|
+
#
|
1356
1397
|
# @example Request syntax with placeholder values
|
1357
1398
|
#
|
1358
1399
|
# resp = client.describe_folder_contents({
|
@@ -1420,9 +1461,8 @@ module Aws::WorkDocs
|
|
1420
1461
|
# underlying Active Directory.
|
1421
1462
|
#
|
1422
1463
|
# @option params [String] :authentication_token
|
1423
|
-
# Amazon WorkDocs authentication token.
|
1424
|
-
#
|
1425
|
-
# credentials.
|
1464
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1465
|
+
# administrator credentials to access the API.
|
1426
1466
|
#
|
1427
1467
|
# @option params [required, String] :search_query
|
1428
1468
|
# A query to describe groups by group name.
|
@@ -1513,9 +1553,8 @@ module Aws::WorkDocs
|
|
1513
1553
|
# Describes the permissions of a specified resource.
|
1514
1554
|
#
|
1515
1555
|
# @option params [String] :authentication_token
|
1516
|
-
# Amazon WorkDocs authentication token.
|
1517
|
-
#
|
1518
|
-
# credentials.
|
1556
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1557
|
+
# administrator credentials to access the API.
|
1519
1558
|
#
|
1520
1559
|
# @option params [required, String] :resource_id
|
1521
1560
|
# The ID of the resource.
|
@@ -1579,9 +1618,7 @@ module Aws::WorkDocs
|
|
1579
1618
|
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
|
1580
1619
|
#
|
1581
1620
|
# @option params [required, String] :authentication_token
|
1582
|
-
# Amazon WorkDocs authentication token.
|
1583
|
-
# administrative API actions, as in accessing the API using AWS
|
1584
|
-
# credentials.
|
1621
|
+
# Amazon WorkDocs authentication token.
|
1585
1622
|
#
|
1586
1623
|
# @option params [Integer] :limit
|
1587
1624
|
# The maximum number of items to return.
|
@@ -1637,9 +1674,8 @@ module Aws::WorkDocs
|
|
1637
1674
|
# you can use to request the next set of results.
|
1638
1675
|
#
|
1639
1676
|
# @option params [String] :authentication_token
|
1640
|
-
# Amazon WorkDocs authentication token.
|
1641
|
-
#
|
1642
|
-
# credentials.
|
1677
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1678
|
+
# administrator credentials to access the API.
|
1643
1679
|
#
|
1644
1680
|
# @option params [String] :organization_id
|
1645
1681
|
# The ID of the organization.
|
@@ -1676,6 +1712,8 @@ module Aws::WorkDocs
|
|
1676
1712
|
# * {Types::DescribeUsersResponse#total_number_of_users #total_number_of_users} => Integer
|
1677
1713
|
# * {Types::DescribeUsersResponse#marker #marker} => String
|
1678
1714
|
#
|
1715
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1716
|
+
#
|
1679
1717
|
# @example Request syntax with placeholder values
|
1680
1718
|
#
|
1681
1719
|
# resp = client.describe_users({
|
@@ -1727,10 +1765,17 @@ module Aws::WorkDocs
|
|
1727
1765
|
# token was generated. This is not a valid action for SigV4
|
1728
1766
|
# (administrative API) clients.
|
1729
1767
|
#
|
1768
|
+
# This action requires an authentication token. To get an authentication
|
1769
|
+
# token, register an application with Amazon WorkDocs. For more
|
1770
|
+
# information, see [Authentication and Access Control for User
|
1771
|
+
# Applications][1] in the *Amazon WorkDocs Developer Guide*.
|
1772
|
+
#
|
1773
|
+
#
|
1774
|
+
#
|
1775
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
|
1776
|
+
#
|
1730
1777
|
# @option params [required, String] :authentication_token
|
1731
|
-
# Amazon WorkDocs authentication token.
|
1732
|
-
# administrative API actions, as in accessing the API using AWS
|
1733
|
-
# credentials.
|
1778
|
+
# Amazon WorkDocs authentication token.
|
1734
1779
|
#
|
1735
1780
|
# @return [Types::GetCurrentUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1736
1781
|
#
|
@@ -1774,9 +1819,8 @@ module Aws::WorkDocs
|
|
1774
1819
|
# Retrieves details of a document.
|
1775
1820
|
#
|
1776
1821
|
# @option params [String] :authentication_token
|
1777
|
-
# Amazon WorkDocs authentication token.
|
1778
|
-
#
|
1779
|
-
# credentials.
|
1822
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1823
|
+
# administrator credentials to access the API.
|
1780
1824
|
#
|
1781
1825
|
# @option params [required, String] :document_id
|
1782
1826
|
# The ID of the document.
|
@@ -1843,9 +1887,8 @@ module Aws::WorkDocs
|
|
1843
1887
|
# can also request the names of the parent folders.
|
1844
1888
|
#
|
1845
1889
|
# @option params [String] :authentication_token
|
1846
|
-
# Amazon WorkDocs authentication token.
|
1847
|
-
#
|
1848
|
-
# credentials.
|
1890
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1891
|
+
# administrator credentials to access the API.
|
1849
1892
|
#
|
1850
1893
|
# @option params [required, String] :document_id
|
1851
1894
|
# The ID of the document.
|
@@ -1892,9 +1935,8 @@ module Aws::WorkDocs
|
|
1892
1935
|
# Retrieves version metadata for the specified document.
|
1893
1936
|
#
|
1894
1937
|
# @option params [String] :authentication_token
|
1895
|
-
# Amazon WorkDocs authentication token.
|
1896
|
-
#
|
1897
|
-
# credentials.
|
1938
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
1939
|
+
# administrator credentials to access the API.
|
1898
1940
|
#
|
1899
1941
|
# @option params [required, String] :document_id
|
1900
1942
|
# The ID of the document.
|
@@ -1956,9 +1998,8 @@ module Aws::WorkDocs
|
|
1956
1998
|
# Retrieves the metadata of the specified folder.
|
1957
1999
|
#
|
1958
2000
|
# @option params [String] :authentication_token
|
1959
|
-
# Amazon WorkDocs authentication token.
|
1960
|
-
#
|
1961
|
-
# credentials.
|
2001
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2002
|
+
# administrator credentials to access the API.
|
1962
2003
|
#
|
1963
2004
|
# @option params [required, String] :folder_id
|
1964
2005
|
# The ID of the folder.
|
@@ -2014,9 +2055,8 @@ module Aws::WorkDocs
|
|
2014
2055
|
# can also request the parent folder names.
|
2015
2056
|
#
|
2016
2057
|
# @option params [String] :authentication_token
|
2017
|
-
# Amazon WorkDocs authentication token.
|
2018
|
-
#
|
2019
|
-
# credentials.
|
2058
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2059
|
+
# administrator credentials to access the API.
|
2020
2060
|
#
|
2021
2061
|
# @option params [required, String] :folder_id
|
2022
2062
|
# The ID of the folder.
|
@@ -2064,9 +2104,8 @@ module Aws::WorkDocs
|
|
2064
2104
|
# The only `CollectionType` supported is `SHARED_WITH_ME`.
|
2065
2105
|
#
|
2066
2106
|
# @option params [String] :authentication_token
|
2067
|
-
# The Amazon WorkDocs authentication token.
|
2068
|
-
#
|
2069
|
-
# using AWS credentials.
|
2107
|
+
# The Amazon WorkDocs authentication token. Not required when using AWS
|
2108
|
+
# administrator credentials to access the API.
|
2070
2109
|
#
|
2071
2110
|
# @option params [String] :user_id
|
2072
2111
|
# The user ID for the resource collection. This is a required field for
|
@@ -2159,9 +2198,8 @@ module Aws::WorkDocs
|
|
2159
2198
|
# To cancel the document upload, call AbortDocumentVersionUpload.
|
2160
2199
|
#
|
2161
2200
|
# @option params [String] :authentication_token
|
2162
|
-
# Amazon WorkDocs authentication token.
|
2163
|
-
#
|
2164
|
-
# credentials.
|
2201
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2202
|
+
# administrator credentials to access the API.
|
2165
2203
|
#
|
2166
2204
|
# @option params [String] :id
|
2167
2205
|
# The ID of the document.
|
@@ -2243,9 +2281,8 @@ module Aws::WorkDocs
|
|
2243
2281
|
# Removes all the permissions from the specified resource.
|
2244
2282
|
#
|
2245
2283
|
# @option params [String] :authentication_token
|
2246
|
-
# Amazon WorkDocs authentication token.
|
2247
|
-
#
|
2248
|
-
# credentials.
|
2284
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2285
|
+
# administrator credentials to access the API.
|
2249
2286
|
#
|
2250
2287
|
# @option params [required, String] :resource_id
|
2251
2288
|
# The ID of the resource.
|
@@ -2272,9 +2309,8 @@ module Aws::WorkDocs
|
|
2272
2309
|
# resource.
|
2273
2310
|
#
|
2274
2311
|
# @option params [String] :authentication_token
|
2275
|
-
# Amazon WorkDocs authentication token.
|
2276
|
-
#
|
2277
|
-
# credentials.
|
2312
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2313
|
+
# administrator credentials to access the API.
|
2278
2314
|
#
|
2279
2315
|
# @option params [required, String] :resource_id
|
2280
2316
|
# The ID of the resource.
|
@@ -2309,9 +2345,8 @@ module Aws::WorkDocs
|
|
2309
2345
|
# access to both the document and its parent folder, if applicable.
|
2310
2346
|
#
|
2311
2347
|
# @option params [String] :authentication_token
|
2312
|
-
# Amazon WorkDocs authentication token.
|
2313
|
-
#
|
2314
|
-
# credentials.
|
2348
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2349
|
+
# administrator credentials to access the API.
|
2315
2350
|
#
|
2316
2351
|
# @option params [required, String] :document_id
|
2317
2352
|
# The ID of the document.
|
@@ -2355,9 +2390,8 @@ module Aws::WorkDocs
|
|
2355
2390
|
# InitiateDocumentVersionUpload.
|
2356
2391
|
#
|
2357
2392
|
# @option params [String] :authentication_token
|
2358
|
-
# Amazon WorkDocs authentication token.
|
2359
|
-
#
|
2360
|
-
# credentials.
|
2393
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2394
|
+
# administrator credentials to access the API.
|
2361
2395
|
#
|
2362
2396
|
# @option params [required, String] :document_id
|
2363
2397
|
# The ID of the document.
|
@@ -2393,9 +2427,8 @@ module Aws::WorkDocs
|
|
2393
2427
|
# applicable.
|
2394
2428
|
#
|
2395
2429
|
# @option params [String] :authentication_token
|
2396
|
-
# Amazon WorkDocs authentication token.
|
2397
|
-
#
|
2398
|
-
# credentials.
|
2430
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2431
|
+
# administrator credentials to access the API.
|
2399
2432
|
#
|
2400
2433
|
# @option params [required, String] :folder_id
|
2401
2434
|
# The ID of the folder.
|
@@ -2435,9 +2468,8 @@ module Aws::WorkDocs
|
|
2435
2468
|
# revokes administrative privileges to the Amazon WorkDocs site.
|
2436
2469
|
#
|
2437
2470
|
# @option params [String] :authentication_token
|
2438
|
-
# Amazon WorkDocs authentication token.
|
2439
|
-
#
|
2440
|
-
# credentials.
|
2471
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2472
|
+
# administrator credentials to access the API.
|
2441
2473
|
#
|
2442
2474
|
# @option params [required, String] :user_id
|
2443
2475
|
# The ID of the user.
|
@@ -2527,7 +2559,7 @@ module Aws::WorkDocs
|
|
2527
2559
|
params: params,
|
2528
2560
|
config: config)
|
2529
2561
|
context[:gem_name] = 'aws-sdk-workdocs'
|
2530
|
-
context[:gem_version] = '1.
|
2562
|
+
context[:gem_version] = '1.24.1'
|
2531
2563
|
Seahorse::Client::Request.new(handlers, context)
|
2532
2564
|
end
|
2533
2565
|
|