aws-sdk-workdocs 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workdocs.rb +1 -1
- data/lib/aws-sdk-workdocs/client.rb +200 -133
- data/lib/aws-sdk-workdocs/client_api.rb +47 -8
- data/lib/aws-sdk-workdocs/types.rb +245 -131
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8731271be523467abea0e4cb7136cff21a5960c9
|
4
|
+
data.tar.gz: cd39179195212da4ed438d5f4bb4ac4bf4d31d7e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 09fd06969eb4edf68b60446ef4d62a3e286697a77ecccf4d9cfd4fa037766badde82ae27b8f5352b5e1cf19f9544ed1272f6a3b2f79dc27e39dd8aa50256dc82
|
7
|
+
data.tar.gz: 767fdb094a71e75785ffad3d51f06d22ce06c5c8e216c1bedf7d20ed81328a0c7f2e457bbbaaf5c999dff2d3383436e08d1efa0ed4eca04fd87a87e8a11a3708
|
data/lib/aws-sdk-workdocs.rb
CHANGED
@@ -151,9 +151,9 @@ module Aws::WorkDocs
|
|
151
151
|
# document version, or fails to do so.
|
152
152
|
#
|
153
153
|
# @option params [String] :authentication_token
|
154
|
-
# Amazon WorkDocs authentication token.
|
155
|
-
#
|
156
|
-
#
|
154
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
155
|
+
# administrative API actions, as in accessing the API using AWS
|
156
|
+
# credentials.
|
157
157
|
#
|
158
158
|
# @option params [required, String] :document_id
|
159
159
|
# The ID of the document.
|
@@ -187,9 +187,9 @@ module Aws::WorkDocs
|
|
187
187
|
# The ID of the user.
|
188
188
|
#
|
189
189
|
# @option params [String] :authentication_token
|
190
|
-
# Amazon WorkDocs authentication token.
|
191
|
-
#
|
192
|
-
#
|
190
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
191
|
+
# administrative API actions, as in accessing the API using AWS
|
192
|
+
# credentials.
|
193
193
|
#
|
194
194
|
# @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
195
195
|
#
|
@@ -213,7 +213,7 @@ module Aws::WorkDocs
|
|
213
213
|
# resp.user.root_folder_id #=> String
|
214
214
|
# resp.user.recycle_bin_folder_id #=> String
|
215
215
|
# resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
216
|
-
# resp.user.type #=> String, one of "USER", "ADMIN"
|
216
|
+
# resp.user.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
217
217
|
# resp.user.created_timestamp #=> Time
|
218
218
|
# resp.user.modified_timestamp #=> Time
|
219
219
|
# resp.user.time_zone_id #=> String
|
@@ -236,9 +236,9 @@ module Aws::WorkDocs
|
|
236
236
|
# different permissions.
|
237
237
|
#
|
238
238
|
# @option params [String] :authentication_token
|
239
|
-
# Amazon WorkDocs authentication token.
|
240
|
-
#
|
241
|
-
#
|
239
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
240
|
+
# administrative API actions, as in accessing the API using AWS
|
241
|
+
# credentials.
|
242
242
|
#
|
243
243
|
# @option params [required, String] :resource_id
|
244
244
|
# The ID of the resource.
|
@@ -246,6 +246,9 @@ module Aws::WorkDocs
|
|
246
246
|
# @option params [required, Array<Types::SharePrincipal>] :principals
|
247
247
|
# The users, groups, or organization being granted permission.
|
248
248
|
#
|
249
|
+
# @option params [Types::NotificationOptions] :notification_options
|
250
|
+
# The notification options.
|
251
|
+
#
|
249
252
|
# @return [Types::AddResourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
250
253
|
#
|
251
254
|
# * {Types::AddResourcePermissionsResponse#share_results #share_results} => Array<Types::ShareResult>
|
@@ -262,6 +265,10 @@ module Aws::WorkDocs
|
|
262
265
|
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
263
266
|
# },
|
264
267
|
# ],
|
268
|
+
# notification_options: {
|
269
|
+
# send_email: false,
|
270
|
+
# email_message: "MessageType",
|
271
|
+
# },
|
265
272
|
# })
|
266
273
|
#
|
267
274
|
# @example Response structure
|
@@ -285,9 +292,9 @@ module Aws::WorkDocs
|
|
285
292
|
# Adds a new comment to the specified document version.
|
286
293
|
#
|
287
294
|
# @option params [String] :authentication_token
|
288
|
-
# Amazon WorkDocs authentication token.
|
289
|
-
#
|
290
|
-
#
|
295
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
296
|
+
# administrative API actions, as in accessing the API using AWS
|
297
|
+
# credentials.
|
291
298
|
#
|
292
299
|
# @option params [required, String] :document_id
|
293
300
|
# The ID of the document.
|
@@ -346,7 +353,7 @@ module Aws::WorkDocs
|
|
346
353
|
# resp.comment.contributor.root_folder_id #=> String
|
347
354
|
# resp.comment.contributor.recycle_bin_folder_id #=> String
|
348
355
|
# resp.comment.contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
349
|
-
# resp.comment.contributor.type #=> String, one of "USER", "ADMIN"
|
356
|
+
# resp.comment.contributor.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
350
357
|
# resp.comment.contributor.created_timestamp #=> Time
|
351
358
|
# resp.comment.contributor.modified_timestamp #=> Time
|
352
359
|
# resp.comment.contributor.time_zone_id #=> String
|
@@ -372,9 +379,9 @@ module Aws::WorkDocs
|
|
372
379
|
# folder, document, or version).
|
373
380
|
#
|
374
381
|
# @option params [String] :authentication_token
|
375
|
-
# Amazon WorkDocs authentication token.
|
376
|
-
#
|
377
|
-
#
|
382
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
383
|
+
# administrative API actions, as in accessing the API using AWS
|
384
|
+
# credentials.
|
378
385
|
#
|
379
386
|
# @option params [required, String] :resource_id
|
380
387
|
# The ID of the resource.
|
@@ -411,9 +418,9 @@ module Aws::WorkDocs
|
|
411
418
|
# Creates a folder with the specified name and parent folder.
|
412
419
|
#
|
413
420
|
# @option params [String] :authentication_token
|
414
|
-
# Amazon WorkDocs authentication token.
|
415
|
-
#
|
416
|
-
#
|
421
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
422
|
+
# administrative API actions, as in accessing the API using AWS
|
423
|
+
# credentials.
|
417
424
|
#
|
418
425
|
# @option params [String] :name
|
419
426
|
# The name of the new folder.
|
@@ -467,9 +474,9 @@ module Aws::WorkDocs
|
|
467
474
|
# List of labels to add to the resource.
|
468
475
|
#
|
469
476
|
# @option params [String] :authentication_token
|
470
|
-
# Amazon WorkDocs authentication token.
|
471
|
-
#
|
472
|
-
#
|
477
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
478
|
+
# administrative API actions, as in accessing the API using AWS
|
479
|
+
# credentials.
|
473
480
|
#
|
474
481
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
475
482
|
#
|
@@ -477,7 +484,7 @@ module Aws::WorkDocs
|
|
477
484
|
#
|
478
485
|
# resp = client.create_labels({
|
479
486
|
# resource_id: "ResourceIdType", # required
|
480
|
-
# labels: ["
|
487
|
+
# labels: ["SharedLabel"], # required
|
481
488
|
# authentication_token: "AuthenticationHeaderType",
|
482
489
|
# })
|
483
490
|
#
|
@@ -509,7 +516,7 @@ module Aws::WorkDocs
|
|
509
516
|
#
|
510
517
|
# @option params [required, String] :protocol
|
511
518
|
# The protocol to use. The supported value is https, which delivers
|
512
|
-
# JSON-encoded
|
519
|
+
# JSON-encoded messages using HTTPS POST.
|
513
520
|
#
|
514
521
|
# @option params [required, String] :subscription_type
|
515
522
|
# The notification type.
|
@@ -571,9 +578,9 @@ module Aws::WorkDocs
|
|
571
578
|
# The amount of storage for the user.
|
572
579
|
#
|
573
580
|
# @option params [String] :authentication_token
|
574
|
-
# Amazon WorkDocs authentication token.
|
575
|
-
#
|
576
|
-
#
|
581
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
582
|
+
# administrative API actions, as in accessing the API using AWS
|
583
|
+
# credentials.
|
577
584
|
#
|
578
585
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
579
586
|
#
|
@@ -607,7 +614,7 @@ module Aws::WorkDocs
|
|
607
614
|
# resp.user.root_folder_id #=> String
|
608
615
|
# resp.user.recycle_bin_folder_id #=> String
|
609
616
|
# resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
610
|
-
# resp.user.type #=> String, one of "USER", "ADMIN"
|
617
|
+
# resp.user.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
611
618
|
# resp.user.created_timestamp #=> Time
|
612
619
|
# resp.user.modified_timestamp #=> Time
|
613
620
|
# resp.user.time_zone_id #=> String
|
@@ -632,9 +639,9 @@ module Aws::WorkDocs
|
|
632
639
|
# The ID of the user.
|
633
640
|
#
|
634
641
|
# @option params [String] :authentication_token
|
635
|
-
# Amazon WorkDocs authentication token.
|
636
|
-
#
|
637
|
-
#
|
642
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
643
|
+
# administrative API actions, as in accessing the API using AWS
|
644
|
+
# credentials.
|
638
645
|
#
|
639
646
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
640
647
|
#
|
@@ -657,9 +664,9 @@ module Aws::WorkDocs
|
|
657
664
|
# Deletes the specified comment from the document version.
|
658
665
|
#
|
659
666
|
# @option params [String] :authentication_token
|
660
|
-
# Amazon WorkDocs authentication token.
|
661
|
-
#
|
662
|
-
#
|
667
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
668
|
+
# administrative API actions, as in accessing the API using AWS
|
669
|
+
# credentials.
|
663
670
|
#
|
664
671
|
# @option params [required, String] :document_id
|
665
672
|
# The ID of the document.
|
@@ -693,9 +700,9 @@ module Aws::WorkDocs
|
|
693
700
|
# Deletes custom metadata from the specified resource.
|
694
701
|
#
|
695
702
|
# @option params [String] :authentication_token
|
696
|
-
# Amazon WorkDocs authentication token.
|
697
|
-
#
|
698
|
-
#
|
703
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
704
|
+
# administrative API actions, as in accessing the API using AWS
|
705
|
+
# credentials.
|
699
706
|
#
|
700
707
|
# @option params [required, String] :resource_id
|
701
708
|
# The ID of the resource, either a document or folder.
|
@@ -736,9 +743,9 @@ module Aws::WorkDocs
|
|
736
743
|
# metadata.
|
737
744
|
#
|
738
745
|
# @option params [String] :authentication_token
|
739
|
-
# Amazon WorkDocs authentication token.
|
740
|
-
#
|
741
|
-
#
|
746
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
747
|
+
# administrative API actions, as in accessing the API using AWS
|
748
|
+
# credentials.
|
742
749
|
#
|
743
750
|
# @option params [required, String] :document_id
|
744
751
|
# The ID of the document.
|
@@ -764,9 +771,9 @@ module Aws::WorkDocs
|
|
764
771
|
# Permanently deletes the specified folder and its contents.
|
765
772
|
#
|
766
773
|
# @option params [String] :authentication_token
|
767
|
-
# Amazon WorkDocs authentication token.
|
768
|
-
#
|
769
|
-
#
|
774
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
775
|
+
# administrative API actions, as in accessing the API using AWS
|
776
|
+
# credentials.
|
770
777
|
#
|
771
778
|
# @option params [required, String] :folder_id
|
772
779
|
# The ID of the folder.
|
@@ -792,9 +799,9 @@ module Aws::WorkDocs
|
|
792
799
|
# Deletes the contents of the specified folder.
|
793
800
|
#
|
794
801
|
# @option params [String] :authentication_token
|
795
|
-
# Amazon WorkDocs authentication token.
|
796
|
-
#
|
797
|
-
#
|
802
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
803
|
+
# administrative API actions, as in accessing the API using AWS
|
804
|
+
# credentials.
|
798
805
|
#
|
799
806
|
# @option params [required, String] :folder_id
|
800
807
|
# The ID of the folder.
|
@@ -823,9 +830,9 @@ module Aws::WorkDocs
|
|
823
830
|
# The ID of the resource.
|
824
831
|
#
|
825
832
|
# @option params [String] :authentication_token
|
826
|
-
# Amazon WorkDocs authentication token.
|
827
|
-
#
|
828
|
-
#
|
833
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
834
|
+
# administrative API actions, as in accessing the API using AWS
|
835
|
+
# credentials.
|
829
836
|
#
|
830
837
|
# @option params [Array<String>] :labels
|
831
838
|
# List of labels to delete from the resource.
|
@@ -840,7 +847,7 @@ module Aws::WorkDocs
|
|
840
847
|
# resp = client.delete_labels({
|
841
848
|
# resource_id: "ResourceIdType", # required
|
842
849
|
# authentication_token: "AuthenticationHeaderType",
|
843
|
-
# labels: ["
|
850
|
+
# labels: ["SharedLabel"],
|
844
851
|
# delete_all: false,
|
845
852
|
# })
|
846
853
|
#
|
@@ -882,9 +889,9 @@ module Aws::WorkDocs
|
|
882
889
|
# Deletes the specified user from a Simple AD or Microsoft AD directory.
|
883
890
|
#
|
884
891
|
# @option params [String] :authentication_token
|
885
|
-
# Amazon WorkDocs authentication token.
|
886
|
-
#
|
887
|
-
#
|
892
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
893
|
+
# administrative API actions, as in accessing the API using AWS
|
894
|
+
# credentials.
|
888
895
|
#
|
889
896
|
# @option params [required, String] :user_id
|
890
897
|
# The ID of the user.
|
@@ -910,17 +917,17 @@ module Aws::WorkDocs
|
|
910
917
|
# Describes the user activities in a specified time period.
|
911
918
|
#
|
912
919
|
# @option params [String] :authentication_token
|
913
|
-
# Amazon WorkDocs authentication token.
|
914
|
-
#
|
915
|
-
#
|
920
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
921
|
+
# administrative API actions, as in accessing the API using AWS
|
922
|
+
# credentials.
|
916
923
|
#
|
917
924
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
918
|
-
# The timestamp that determines the starting time of the activities
|
925
|
+
# The timestamp that determines the starting time of the activities. The
|
919
926
|
# response includes the activities performed after the specified
|
920
927
|
# timestamp.
|
921
928
|
#
|
922
929
|
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
923
|
-
# The timestamp that determines the end time of the activities
|
930
|
+
# The timestamp that determines the end time of the activities. The
|
924
931
|
# response includes the activities performed before the specified
|
925
932
|
# timestamp.
|
926
933
|
#
|
@@ -937,8 +944,7 @@ module Aws::WorkDocs
|
|
937
944
|
# The maximum number of items to return.
|
938
945
|
#
|
939
946
|
# @option params [String] :marker
|
940
|
-
# The marker for the next set of results.
|
941
|
-
# a previous call.)
|
947
|
+
# The marker for the next set of results.
|
942
948
|
#
|
943
949
|
# @return [Types::DescribeActivitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
944
950
|
#
|
@@ -1009,7 +1015,7 @@ module Aws::WorkDocs
|
|
1009
1015
|
# resp.user_activities[0].comment_metadata.contributor.root_folder_id #=> String
|
1010
1016
|
# resp.user_activities[0].comment_metadata.contributor.recycle_bin_folder_id #=> String
|
1011
1017
|
# resp.user_activities[0].comment_metadata.contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
1012
|
-
# resp.user_activities[0].comment_metadata.contributor.type #=> String, one of "USER", "ADMIN"
|
1018
|
+
# resp.user_activities[0].comment_metadata.contributor.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
1013
1019
|
# resp.user_activities[0].comment_metadata.contributor.created_timestamp #=> Time
|
1014
1020
|
# resp.user_activities[0].comment_metadata.contributor.modified_timestamp #=> Time
|
1015
1021
|
# resp.user_activities[0].comment_metadata.contributor.time_zone_id #=> String
|
@@ -1034,9 +1040,9 @@ module Aws::WorkDocs
|
|
1034
1040
|
# List all the comments for the specified document version.
|
1035
1041
|
#
|
1036
1042
|
# @option params [String] :authentication_token
|
1037
|
-
# Amazon WorkDocs authentication token.
|
1038
|
-
#
|
1039
|
-
#
|
1043
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1044
|
+
# administrative API actions, as in accessing the API using AWS
|
1045
|
+
# credentials.
|
1040
1046
|
#
|
1041
1047
|
# @option params [required, String] :document_id
|
1042
1048
|
# The ID of the document.
|
@@ -1082,7 +1088,7 @@ module Aws::WorkDocs
|
|
1082
1088
|
# resp.comments[0].contributor.root_folder_id #=> String
|
1083
1089
|
# resp.comments[0].contributor.recycle_bin_folder_id #=> String
|
1084
1090
|
# resp.comments[0].contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
1085
|
-
# resp.comments[0].contributor.type #=> String, one of "USER", "ADMIN"
|
1091
|
+
# resp.comments[0].contributor.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
1086
1092
|
# resp.comments[0].contributor.created_timestamp #=> Time
|
1087
1093
|
# resp.comments[0].contributor.modified_timestamp #=> Time
|
1088
1094
|
# resp.comments[0].contributor.time_zone_id #=> String
|
@@ -1110,9 +1116,9 @@ module Aws::WorkDocs
|
|
1110
1116
|
# By default, only active versions are returned.
|
1111
1117
|
#
|
1112
1118
|
# @option params [String] :authentication_token
|
1113
|
-
# Amazon WorkDocs authentication token.
|
1114
|
-
#
|
1115
|
-
#
|
1119
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1120
|
+
# administrative API actions, as in accessing the API using AWS
|
1121
|
+
# credentials.
|
1116
1122
|
#
|
1117
1123
|
# @option params [required, String] :document_id
|
1118
1124
|
# The ID of the document.
|
@@ -1186,9 +1192,9 @@ module Aws::WorkDocs
|
|
1186
1192
|
# You can also request initialized documents.
|
1187
1193
|
#
|
1188
1194
|
# @option params [String] :authentication_token
|
1189
|
-
# Amazon WorkDocs authentication token.
|
1190
|
-
#
|
1191
|
-
#
|
1195
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1196
|
+
# administrative API actions, as in accessing the API using AWS
|
1197
|
+
# credentials.
|
1192
1198
|
#
|
1193
1199
|
# @option params [required, String] :folder_id
|
1194
1200
|
# The ID of the folder.
|
@@ -1282,6 +1288,57 @@ module Aws::WorkDocs
|
|
1282
1288
|
req.send_request(options)
|
1283
1289
|
end
|
1284
1290
|
|
1291
|
+
# Describes the groups specified by query.
|
1292
|
+
#
|
1293
|
+
# @option params [String] :authentication_token
|
1294
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1295
|
+
# administrative API actions, as in accessing the API using AWS
|
1296
|
+
# credentials.
|
1297
|
+
#
|
1298
|
+
# @option params [required, String] :search_query
|
1299
|
+
# A query to describe groups by group name.
|
1300
|
+
#
|
1301
|
+
# @option params [String] :organization_id
|
1302
|
+
# The ID of the organization.
|
1303
|
+
#
|
1304
|
+
# @option params [String] :marker
|
1305
|
+
# The marker for the next set of results. (You received this marker from
|
1306
|
+
# a previous call.)
|
1307
|
+
#
|
1308
|
+
# @option params [Integer] :limit
|
1309
|
+
# The maximum number of items to return with this call.
|
1310
|
+
#
|
1311
|
+
# @return [Types::DescribeGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
|
+
#
|
1313
|
+
# * {Types::DescribeGroupsResponse#groups #groups} => Array<Types::GroupMetadata>
|
1314
|
+
# * {Types::DescribeGroupsResponse#marker #marker} => String
|
1315
|
+
#
|
1316
|
+
# @example Request syntax with placeholder values
|
1317
|
+
#
|
1318
|
+
# resp = client.describe_groups({
|
1319
|
+
# authentication_token: "AuthenticationHeaderType",
|
1320
|
+
# search_query: "SearchQueryType", # required
|
1321
|
+
# organization_id: "IdType",
|
1322
|
+
# marker: "MarkerType",
|
1323
|
+
# limit: 1,
|
1324
|
+
# })
|
1325
|
+
#
|
1326
|
+
# @example Response structure
|
1327
|
+
#
|
1328
|
+
# resp.groups #=> Array
|
1329
|
+
# resp.groups[0].id #=> String
|
1330
|
+
# resp.groups[0].name #=> String
|
1331
|
+
# resp.marker #=> String
|
1332
|
+
#
|
1333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups AWS API Documentation
|
1334
|
+
#
|
1335
|
+
# @overload describe_groups(params = {})
|
1336
|
+
# @param [Hash] params ({})
|
1337
|
+
def describe_groups(params = {}, options = {})
|
1338
|
+
req = build_request(:describe_groups, params)
|
1339
|
+
req.send_request(options)
|
1340
|
+
end
|
1341
|
+
|
1285
1342
|
# Lists the specified notification subscriptions.
|
1286
1343
|
#
|
1287
1344
|
# @option params [required, String] :organization_id
|
@@ -1327,13 +1384,16 @@ module Aws::WorkDocs
|
|
1327
1384
|
# Describes the permissions of a specified resource.
|
1328
1385
|
#
|
1329
1386
|
# @option params [String] :authentication_token
|
1330
|
-
# Amazon WorkDocs authentication token.
|
1331
|
-
#
|
1332
|
-
#
|
1387
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1388
|
+
# administrative API actions, as in accessing the API using AWS
|
1389
|
+
# credentials.
|
1333
1390
|
#
|
1334
1391
|
# @option params [required, String] :resource_id
|
1335
1392
|
# The ID of the resource.
|
1336
1393
|
#
|
1394
|
+
# @option params [String] :principal_id
|
1395
|
+
# The ID of the principal to filter permissions by.
|
1396
|
+
#
|
1337
1397
|
# @option params [Integer] :limit
|
1338
1398
|
# The maximum number of items to return with this call.
|
1339
1399
|
#
|
@@ -1351,6 +1411,7 @@ module Aws::WorkDocs
|
|
1351
1411
|
# resp = client.describe_resource_permissions({
|
1352
1412
|
# authentication_token: "AuthenticationHeaderType",
|
1353
1413
|
# resource_id: "ResourceIdType", # required
|
1414
|
+
# principal_id: "IdType",
|
1354
1415
|
# limit: 1,
|
1355
1416
|
# marker: "PageMarkerType",
|
1356
1417
|
# })
|
@@ -1375,14 +1436,14 @@ module Aws::WorkDocs
|
|
1375
1436
|
end
|
1376
1437
|
|
1377
1438
|
# Describes the current user's special folders; the `RootFolder` and
|
1378
|
-
# the `
|
1379
|
-
# and `
|
1380
|
-
# action for SigV4 (administrative API) clients.
|
1439
|
+
# the `RecycleBin`. `RootFolder` is the root of user's files and
|
1440
|
+
# folders and `RecycleBin` is the root of recycled items. This is not a
|
1441
|
+
# valid action for SigV4 (administrative API) clients.
|
1381
1442
|
#
|
1382
1443
|
# @option params [required, String] :authentication_token
|
1383
|
-
# Amazon WorkDocs authentication token.
|
1384
|
-
#
|
1385
|
-
#
|
1444
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1445
|
+
# administrative API actions, as in accessing the API using AWS
|
1446
|
+
# credentials.
|
1386
1447
|
#
|
1387
1448
|
# @option params [Integer] :limit
|
1388
1449
|
# The maximum number of items to return.
|
@@ -1438,9 +1499,9 @@ module Aws::WorkDocs
|
|
1438
1499
|
# you can use to request the next set of results.
|
1439
1500
|
#
|
1440
1501
|
# @option params [String] :authentication_token
|
1441
|
-
# Amazon WorkDocs authentication token.
|
1442
|
-
#
|
1443
|
-
#
|
1502
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1503
|
+
# administrative API actions, as in accessing the API using AWS
|
1504
|
+
# credentials.
|
1444
1505
|
#
|
1445
1506
|
# @option params [String] :organization_id
|
1446
1507
|
# The ID of the organization.
|
@@ -1504,7 +1565,7 @@ module Aws::WorkDocs
|
|
1504
1565
|
# resp.users[0].root_folder_id #=> String
|
1505
1566
|
# resp.users[0].recycle_bin_folder_id #=> String
|
1506
1567
|
# resp.users[0].status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
1507
|
-
# resp.users[0].type #=> String, one of "USER", "ADMIN"
|
1568
|
+
# resp.users[0].type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
1508
1569
|
# resp.users[0].created_timestamp #=> Time
|
1509
1570
|
# resp.users[0].modified_timestamp #=> Time
|
1510
1571
|
# resp.users[0].time_zone_id #=> String
|
@@ -1529,7 +1590,9 @@ module Aws::WorkDocs
|
|
1529
1590
|
# (administrative API) clients.
|
1530
1591
|
#
|
1531
1592
|
# @option params [required, String] :authentication_token
|
1532
|
-
# Amazon WorkDocs authentication token.
|
1593
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1594
|
+
# administrative API actions, as in accessing the API using AWS
|
1595
|
+
# credentials.
|
1533
1596
|
#
|
1534
1597
|
# @return [Types::GetCurrentUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1535
1598
|
#
|
@@ -1552,7 +1615,7 @@ module Aws::WorkDocs
|
|
1552
1615
|
# resp.user.root_folder_id #=> String
|
1553
1616
|
# resp.user.recycle_bin_folder_id #=> String
|
1554
1617
|
# resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
1555
|
-
# resp.user.type #=> String, one of "USER", "ADMIN"
|
1618
|
+
# resp.user.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
1556
1619
|
# resp.user.created_timestamp #=> Time
|
1557
1620
|
# resp.user.modified_timestamp #=> Time
|
1558
1621
|
# resp.user.time_zone_id #=> String
|
@@ -1573,9 +1636,9 @@ module Aws::WorkDocs
|
|
1573
1636
|
# Retrieves details of a document.
|
1574
1637
|
#
|
1575
1638
|
# @option params [String] :authentication_token
|
1576
|
-
# Amazon WorkDocs authentication token.
|
1577
|
-
#
|
1578
|
-
#
|
1639
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1640
|
+
# administrative API actions, as in accessing the API using AWS
|
1641
|
+
# credentials.
|
1579
1642
|
#
|
1580
1643
|
# @option params [required, String] :document_id
|
1581
1644
|
# The ID of the document.
|
@@ -1642,9 +1705,9 @@ module Aws::WorkDocs
|
|
1642
1705
|
# can also request the names of the parent folders.
|
1643
1706
|
#
|
1644
1707
|
# @option params [String] :authentication_token
|
1645
|
-
# Amazon WorkDocs authentication token.
|
1646
|
-
#
|
1647
|
-
#
|
1708
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1709
|
+
# administrative API actions, as in accessing the API using AWS
|
1710
|
+
# credentials.
|
1648
1711
|
#
|
1649
1712
|
# @option params [required, String] :document_id
|
1650
1713
|
# The ID of the document.
|
@@ -1691,9 +1754,9 @@ module Aws::WorkDocs
|
|
1691
1754
|
# Retrieves version metadata for the specified document.
|
1692
1755
|
#
|
1693
1756
|
# @option params [String] :authentication_token
|
1694
|
-
# Amazon WorkDocs authentication token.
|
1695
|
-
#
|
1696
|
-
#
|
1757
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1758
|
+
# administrative API actions, as in accessing the API using AWS
|
1759
|
+
# credentials.
|
1697
1760
|
#
|
1698
1761
|
# @option params [required, String] :document_id
|
1699
1762
|
# The ID of the document.
|
@@ -1755,9 +1818,9 @@ module Aws::WorkDocs
|
|
1755
1818
|
# Retrieves the metadata of the specified folder.
|
1756
1819
|
#
|
1757
1820
|
# @option params [String] :authentication_token
|
1758
|
-
# Amazon WorkDocs authentication token.
|
1759
|
-
#
|
1760
|
-
#
|
1821
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1822
|
+
# administrative API actions, as in accessing the API using AWS
|
1823
|
+
# credentials.
|
1761
1824
|
#
|
1762
1825
|
# @option params [required, String] :folder_id
|
1763
1826
|
# The ID of the folder.
|
@@ -1813,9 +1876,9 @@ module Aws::WorkDocs
|
|
1813
1876
|
# can also request the parent folder names.
|
1814
1877
|
#
|
1815
1878
|
# @option params [String] :authentication_token
|
1816
|
-
# Amazon WorkDocs authentication token.
|
1817
|
-
#
|
1818
|
-
#
|
1879
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1880
|
+
# administrative API actions, as in accessing the API using AWS
|
1881
|
+
# credentials.
|
1819
1882
|
#
|
1820
1883
|
# @option params [required, String] :folder_id
|
1821
1884
|
# The ID of the folder.
|
@@ -1870,9 +1933,9 @@ module Aws::WorkDocs
|
|
1870
1933
|
# To cancel the document upload, call AbortDocumentVersionUpload.
|
1871
1934
|
#
|
1872
1935
|
# @option params [String] :authentication_token
|
1873
|
-
# Amazon WorkDocs authentication token.
|
1874
|
-
#
|
1875
|
-
#
|
1936
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
1937
|
+
# administrative API actions, as in accessing the API using AWS
|
1938
|
+
# credentials.
|
1876
1939
|
#
|
1877
1940
|
# @option params [String] :id
|
1878
1941
|
# The ID of the document.
|
@@ -1881,11 +1944,10 @@ module Aws::WorkDocs
|
|
1881
1944
|
# The name of the document.
|
1882
1945
|
#
|
1883
1946
|
# @option params [Time,DateTime,Date,Integer,String] :content_created_timestamp
|
1884
|
-
# The
|
1885
|
-
# created.
|
1947
|
+
# The timestamp when the content of the document was originally created.
|
1886
1948
|
#
|
1887
1949
|
# @option params [Time,DateTime,Date,Integer,String] :content_modified_timestamp
|
1888
|
-
# The
|
1950
|
+
# The timestamp when the content of the document was modified.
|
1889
1951
|
#
|
1890
1952
|
# @option params [String] :content_type
|
1891
1953
|
# The content type of the document.
|
@@ -1955,9 +2017,9 @@ module Aws::WorkDocs
|
|
1955
2017
|
# Removes all the permissions from the specified resource.
|
1956
2018
|
#
|
1957
2019
|
# @option params [String] :authentication_token
|
1958
|
-
# Amazon WorkDocs authentication token.
|
1959
|
-
#
|
1960
|
-
#
|
2020
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2021
|
+
# administrative API actions, as in accessing the API using AWS
|
2022
|
+
# credentials.
|
1961
2023
|
#
|
1962
2024
|
# @option params [required, String] :resource_id
|
1963
2025
|
# The ID of the resource.
|
@@ -1984,9 +2046,9 @@ module Aws::WorkDocs
|
|
1984
2046
|
# resource.
|
1985
2047
|
#
|
1986
2048
|
# @option params [String] :authentication_token
|
1987
|
-
# Amazon WorkDocs authentication token.
|
1988
|
-
#
|
1989
|
-
#
|
2049
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2050
|
+
# administrative API actions, as in accessing the API using AWS
|
2051
|
+
# credentials.
|
1990
2052
|
#
|
1991
2053
|
# @option params [required, String] :resource_id
|
1992
2054
|
# The ID of the resource.
|
@@ -2021,9 +2083,9 @@ module Aws::WorkDocs
|
|
2021
2083
|
# access to both the document and its parent folder, if applicable.
|
2022
2084
|
#
|
2023
2085
|
# @option params [String] :authentication_token
|
2024
|
-
# Amazon WorkDocs authentication token.
|
2025
|
-
#
|
2026
|
-
#
|
2086
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2087
|
+
# administrative API actions, as in accessing the API using AWS
|
2088
|
+
# credentials.
|
2027
2089
|
#
|
2028
2090
|
# @option params [required, String] :document_id
|
2029
2091
|
# The ID of the document.
|
@@ -2035,8 +2097,8 @@ module Aws::WorkDocs
|
|
2035
2097
|
# The ID of the parent folder.
|
2036
2098
|
#
|
2037
2099
|
# @option params [String] :resource_state
|
2038
|
-
# The resource state of the document.
|
2039
|
-
#
|
2100
|
+
# The resource state of the document. Only ACTIVE and RECYCLED are
|
2101
|
+
# supported.
|
2040
2102
|
#
|
2041
2103
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2042
2104
|
#
|
@@ -2067,9 +2129,9 @@ module Aws::WorkDocs
|
|
2067
2129
|
# InitiateDocumentVersionUpload.
|
2068
2130
|
#
|
2069
2131
|
# @option params [String] :authentication_token
|
2070
|
-
# Amazon WorkDocs authentication token.
|
2071
|
-
#
|
2072
|
-
#
|
2132
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2133
|
+
# administrative API actions, as in accessing the API using AWS
|
2134
|
+
# credentials.
|
2073
2135
|
#
|
2074
2136
|
# @option params [required, String] :document_id
|
2075
2137
|
# The ID of the document.
|
@@ -2105,9 +2167,9 @@ module Aws::WorkDocs
|
|
2105
2167
|
# applicable.
|
2106
2168
|
#
|
2107
2169
|
# @option params [String] :authentication_token
|
2108
|
-
# Amazon WorkDocs authentication token.
|
2109
|
-
#
|
2110
|
-
#
|
2170
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2171
|
+
# administrative API actions, as in accessing the API using AWS
|
2172
|
+
# credentials.
|
2111
2173
|
#
|
2112
2174
|
# @option params [required, String] :folder_id
|
2113
2175
|
# The ID of the folder.
|
@@ -2119,8 +2181,8 @@ module Aws::WorkDocs
|
|
2119
2181
|
# The ID of the parent folder.
|
2120
2182
|
#
|
2121
2183
|
# @option params [String] :resource_state
|
2122
|
-
# The resource state of the folder.
|
2123
|
-
#
|
2184
|
+
# The resource state of the folder. Only ACTIVE and RECYCLED are
|
2185
|
+
# accepted values from the API.
|
2124
2186
|
#
|
2125
2187
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2126
2188
|
#
|
@@ -2147,9 +2209,9 @@ module Aws::WorkDocs
|
|
2147
2209
|
# revokes administrative privileges to the Amazon WorkDocs site.
|
2148
2210
|
#
|
2149
2211
|
# @option params [String] :authentication_token
|
2150
|
-
# Amazon WorkDocs authentication token.
|
2151
|
-
#
|
2152
|
-
#
|
2212
|
+
# Amazon WorkDocs authentication token. Do not set this field when using
|
2213
|
+
# administrative API actions, as in accessing the API using AWS
|
2214
|
+
# credentials.
|
2153
2215
|
#
|
2154
2216
|
# @option params [required, String] :user_id
|
2155
2217
|
# The ID of the user.
|
@@ -2172,6 +2234,10 @@ module Aws::WorkDocs
|
|
2172
2234
|
# @option params [String] :locale
|
2173
2235
|
# The locale of the user.
|
2174
2236
|
#
|
2237
|
+
# @option params [String] :grant_poweruser_privileges
|
2238
|
+
# Boolean value to determine whether the user is granted Poweruser
|
2239
|
+
# privileges.
|
2240
|
+
#
|
2175
2241
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2176
2242
|
#
|
2177
2243
|
# * {Types::UpdateUserResponse#user #user} => Types::User
|
@@ -2183,13 +2249,14 @@ module Aws::WorkDocs
|
|
2183
2249
|
# user_id: "IdType", # required
|
2184
2250
|
# given_name: "UserAttributeValueType",
|
2185
2251
|
# surname: "UserAttributeValueType",
|
2186
|
-
# type: "USER", # accepts USER, ADMIN
|
2252
|
+
# type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
|
2187
2253
|
# storage_rule: {
|
2188
2254
|
# storage_allocated_in_bytes: 1,
|
2189
2255
|
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
2190
2256
|
# },
|
2191
2257
|
# time_zone_id: "TimeZoneIdType",
|
2192
2258
|
# locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
|
2259
|
+
# grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
|
2193
2260
|
# })
|
2194
2261
|
#
|
2195
2262
|
# @example Response structure
|
@@ -2203,7 +2270,7 @@ module Aws::WorkDocs
|
|
2203
2270
|
# resp.user.root_folder_id #=> String
|
2204
2271
|
# resp.user.recycle_bin_folder_id #=> String
|
2205
2272
|
# resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
2206
|
-
# resp.user.type #=> String, one of "USER", "ADMIN"
|
2273
|
+
# resp.user.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
2207
2274
|
# resp.user.created_timestamp #=> Time
|
2208
2275
|
# resp.user.modified_timestamp #=> Time
|
2209
2276
|
# resp.user.time_zone_id #=> String
|
@@ -2234,7 +2301,7 @@ module Aws::WorkDocs
|
|
2234
2301
|
params: params,
|
2235
2302
|
config: config)
|
2236
2303
|
context[:gem_name] = 'aws-sdk-workdocs'
|
2237
|
-
context[:gem_version] = '1.
|
2304
|
+
context[:gem_version] = '1.1.0'
|
2238
2305
|
Seahorse::Client::Request.new(handlers, context)
|
2239
2306
|
end
|
2240
2307
|
|