aws-sdk-workdocs 1.18.0 → 1.23.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 312aff6acee3a94422551e29d3791818837d80d4
4
- data.tar.gz: 8c7c30a5f07219ddcbbfa448e348cf32e76eff50
2
+ SHA256:
3
+ metadata.gz: b1890bac273e05a9c8a41c77a7fb039833fc9978a146d5f3a286aab72abc077b
4
+ data.tar.gz: 50c487218e0a5d0b42bf6ebb8eb16aeae9102ec3f6671b7665b222f3165e2338
5
5
  SHA512:
6
- metadata.gz: d78d83c503defb93b1d56bea533277c71f637713696851abb47c007c971e618374a25241c4258aeb46b485569e8c00adf2bb383c95b03d6494207e5f4888197f
7
- data.tar.gz: f9b8f188d63aaa633c2e53ef6c53e801a30b625f337100591eb3cc5922bb86a718dca0397a929b46e6e38219a3b9c3bc95c8f7ac80ca534ceddbcbcd37dcdae6
6
+ metadata.gz: 73d23b25aa07614b59a51e52dfbe741417a3741e4961868554dbbc2b91e9687d3219e62052277ab61123494ed99d6b5e147e50b26dc37d4522db6dc9a510b134
7
+ data.tar.gz: b85c0bb98c186d1f8f16086a25dfab1e35ddc2d81b203c693ff55a27ae7483e227db73db6af52c726352d58fe20b8161bbcb98635e3dc133348c5a5ca19afe16
@@ -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 all
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 service API errors
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.18.0'
48
+ GEM_VERSION = '1.23.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
@@ -93,7 +105,7 @@ module Aws::WorkDocs
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -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.
@@ -139,7 +161,7 @@ module Aws::WorkDocs
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::WorkDocs
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -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. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
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,30 @@ 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 and auth
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) used by the default backoff function.
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
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::WorkDocs
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # 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}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::WorkDocs
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -260,9 +314,8 @@ module Aws::WorkDocs
260
314
  # document version, or fails to do so.
261
315
  #
262
316
  # @option params [String] :authentication_token
263
- # Amazon WorkDocs authentication token. Do not set this field when using
264
- # administrative API actions, as in accessing the API using AWS
265
- # credentials.
317
+ # Amazon WorkDocs authentication token. Not required when using AWS
318
+ # administrator credentials to access the API.
266
319
  #
267
320
  # @option params [required, String] :document_id
268
321
  # The ID of the document.
@@ -296,9 +349,8 @@ module Aws::WorkDocs
296
349
  # The ID of the user.
297
350
  #
298
351
  # @option params [String] :authentication_token
299
- # Amazon WorkDocs authentication token. Do not set this field when using
300
- # administrative API actions, as in accessing the API using AWS
301
- # credentials.
352
+ # Amazon WorkDocs authentication token. Not required when using AWS
353
+ # administrator credentials to access the API.
302
354
  #
303
355
  # @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
304
356
  #
@@ -345,9 +397,8 @@ module Aws::WorkDocs
345
397
  # different permissions.
346
398
  #
347
399
  # @option params [String] :authentication_token
348
- # Amazon WorkDocs authentication token. Do not set this field when using
349
- # administrative API actions, as in accessing the API using AWS
350
- # credentials.
400
+ # Amazon WorkDocs authentication token. Not required when using AWS
401
+ # administrator credentials to access the API.
351
402
  #
352
403
  # @option params [required, String] :resource_id
353
404
  # The ID of the resource.
@@ -402,9 +453,8 @@ module Aws::WorkDocs
402
453
  # Adds a new comment to the specified document version.
403
454
  #
404
455
  # @option params [String] :authentication_token
405
- # Amazon WorkDocs authentication token. Do not set this field when using
406
- # administrative API actions, as in accessing the API using AWS
407
- # credentials.
456
+ # Amazon WorkDocs authentication token. Not required when using AWS
457
+ # administrator credentials to access the API.
408
458
  #
409
459
  # @option params [required, String] :document_id
410
460
  # The ID of the document.
@@ -489,9 +539,8 @@ module Aws::WorkDocs
489
539
  # folder, document, or version).
490
540
  #
491
541
  # @option params [String] :authentication_token
492
- # Amazon WorkDocs authentication token. Do not set this field when using
493
- # administrative API actions, as in accessing the API using AWS
494
- # credentials.
542
+ # Amazon WorkDocs authentication token. Not required when using AWS
543
+ # administrator credentials to access the API.
495
544
  #
496
545
  # @option params [required, String] :resource_id
497
546
  # The ID of the resource.
@@ -528,9 +577,8 @@ module Aws::WorkDocs
528
577
  # Creates a folder with the specified name and parent folder.
529
578
  #
530
579
  # @option params [String] :authentication_token
531
- # Amazon WorkDocs authentication token. Do not set this field when using
532
- # administrative API actions, as in accessing the API using AWS
533
- # credentials.
580
+ # Amazon WorkDocs authentication token. Not required when using AWS
581
+ # administrator credentials to access the API.
534
582
  #
535
583
  # @option params [String] :name
536
584
  # The name of the new folder.
@@ -584,9 +632,8 @@ module Aws::WorkDocs
584
632
  # List of labels to add to the resource.
585
633
  #
586
634
  # @option params [String] :authentication_token
587
- # Amazon WorkDocs authentication token. Do not set this field when using
588
- # administrative API actions, as in accessing the API using AWS
589
- # credentials.
635
+ # Amazon WorkDocs authentication token. Not required when using AWS
636
+ # administrator credentials to access the API.
590
637
  #
591
638
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
592
639
  #
@@ -689,9 +736,8 @@ module Aws::WorkDocs
689
736
  # The amount of storage for the user.
690
737
  #
691
738
  # @option params [String] :authentication_token
692
- # Amazon WorkDocs authentication token. Do not set this field when using
693
- # administrative API actions, as in accessing the API using AWS
694
- # credentials.
739
+ # Amazon WorkDocs authentication token. Not required when using AWS
740
+ # administrator credentials to access the API.
695
741
  #
696
742
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
697
743
  #
@@ -750,9 +796,8 @@ module Aws::WorkDocs
750
796
  # The ID of the user.
751
797
  #
752
798
  # @option params [String] :authentication_token
753
- # Amazon WorkDocs authentication token. Do not set this field when using
754
- # administrative API actions, as in accessing the API using AWS
755
- # credentials.
799
+ # Amazon WorkDocs authentication token. Not required when using AWS
800
+ # administrator credentials to access the API.
756
801
  #
757
802
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
758
803
  #
@@ -775,9 +820,8 @@ module Aws::WorkDocs
775
820
  # Deletes the specified comment from the document version.
776
821
  #
777
822
  # @option params [String] :authentication_token
778
- # Amazon WorkDocs authentication token. Do not set this field when using
779
- # administrative API actions, as in accessing the API using AWS
780
- # credentials.
823
+ # Amazon WorkDocs authentication token. Not required when using AWS
824
+ # administrator credentials to access the API.
781
825
  #
782
826
  # @option params [required, String] :document_id
783
827
  # The ID of the document.
@@ -811,9 +855,8 @@ module Aws::WorkDocs
811
855
  # Deletes custom metadata from the specified resource.
812
856
  #
813
857
  # @option params [String] :authentication_token
814
- # Amazon WorkDocs authentication token. Do not set this field when using
815
- # administrative API actions, as in accessing the API using AWS
816
- # credentials.
858
+ # Amazon WorkDocs authentication token. Not required when using AWS
859
+ # administrator credentials to access the API.
817
860
  #
818
861
  # @option params [required, String] :resource_id
819
862
  # The ID of the resource, either a document or folder.
@@ -854,9 +897,8 @@ module Aws::WorkDocs
854
897
  # metadata.
855
898
  #
856
899
  # @option params [String] :authentication_token
857
- # Amazon WorkDocs authentication token. Do not set this field when using
858
- # administrative API actions, as in accessing the API using AWS
859
- # credentials.
900
+ # Amazon WorkDocs authentication token. Not required when using AWS
901
+ # administrator credentials to access the API.
860
902
  #
861
903
  # @option params [required, String] :document_id
862
904
  # The ID of the document.
@@ -882,9 +924,8 @@ module Aws::WorkDocs
882
924
  # Permanently deletes the specified folder and its contents.
883
925
  #
884
926
  # @option params [String] :authentication_token
885
- # Amazon WorkDocs authentication token. Do not set this field when using
886
- # administrative API actions, as in accessing the API using AWS
887
- # credentials.
927
+ # Amazon WorkDocs authentication token. Not required when using AWS
928
+ # administrator credentials to access the API.
888
929
  #
889
930
  # @option params [required, String] :folder_id
890
931
  # The ID of the folder.
@@ -910,9 +951,8 @@ module Aws::WorkDocs
910
951
  # Deletes the contents of the specified folder.
911
952
  #
912
953
  # @option params [String] :authentication_token
913
- # Amazon WorkDocs authentication token. Do not set this field when using
914
- # administrative API actions, as in accessing the API using AWS
915
- # credentials.
954
+ # Amazon WorkDocs authentication token. Not required when using AWS
955
+ # administrator credentials to access the API.
916
956
  #
917
957
  # @option params [required, String] :folder_id
918
958
  # The ID of the folder.
@@ -941,9 +981,8 @@ module Aws::WorkDocs
941
981
  # The ID of the resource.
942
982
  #
943
983
  # @option params [String] :authentication_token
944
- # Amazon WorkDocs authentication token. Do not set this field when using
945
- # administrative API actions, as in accessing the API using AWS
946
- # credentials.
984
+ # Amazon WorkDocs authentication token. Not required when using AWS
985
+ # administrator credentials to access the API.
947
986
  #
948
987
  # @option params [Array<String>] :labels
949
988
  # List of labels to delete from the resource.
@@ -1028,9 +1067,8 @@ module Aws::WorkDocs
1028
1067
  # Describes the user activities in a specified time period.
1029
1068
  #
1030
1069
  # @option params [String] :authentication_token
1031
- # Amazon WorkDocs authentication token. Do not set this field when using
1032
- # administrative API actions, as in accessing the API using AWS
1033
- # credentials.
1070
+ # Amazon WorkDocs authentication token. Not required when using AWS
1071
+ # administrator credentials to access the API.
1034
1072
  #
1035
1073
  # @option params [Time,DateTime,Date,Integer,String] :start_time
1036
1074
  # The timestamp that determines the starting time of the activities. The
@@ -1168,9 +1206,8 @@ module Aws::WorkDocs
1168
1206
  # List all the comments for the specified document version.
1169
1207
  #
1170
1208
  # @option params [String] :authentication_token
1171
- # Amazon WorkDocs authentication token. Do not set this field when using
1172
- # administrative API actions, as in accessing the API using AWS
1173
- # credentials.
1209
+ # Amazon WorkDocs authentication token. Not required when using AWS
1210
+ # administrator credentials to access the API.
1174
1211
  #
1175
1212
  # @option params [required, String] :document_id
1176
1213
  # The ID of the document.
@@ -1244,9 +1281,8 @@ module Aws::WorkDocs
1244
1281
  # By default, only active versions are returned.
1245
1282
  #
1246
1283
  # @option params [String] :authentication_token
1247
- # Amazon WorkDocs authentication token. Do not set this field when using
1248
- # administrative API actions, as in accessing the API using AWS
1249
- # credentials.
1284
+ # Amazon WorkDocs authentication token. Not required when using AWS
1285
+ # administrator credentials to access the API.
1250
1286
  #
1251
1287
  # @option params [required, String] :document_id
1252
1288
  # The ID of the document.
@@ -1271,6 +1307,8 @@ module Aws::WorkDocs
1271
1307
  # * {Types::DescribeDocumentVersionsResponse#document_versions #document_versions} => Array&lt;Types::DocumentVersionMetadata&gt;
1272
1308
  # * {Types::DescribeDocumentVersionsResponse#marker #marker} => String
1273
1309
  #
1310
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1311
+ #
1274
1312
  # @example Request syntax with placeholder values
1275
1313
  #
1276
1314
  # resp = client.describe_document_versions({
@@ -1320,9 +1358,8 @@ module Aws::WorkDocs
1320
1358
  # You can also request initialized documents.
1321
1359
  #
1322
1360
  # @option params [String] :authentication_token
1323
- # Amazon WorkDocs authentication token. Do not set this field when using
1324
- # administrative API actions, as in accessing the API using AWS
1325
- # credentials.
1361
+ # Amazon WorkDocs authentication token. Not required when using AWS
1362
+ # administrator credentials to access the API.
1326
1363
  #
1327
1364
  # @option params [required, String] :folder_id
1328
1365
  # The ID of the folder.
@@ -1353,6 +1390,8 @@ module Aws::WorkDocs
1353
1390
  # * {Types::DescribeFolderContentsResponse#documents #documents} => Array&lt;Types::DocumentMetadata&gt;
1354
1391
  # * {Types::DescribeFolderContentsResponse#marker #marker} => String
1355
1392
  #
1393
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1394
+ #
1356
1395
  # @example Request syntax with placeholder values
1357
1396
  #
1358
1397
  # resp = client.describe_folder_contents({
@@ -1420,9 +1459,8 @@ module Aws::WorkDocs
1420
1459
  # underlying Active Directory.
1421
1460
  #
1422
1461
  # @option params [String] :authentication_token
1423
- # Amazon WorkDocs authentication token. Do not set this field when using
1424
- # administrative API actions, as in accessing the API using AWS
1425
- # credentials.
1462
+ # Amazon WorkDocs authentication token. Not required when using AWS
1463
+ # administrator credentials to access the API.
1426
1464
  #
1427
1465
  # @option params [required, String] :search_query
1428
1466
  # A query to describe groups by group name.
@@ -1513,9 +1551,8 @@ module Aws::WorkDocs
1513
1551
  # Describes the permissions of a specified resource.
1514
1552
  #
1515
1553
  # @option params [String] :authentication_token
1516
- # Amazon WorkDocs authentication token. Do not set this field when using
1517
- # administrative API actions, as in accessing the API using AWS
1518
- # credentials.
1554
+ # Amazon WorkDocs authentication token. Not required when using AWS
1555
+ # administrator credentials to access the API.
1519
1556
  #
1520
1557
  # @option params [required, String] :resource_id
1521
1558
  # The ID of the resource.
@@ -1579,9 +1616,7 @@ module Aws::WorkDocs
1579
1616
  # [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
1580
1617
  #
1581
1618
  # @option params [required, String] :authentication_token
1582
- # Amazon WorkDocs authentication token. Do not set this field when using
1583
- # administrative API actions, as in accessing the API using AWS
1584
- # credentials.
1619
+ # Amazon WorkDocs authentication token.
1585
1620
  #
1586
1621
  # @option params [Integer] :limit
1587
1622
  # The maximum number of items to return.
@@ -1637,9 +1672,8 @@ module Aws::WorkDocs
1637
1672
  # you can use to request the next set of results.
1638
1673
  #
1639
1674
  # @option params [String] :authentication_token
1640
- # Amazon WorkDocs authentication token. Do not set this field when using
1641
- # administrative API actions, as in accessing the API using AWS
1642
- # credentials.
1675
+ # Amazon WorkDocs authentication token. Not required when using AWS
1676
+ # administrator credentials to access the API.
1643
1677
  #
1644
1678
  # @option params [String] :organization_id
1645
1679
  # The ID of the organization.
@@ -1676,6 +1710,8 @@ module Aws::WorkDocs
1676
1710
  # * {Types::DescribeUsersResponse#total_number_of_users #total_number_of_users} => Integer
1677
1711
  # * {Types::DescribeUsersResponse#marker #marker} => String
1678
1712
  #
1713
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1714
+ #
1679
1715
  # @example Request syntax with placeholder values
1680
1716
  #
1681
1717
  # resp = client.describe_users({
@@ -1727,10 +1763,17 @@ module Aws::WorkDocs
1727
1763
  # token was generated. This is not a valid action for SigV4
1728
1764
  # (administrative API) clients.
1729
1765
  #
1766
+ # This action requires an authentication token. To get an authentication
1767
+ # token, register an application with Amazon WorkDocs. For more
1768
+ # information, see [Authentication and Access Control for User
1769
+ # Applications][1] in the *Amazon WorkDocs Developer Guide*.
1770
+ #
1771
+ #
1772
+ #
1773
+ # [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html
1774
+ #
1730
1775
  # @option params [required, String] :authentication_token
1731
- # Amazon WorkDocs authentication token. Do not set this field when using
1732
- # administrative API actions, as in accessing the API using AWS
1733
- # credentials.
1776
+ # Amazon WorkDocs authentication token.
1734
1777
  #
1735
1778
  # @return [Types::GetCurrentUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1736
1779
  #
@@ -1774,9 +1817,8 @@ module Aws::WorkDocs
1774
1817
  # Retrieves details of a document.
1775
1818
  #
1776
1819
  # @option params [String] :authentication_token
1777
- # Amazon WorkDocs authentication token. Do not set this field when using
1778
- # administrative API actions, as in accessing the API using AWS
1779
- # credentials.
1820
+ # Amazon WorkDocs authentication token. Not required when using AWS
1821
+ # administrator credentials to access the API.
1780
1822
  #
1781
1823
  # @option params [required, String] :document_id
1782
1824
  # The ID of the document.
@@ -1843,9 +1885,8 @@ module Aws::WorkDocs
1843
1885
  # can also request the names of the parent folders.
1844
1886
  #
1845
1887
  # @option params [String] :authentication_token
1846
- # Amazon WorkDocs authentication token. Do not set this field when using
1847
- # administrative API actions, as in accessing the API using AWS
1848
- # credentials.
1888
+ # Amazon WorkDocs authentication token. Not required when using AWS
1889
+ # administrator credentials to access the API.
1849
1890
  #
1850
1891
  # @option params [required, String] :document_id
1851
1892
  # The ID of the document.
@@ -1892,9 +1933,8 @@ module Aws::WorkDocs
1892
1933
  # Retrieves version metadata for the specified document.
1893
1934
  #
1894
1935
  # @option params [String] :authentication_token
1895
- # Amazon WorkDocs authentication token. Do not set this field when using
1896
- # administrative API actions, as in accessing the API using AWS
1897
- # credentials.
1936
+ # Amazon WorkDocs authentication token. Not required when using AWS
1937
+ # administrator credentials to access the API.
1898
1938
  #
1899
1939
  # @option params [required, String] :document_id
1900
1940
  # The ID of the document.
@@ -1956,9 +1996,8 @@ module Aws::WorkDocs
1956
1996
  # Retrieves the metadata of the specified folder.
1957
1997
  #
1958
1998
  # @option params [String] :authentication_token
1959
- # Amazon WorkDocs authentication token. Do not set this field when using
1960
- # administrative API actions, as in accessing the API using AWS
1961
- # credentials.
1999
+ # Amazon WorkDocs authentication token. Not required when using AWS
2000
+ # administrator credentials to access the API.
1962
2001
  #
1963
2002
  # @option params [required, String] :folder_id
1964
2003
  # The ID of the folder.
@@ -2014,9 +2053,8 @@ module Aws::WorkDocs
2014
2053
  # can also request the parent folder names.
2015
2054
  #
2016
2055
  # @option params [String] :authentication_token
2017
- # Amazon WorkDocs authentication token. Do not set this field when using
2018
- # administrative API actions, as in accessing the API using AWS
2019
- # credentials.
2056
+ # Amazon WorkDocs authentication token. Not required when using AWS
2057
+ # administrator credentials to access the API.
2020
2058
  #
2021
2059
  # @option params [required, String] :folder_id
2022
2060
  # The ID of the folder.
@@ -2064,9 +2102,8 @@ module Aws::WorkDocs
2064
2102
  # The only `CollectionType` supported is `SHARED_WITH_ME`.
2065
2103
  #
2066
2104
  # @option params [String] :authentication_token
2067
- # The Amazon WorkDocs authentication token. Do not set this field when
2068
- # using administrative API actions, as in accessing the API operation
2069
- # using AWS credentials.
2105
+ # The Amazon WorkDocs authentication token. Not required when using AWS
2106
+ # administrator credentials to access the API.
2070
2107
  #
2071
2108
  # @option params [String] :user_id
2072
2109
  # The user ID for the resource collection. This is a required field for
@@ -2159,9 +2196,8 @@ module Aws::WorkDocs
2159
2196
  # To cancel the document upload, call AbortDocumentVersionUpload.
2160
2197
  #
2161
2198
  # @option params [String] :authentication_token
2162
- # Amazon WorkDocs authentication token. Do not set this field when using
2163
- # administrative API actions, as in accessing the API using AWS
2164
- # credentials.
2199
+ # Amazon WorkDocs authentication token. Not required when using AWS
2200
+ # administrator credentials to access the API.
2165
2201
  #
2166
2202
  # @option params [String] :id
2167
2203
  # The ID of the document.
@@ -2243,9 +2279,8 @@ module Aws::WorkDocs
2243
2279
  # Removes all the permissions from the specified resource.
2244
2280
  #
2245
2281
  # @option params [String] :authentication_token
2246
- # Amazon WorkDocs authentication token. Do not set this field when using
2247
- # administrative API actions, as in accessing the API using AWS
2248
- # credentials.
2282
+ # Amazon WorkDocs authentication token. Not required when using AWS
2283
+ # administrator credentials to access the API.
2249
2284
  #
2250
2285
  # @option params [required, String] :resource_id
2251
2286
  # The ID of the resource.
@@ -2272,9 +2307,8 @@ module Aws::WorkDocs
2272
2307
  # resource.
2273
2308
  #
2274
2309
  # @option params [String] :authentication_token
2275
- # Amazon WorkDocs authentication token. Do not set this field when using
2276
- # administrative API actions, as in accessing the API using AWS
2277
- # credentials.
2310
+ # Amazon WorkDocs authentication token. Not required when using AWS
2311
+ # administrator credentials to access the API.
2278
2312
  #
2279
2313
  # @option params [required, String] :resource_id
2280
2314
  # The ID of the resource.
@@ -2309,9 +2343,8 @@ module Aws::WorkDocs
2309
2343
  # access to both the document and its parent folder, if applicable.
2310
2344
  #
2311
2345
  # @option params [String] :authentication_token
2312
- # Amazon WorkDocs authentication token. Do not set this field when using
2313
- # administrative API actions, as in accessing the API using AWS
2314
- # credentials.
2346
+ # Amazon WorkDocs authentication token. Not required when using AWS
2347
+ # administrator credentials to access the API.
2315
2348
  #
2316
2349
  # @option params [required, String] :document_id
2317
2350
  # The ID of the document.
@@ -2355,9 +2388,8 @@ module Aws::WorkDocs
2355
2388
  # InitiateDocumentVersionUpload.
2356
2389
  #
2357
2390
  # @option params [String] :authentication_token
2358
- # Amazon WorkDocs authentication token. Do not set this field when using
2359
- # administrative API actions, as in accessing the API using AWS
2360
- # credentials.
2391
+ # Amazon WorkDocs authentication token. Not required when using AWS
2392
+ # administrator credentials to access the API.
2361
2393
  #
2362
2394
  # @option params [required, String] :document_id
2363
2395
  # The ID of the document.
@@ -2393,9 +2425,8 @@ module Aws::WorkDocs
2393
2425
  # applicable.
2394
2426
  #
2395
2427
  # @option params [String] :authentication_token
2396
- # Amazon WorkDocs authentication token. Do not set this field when using
2397
- # administrative API actions, as in accessing the API using AWS
2398
- # credentials.
2428
+ # Amazon WorkDocs authentication token. Not required when using AWS
2429
+ # administrator credentials to access the API.
2399
2430
  #
2400
2431
  # @option params [required, String] :folder_id
2401
2432
  # The ID of the folder.
@@ -2435,9 +2466,8 @@ module Aws::WorkDocs
2435
2466
  # revokes administrative privileges to the Amazon WorkDocs site.
2436
2467
  #
2437
2468
  # @option params [String] :authentication_token
2438
- # Amazon WorkDocs authentication token. Do not set this field when using
2439
- # administrative API actions, as in accessing the API using AWS
2440
- # credentials.
2469
+ # Amazon WorkDocs authentication token. Not required when using AWS
2470
+ # administrator credentials to access the API.
2441
2471
  #
2442
2472
  # @option params [required, String] :user_id
2443
2473
  # The ID of the user.
@@ -2527,7 +2557,7 @@ module Aws::WorkDocs
2527
2557
  params: params,
2528
2558
  config: config)
2529
2559
  context[:gem_name] = 'aws-sdk-workdocs'
2530
- context[:gem_version] = '1.18.0'
2560
+ context[:gem_version] = '1.23.0'
2531
2561
  Seahorse::Client::Request.new(handlers, context)
2532
2562
  end
2533
2563