aws-sdk-workdocs 1.42.0 → 1.44.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workdocs/client.rb +275 -84
- data/lib/aws-sdk-workdocs/client_api.rb +167 -0
- data/lib/aws-sdk-workdocs/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-workdocs/endpoints.rb +14 -0
- data/lib/aws-sdk-workdocs/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-workdocs/types.rb +352 -95
- data/lib/aws-sdk-workdocs.rb +1 -1
- metadata +2 -2
@@ -374,8 +374,8 @@ module Aws::WorkDocs
|
|
374
374
|
# document version, or fails to do so.
|
375
375
|
#
|
376
376
|
# @option params [String] :authentication_token
|
377
|
-
# Amazon WorkDocs authentication token. Not required when using
|
378
|
-
# administrator credentials to access the API.
|
377
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
378
|
+
# Web Services administrator credentials to access the API.
|
379
379
|
#
|
380
380
|
# @option params [required, String] :document_id
|
381
381
|
# The ID of the document.
|
@@ -409,8 +409,8 @@ module Aws::WorkDocs
|
|
409
409
|
# The ID of the user.
|
410
410
|
#
|
411
411
|
# @option params [String] :authentication_token
|
412
|
-
# Amazon WorkDocs authentication token. Not required when using
|
413
|
-
# administrator credentials to access the API.
|
412
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
413
|
+
# Web Services administrator credentials to access the API.
|
414
414
|
#
|
415
415
|
# @return [Types::ActivateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
416
416
|
#
|
@@ -457,8 +457,8 @@ module Aws::WorkDocs
|
|
457
457
|
# different permissions.
|
458
458
|
#
|
459
459
|
# @option params [String] :authentication_token
|
460
|
-
# Amazon WorkDocs authentication token. Not required when using
|
461
|
-
# administrator credentials to access the API.
|
460
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
461
|
+
# Web Services administrator credentials to access the API.
|
462
462
|
#
|
463
463
|
# @option params [required, String] :resource_id
|
464
464
|
# The ID of the resource.
|
@@ -513,8 +513,8 @@ module Aws::WorkDocs
|
|
513
513
|
# Adds a new comment to the specified document version.
|
514
514
|
#
|
515
515
|
# @option params [String] :authentication_token
|
516
|
-
# Amazon WorkDocs authentication token. Not required when using
|
517
|
-
# administrator credentials to access the API.
|
516
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
517
|
+
# Web Services administrator credentials to access the API.
|
518
518
|
#
|
519
519
|
# @option params [required, String] :document_id
|
520
520
|
# The ID of the document.
|
@@ -599,8 +599,8 @@ module Aws::WorkDocs
|
|
599
599
|
# folder, document, or version).
|
600
600
|
#
|
601
601
|
# @option params [String] :authentication_token
|
602
|
-
# Amazon WorkDocs authentication token. Not required when using
|
603
|
-
# administrator credentials to access the API.
|
602
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
603
|
+
# Web Services administrator credentials to access the API.
|
604
604
|
#
|
605
605
|
# @option params [required, String] :resource_id
|
606
606
|
# The ID of the resource.
|
@@ -637,8 +637,8 @@ module Aws::WorkDocs
|
|
637
637
|
# Creates a folder with the specified name and parent folder.
|
638
638
|
#
|
639
639
|
# @option params [String] :authentication_token
|
640
|
-
# Amazon WorkDocs authentication token. Not required when using
|
641
|
-
# administrator credentials to access the API.
|
640
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
641
|
+
# Web Services administrator credentials to access the API.
|
642
642
|
#
|
643
643
|
# @option params [String] :name
|
644
644
|
# The name of the new folder.
|
@@ -692,8 +692,8 @@ module Aws::WorkDocs
|
|
692
692
|
# List of labels to add to the resource.
|
693
693
|
#
|
694
694
|
# @option params [String] :authentication_token
|
695
|
-
# Amazon WorkDocs authentication token. Not required when using
|
696
|
-
# administrator credentials to access the API.
|
695
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
696
|
+
# Web Services administrator credentials to access the API.
|
697
697
|
#
|
698
698
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
699
699
|
#
|
@@ -796,8 +796,8 @@ module Aws::WorkDocs
|
|
796
796
|
# The amount of storage for the user.
|
797
797
|
#
|
798
798
|
# @option params [String] :authentication_token
|
799
|
-
# Amazon WorkDocs authentication token. Not required when using
|
800
|
-
# administrator credentials to access the API.
|
799
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
800
|
+
# Web Services administrator credentials to access the API.
|
801
801
|
#
|
802
802
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
803
803
|
#
|
@@ -856,8 +856,8 @@ module Aws::WorkDocs
|
|
856
856
|
# The ID of the user.
|
857
857
|
#
|
858
858
|
# @option params [String] :authentication_token
|
859
|
-
# Amazon WorkDocs authentication token. Not required when using
|
860
|
-
# administrator credentials to access the API.
|
859
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
860
|
+
# Web Services administrator credentials to access the API.
|
861
861
|
#
|
862
862
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
863
863
|
#
|
@@ -880,8 +880,8 @@ module Aws::WorkDocs
|
|
880
880
|
# Deletes the specified comment from the document version.
|
881
881
|
#
|
882
882
|
# @option params [String] :authentication_token
|
883
|
-
# Amazon WorkDocs authentication token. Not required when using
|
884
|
-
# administrator credentials to access the API.
|
883
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
884
|
+
# Web Services administrator credentials to access the API.
|
885
885
|
#
|
886
886
|
# @option params [required, String] :document_id
|
887
887
|
# The ID of the document.
|
@@ -915,8 +915,8 @@ module Aws::WorkDocs
|
|
915
915
|
# Deletes custom metadata from the specified resource.
|
916
916
|
#
|
917
917
|
# @option params [String] :authentication_token
|
918
|
-
# Amazon WorkDocs authentication token. Not required when using
|
919
|
-
# administrator credentials to access the API.
|
918
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
919
|
+
# Web Services administrator credentials to access the API.
|
920
920
|
#
|
921
921
|
# @option params [required, String] :resource_id
|
922
922
|
# The ID of the resource, either a document or folder.
|
@@ -957,8 +957,8 @@ module Aws::WorkDocs
|
|
957
957
|
# metadata.
|
958
958
|
#
|
959
959
|
# @option params [String] :authentication_token
|
960
|
-
# Amazon WorkDocs authentication token. Not required when using
|
961
|
-
# administrator credentials to access the API.
|
960
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
961
|
+
# Web Services administrator credentials to access the API.
|
962
962
|
#
|
963
963
|
# @option params [required, String] :document_id
|
964
964
|
# The ID of the document.
|
@@ -981,22 +981,20 @@ module Aws::WorkDocs
|
|
981
981
|
req.send_request(options)
|
982
982
|
end
|
983
983
|
|
984
|
-
# Deletes a version of
|
985
|
-
# `DeletePriorVersions` parameter to delete prior versions.
|
984
|
+
# Deletes a specific version of a document.
|
986
985
|
#
|
987
986
|
# @option params [String] :authentication_token
|
988
|
-
# Amazon WorkDocs authentication token. Not required when using
|
989
|
-
# administrator credentials to access the API.
|
987
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
988
|
+
# Web Services administrator credentials to access the API.
|
990
989
|
#
|
991
990
|
# @option params [required, String] :document_id
|
992
|
-
# The ID of
|
991
|
+
# The ID of the document associated with the version being deleted.
|
993
992
|
#
|
994
993
|
# @option params [required, String] :version_id
|
995
|
-
# The
|
994
|
+
# The ID of the version being deleted.
|
996
995
|
#
|
997
996
|
# @option params [required, Boolean] :delete_prior_versions
|
998
|
-
#
|
999
|
-
# versions* of a document.
|
997
|
+
# Deletes all versions of a document prior to the current version.
|
1000
998
|
#
|
1001
999
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1002
1000
|
#
|
@@ -1021,8 +1019,8 @@ module Aws::WorkDocs
|
|
1021
1019
|
# Permanently deletes the specified folder and its contents.
|
1022
1020
|
#
|
1023
1021
|
# @option params [String] :authentication_token
|
1024
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1025
|
-
# administrator credentials to access the API.
|
1022
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1023
|
+
# Web Services administrator credentials to access the API.
|
1026
1024
|
#
|
1027
1025
|
# @option params [required, String] :folder_id
|
1028
1026
|
# The ID of the folder.
|
@@ -1048,8 +1046,8 @@ module Aws::WorkDocs
|
|
1048
1046
|
# Deletes the contents of the specified folder.
|
1049
1047
|
#
|
1050
1048
|
# @option params [String] :authentication_token
|
1051
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1052
|
-
# administrator credentials to access the API.
|
1049
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1050
|
+
# Web Services administrator credentials to access the API.
|
1053
1051
|
#
|
1054
1052
|
# @option params [required, String] :folder_id
|
1055
1053
|
# The ID of the folder.
|
@@ -1078,8 +1076,8 @@ module Aws::WorkDocs
|
|
1078
1076
|
# The ID of the resource.
|
1079
1077
|
#
|
1080
1078
|
# @option params [String] :authentication_token
|
1081
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1082
|
-
# administrator credentials to access the API.
|
1079
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1080
|
+
# Web Services administrator credentials to access the API.
|
1083
1081
|
#
|
1084
1082
|
# @option params [Array<String>] :labels
|
1085
1083
|
# List of labels to delete from the resource.
|
@@ -1135,10 +1133,14 @@ module Aws::WorkDocs
|
|
1135
1133
|
|
1136
1134
|
# Deletes the specified user from a Simple AD or Microsoft AD directory.
|
1137
1135
|
#
|
1136
|
+
# Deleting a user immediately and permanently deletes all content in
|
1137
|
+
# that user's folder structure. Site retention policies do NOT apply to
|
1138
|
+
# this type of deletion.
|
1139
|
+
#
|
1138
1140
|
# @option params [String] :authentication_token
|
1139
1141
|
# Amazon WorkDocs authentication token. Do not set this field when using
|
1140
|
-
# administrative API actions, as in accessing the API using
|
1141
|
-
# credentials.
|
1142
|
+
# administrative API actions, as in accessing the API using Amazon Web
|
1143
|
+
# Services credentials.
|
1142
1144
|
#
|
1143
1145
|
# @option params [required, String] :user_id
|
1144
1146
|
# The ID of the user.
|
@@ -1164,8 +1166,8 @@ module Aws::WorkDocs
|
|
1164
1166
|
# Describes the user activities in a specified time period.
|
1165
1167
|
#
|
1166
1168
|
# @option params [String] :authentication_token
|
1167
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1168
|
-
# administrator credentials to access the API.
|
1169
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1170
|
+
# Web Services administrator credentials to access the API.
|
1169
1171
|
#
|
1170
1172
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1171
1173
|
# The timestamp that determines the starting time of the activities. The
|
@@ -1210,6 +1212,8 @@ module Aws::WorkDocs
|
|
1210
1212
|
# * {Types::DescribeActivitiesResponse#user_activities #user_activities} => Array<Types::Activity>
|
1211
1213
|
# * {Types::DescribeActivitiesResponse#marker #marker} => String
|
1212
1214
|
#
|
1215
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1216
|
+
#
|
1213
1217
|
# @example Request syntax with placeholder values
|
1214
1218
|
#
|
1215
1219
|
# resp = client.describe_activities({
|
@@ -1289,6 +1293,7 @@ module Aws::WorkDocs
|
|
1289
1293
|
# resp.user_activities[0].comment_metadata.created_timestamp #=> Time
|
1290
1294
|
# resp.user_activities[0].comment_metadata.comment_status #=> String, one of "DRAFT", "PUBLISHED", "DELETED"
|
1291
1295
|
# resp.user_activities[0].comment_metadata.recipient_id #=> String
|
1296
|
+
# resp.user_activities[0].comment_metadata.contributor_id #=> String
|
1292
1297
|
# resp.marker #=> String
|
1293
1298
|
#
|
1294
1299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeActivities AWS API Documentation
|
@@ -1303,8 +1308,8 @@ module Aws::WorkDocs
|
|
1303
1308
|
# List all the comments for the specified document version.
|
1304
1309
|
#
|
1305
1310
|
# @option params [String] :authentication_token
|
1306
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1307
|
-
# administrator credentials to access the API.
|
1311
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1312
|
+
# Web Services administrator credentials to access the API.
|
1308
1313
|
#
|
1309
1314
|
# @option params [required, String] :document_id
|
1310
1315
|
# The ID of the document.
|
@@ -1324,6 +1329,8 @@ module Aws::WorkDocs
|
|
1324
1329
|
# * {Types::DescribeCommentsResponse#comments #comments} => Array<Types::Comment>
|
1325
1330
|
# * {Types::DescribeCommentsResponse#marker #marker} => String
|
1326
1331
|
#
|
1332
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1333
|
+
#
|
1327
1334
|
# @example Request syntax with placeholder values
|
1328
1335
|
#
|
1329
1336
|
# resp = client.describe_comments({
|
@@ -1378,8 +1385,8 @@ module Aws::WorkDocs
|
|
1378
1385
|
# By default, only active versions are returned.
|
1379
1386
|
#
|
1380
1387
|
# @option params [String] :authentication_token
|
1381
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1382
|
-
# administrator credentials to access the API.
|
1388
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1389
|
+
# Web Services administrator credentials to access the API.
|
1383
1390
|
#
|
1384
1391
|
# @option params [required, String] :document_id
|
1385
1392
|
# The ID of the document.
|
@@ -1455,8 +1462,8 @@ module Aws::WorkDocs
|
|
1455
1462
|
# You can also request initialized documents.
|
1456
1463
|
#
|
1457
1464
|
# @option params [String] :authentication_token
|
1458
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1459
|
-
# administrator credentials to access the API.
|
1465
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1466
|
+
# Web Services administrator credentials to access the API.
|
1460
1467
|
#
|
1461
1468
|
# @option params [required, String] :folder_id
|
1462
1469
|
# The ID of the folder.
|
@@ -1556,8 +1563,8 @@ module Aws::WorkDocs
|
|
1556
1563
|
# underlying Active Directory.
|
1557
1564
|
#
|
1558
1565
|
# @option params [String] :authentication_token
|
1559
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1560
|
-
# administrator credentials to access the API.
|
1566
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1567
|
+
# Web Services administrator credentials to access the API.
|
1561
1568
|
#
|
1562
1569
|
# @option params [required, String] :search_query
|
1563
1570
|
# A query to describe groups by group name.
|
@@ -1577,6 +1584,8 @@ module Aws::WorkDocs
|
|
1577
1584
|
# * {Types::DescribeGroupsResponse#groups #groups} => Array<Types::GroupMetadata>
|
1578
1585
|
# * {Types::DescribeGroupsResponse#marker #marker} => String
|
1579
1586
|
#
|
1587
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1588
|
+
#
|
1580
1589
|
# @example Request syntax with placeholder values
|
1581
1590
|
#
|
1582
1591
|
# resp = client.describe_groups({
|
@@ -1620,6 +1629,8 @@ module Aws::WorkDocs
|
|
1620
1629
|
# * {Types::DescribeNotificationSubscriptionsResponse#subscriptions #subscriptions} => Array<Types::Subscription>
|
1621
1630
|
# * {Types::DescribeNotificationSubscriptionsResponse#marker #marker} => String
|
1622
1631
|
#
|
1632
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1633
|
+
#
|
1623
1634
|
# @example Request syntax with placeholder values
|
1624
1635
|
#
|
1625
1636
|
# resp = client.describe_notification_subscriptions({
|
@@ -1648,8 +1659,8 @@ module Aws::WorkDocs
|
|
1648
1659
|
# Describes the permissions of a specified resource.
|
1649
1660
|
#
|
1650
1661
|
# @option params [String] :authentication_token
|
1651
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1652
|
-
# administrator credentials to access the API.
|
1662
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1663
|
+
# Web Services administrator credentials to access the API.
|
1653
1664
|
#
|
1654
1665
|
# @option params [required, String] :resource_id
|
1655
1666
|
# The ID of the resource.
|
@@ -1669,6 +1680,8 @@ module Aws::WorkDocs
|
|
1669
1680
|
# * {Types::DescribeResourcePermissionsResponse#principals #principals} => Array<Types::Principal>
|
1670
1681
|
# * {Types::DescribeResourcePermissionsResponse#marker #marker} => String
|
1671
1682
|
#
|
1683
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1684
|
+
#
|
1672
1685
|
# @example Request syntax with placeholder values
|
1673
1686
|
#
|
1674
1687
|
# resp = client.describe_resource_permissions({
|
@@ -1727,6 +1740,8 @@ module Aws::WorkDocs
|
|
1727
1740
|
# * {Types::DescribeRootFoldersResponse#folders #folders} => Array<Types::FolderMetadata>
|
1728
1741
|
# * {Types::DescribeRootFoldersResponse#marker #marker} => String
|
1729
1742
|
#
|
1743
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1744
|
+
#
|
1730
1745
|
# @example Request syntax with placeholder values
|
1731
1746
|
#
|
1732
1747
|
# resp = client.describe_root_folders({
|
@@ -1769,8 +1784,8 @@ module Aws::WorkDocs
|
|
1769
1784
|
# you can use to request the next set of results.
|
1770
1785
|
#
|
1771
1786
|
# @option params [String] :authentication_token
|
1772
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1773
|
-
# administrator credentials to access the API.
|
1787
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1788
|
+
# Web Services administrator credentials to access the API.
|
1774
1789
|
#
|
1775
1790
|
# @option params [String] :organization_id
|
1776
1791
|
# The ID of the organization.
|
@@ -1935,8 +1950,8 @@ module Aws::WorkDocs
|
|
1935
1950
|
# Retrieves details of a document.
|
1936
1951
|
#
|
1937
1952
|
# @option params [String] :authentication_token
|
1938
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1939
|
-
# administrator credentials to access the API.
|
1953
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1954
|
+
# Web Services administrator credentials to access the API.
|
1940
1955
|
#
|
1941
1956
|
# @option params [required, String] :document_id
|
1942
1957
|
# The ID of the document.
|
@@ -2003,8 +2018,8 @@ module Aws::WorkDocs
|
|
2003
2018
|
# can also request the names of the parent folders.
|
2004
2019
|
#
|
2005
2020
|
# @option params [String] :authentication_token
|
2006
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2007
|
-
# administrator credentials to access the API.
|
2021
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2022
|
+
# Web Services administrator credentials to access the API.
|
2008
2023
|
#
|
2009
2024
|
# @option params [required, String] :document_id
|
2010
2025
|
# The ID of the document.
|
@@ -2051,8 +2066,8 @@ module Aws::WorkDocs
|
|
2051
2066
|
# Retrieves version metadata for the specified document.
|
2052
2067
|
#
|
2053
2068
|
# @option params [String] :authentication_token
|
2054
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2055
|
-
# administrator credentials to access the API.
|
2069
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2070
|
+
# Web Services administrator credentials to access the API.
|
2056
2071
|
#
|
2057
2072
|
# @option params [required, String] :document_id
|
2058
2073
|
# The ID of the document.
|
@@ -2114,8 +2129,8 @@ module Aws::WorkDocs
|
|
2114
2129
|
# Retrieves the metadata of the specified folder.
|
2115
2130
|
#
|
2116
2131
|
# @option params [String] :authentication_token
|
2117
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2118
|
-
# administrator credentials to access the API.
|
2132
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2133
|
+
# Web Services administrator credentials to access the API.
|
2119
2134
|
#
|
2120
2135
|
# @option params [required, String] :folder_id
|
2121
2136
|
# The ID of the folder.
|
@@ -2171,8 +2186,8 @@ module Aws::WorkDocs
|
|
2171
2186
|
# can also request the parent folder names.
|
2172
2187
|
#
|
2173
2188
|
# @option params [String] :authentication_token
|
2174
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2175
|
-
# administrator credentials to access the API.
|
2189
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2190
|
+
# Web Services administrator credentials to access the API.
|
2176
2191
|
#
|
2177
2192
|
# @option params [required, String] :folder_id
|
2178
2193
|
# The ID of the folder.
|
@@ -2220,8 +2235,8 @@ module Aws::WorkDocs
|
|
2220
2235
|
# The only `CollectionType` supported is `SHARED_WITH_ME`.
|
2221
2236
|
#
|
2222
2237
|
# @option params [String] :authentication_token
|
2223
|
-
# The Amazon WorkDocs authentication token. Not required when using
|
2224
|
-
# administrator credentials to access the API.
|
2238
|
+
# The Amazon WorkDocs authentication token. Not required when using
|
2239
|
+
# Amazon Web Services administrator credentials to access the API.
|
2225
2240
|
#
|
2226
2241
|
# @option params [String] :user_id
|
2227
2242
|
# The user ID for the resource collection. This is a required field for
|
@@ -2314,8 +2329,8 @@ module Aws::WorkDocs
|
|
2314
2329
|
# To cancel the document upload, call AbortDocumentVersionUpload.
|
2315
2330
|
#
|
2316
2331
|
# @option params [String] :authentication_token
|
2317
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2318
|
-
# administrator credentials to access the API.
|
2332
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2333
|
+
# Web Services administrator credentials to access the API.
|
2319
2334
|
#
|
2320
2335
|
# @option params [String] :id
|
2321
2336
|
# The ID of the document.
|
@@ -2397,8 +2412,8 @@ module Aws::WorkDocs
|
|
2397
2412
|
# Removes all the permissions from the specified resource.
|
2398
2413
|
#
|
2399
2414
|
# @option params [String] :authentication_token
|
2400
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2401
|
-
# administrator credentials to access the API.
|
2415
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2416
|
+
# Web Services administrator credentials to access the API.
|
2402
2417
|
#
|
2403
2418
|
# @option params [required, String] :resource_id
|
2404
2419
|
# The ID of the resource.
|
@@ -2425,8 +2440,8 @@ module Aws::WorkDocs
|
|
2425
2440
|
# resource.
|
2426
2441
|
#
|
2427
2442
|
# @option params [String] :authentication_token
|
2428
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2429
|
-
# administrator credentials to access the API.
|
2443
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2444
|
+
# Web Services administrator credentials to access the API.
|
2430
2445
|
#
|
2431
2446
|
# @option params [required, String] :resource_id
|
2432
2447
|
# The ID of the resource.
|
@@ -2460,8 +2475,8 @@ module Aws::WorkDocs
|
|
2460
2475
|
# Recovers a deleted version of an Amazon WorkDocs document.
|
2461
2476
|
#
|
2462
2477
|
# @option params [String] :authentication_token
|
2463
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2464
|
-
# administrator credentials to access the API.
|
2478
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2479
|
+
# Web Services administrator credentials to access the API.
|
2465
2480
|
#
|
2466
2481
|
# @option params [required, String] :document_id
|
2467
2482
|
# The ID of the document.
|
@@ -2484,12 +2499,188 @@ module Aws::WorkDocs
|
|
2484
2499
|
req.send_request(options)
|
2485
2500
|
end
|
2486
2501
|
|
2502
|
+
# Searches metadata and the content of folders, documents, document
|
2503
|
+
# versions, and comments.
|
2504
|
+
#
|
2505
|
+
# @option params [String] :authentication_token
|
2506
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2507
|
+
# Web Services administrator credentials to access the API.
|
2508
|
+
#
|
2509
|
+
# @option params [String] :query_text
|
2510
|
+
# The String to search for. Searches across different text fields based
|
2511
|
+
# on request parameters. Use double quotes around the query string for
|
2512
|
+
# exact phrase matches.
|
2513
|
+
#
|
2514
|
+
# @option params [Array<String>] :query_scopes
|
2515
|
+
# Filter based on the text field type. A Folder has only a name and no
|
2516
|
+
# content. A Comment has only content and no name. A Document or
|
2517
|
+
# Document Version has a name and content
|
2518
|
+
#
|
2519
|
+
# @option params [String] :organization_id
|
2520
|
+
# Filters based on the resource owner OrgId. This is a mandatory
|
2521
|
+
# parameter when using Admin SigV4 credentials.
|
2522
|
+
#
|
2523
|
+
# @option params [Array<String>] :additional_response_fields
|
2524
|
+
# A list of attributes to include in the response. Used to request
|
2525
|
+
# fields that are not normally returned in a standard response.
|
2526
|
+
#
|
2527
|
+
# @option params [Types::Filters] :filters
|
2528
|
+
# Filters results based on entity metadata.
|
2529
|
+
#
|
2530
|
+
# @option params [Array<Types::SearchSortResult>] :order_by
|
2531
|
+
# Order by results in one or more categories.
|
2532
|
+
#
|
2533
|
+
# @option params [Integer] :limit
|
2534
|
+
# Max results count per page.
|
2535
|
+
#
|
2536
|
+
# @option params [String] :marker
|
2537
|
+
# The marker for the next set of results.
|
2538
|
+
#
|
2539
|
+
# @return [Types::SearchResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2540
|
+
#
|
2541
|
+
# * {Types::SearchResourcesResponse#items #items} => Array<Types::ResponseItem>
|
2542
|
+
# * {Types::SearchResourcesResponse#marker #marker} => String
|
2543
|
+
#
|
2544
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2545
|
+
#
|
2546
|
+
# @example Request syntax with placeholder values
|
2547
|
+
#
|
2548
|
+
# resp = client.search_resources({
|
2549
|
+
# authentication_token: "AuthenticationHeaderType",
|
2550
|
+
# query_text: "SearchQueryType",
|
2551
|
+
# query_scopes: ["NAME"], # accepts NAME, CONTENT
|
2552
|
+
# organization_id: "IdType",
|
2553
|
+
# additional_response_fields: ["WEBURL"], # accepts WEBURL
|
2554
|
+
# filters: {
|
2555
|
+
# text_locales: ["AR"], # accepts AR, BG, BN, DA, DE, CS, EL, EN, ES, FA, FI, FR, HI, HU, ID, IT, JA, KO, LT, LV, NL, NO, PT, RO, RU, SV, SW, TH, TR, ZH, DEFAULT
|
2556
|
+
# content_categories: ["IMAGE"], # accepts IMAGE, DOCUMENT, PDF, SPREADSHEET, PRESENTATION, AUDIO, VIDEO, SOURCE_CODE, OTHER
|
2557
|
+
# resource_types: ["FOLDER"], # accepts FOLDER, DOCUMENT, COMMENT, DOCUMENT_VERSION
|
2558
|
+
# labels: ["SearchLabel"],
|
2559
|
+
# principals: [
|
2560
|
+
# {
|
2561
|
+
# id: "IdType", # required
|
2562
|
+
# roles: ["VIEWER"], # accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
2563
|
+
# },
|
2564
|
+
# ],
|
2565
|
+
# ancestor_ids: ["SearchAncestorId"],
|
2566
|
+
# search_collection_types: ["OWNED"], # accepts OWNED, SHARED_WITH_ME
|
2567
|
+
# size_range: {
|
2568
|
+
# start_value: 1,
|
2569
|
+
# end_value: 1,
|
2570
|
+
# },
|
2571
|
+
# created_range: {
|
2572
|
+
# start_value: Time.now,
|
2573
|
+
# end_value: Time.now,
|
2574
|
+
# },
|
2575
|
+
# modified_range: {
|
2576
|
+
# start_value: Time.now,
|
2577
|
+
# end_value: Time.now,
|
2578
|
+
# },
|
2579
|
+
# },
|
2580
|
+
# order_by: [
|
2581
|
+
# {
|
2582
|
+
# field: "RELEVANCE", # accepts RELEVANCE, NAME, SIZE, CREATED_TIMESTAMP, MODIFIED_TIMESTAMP
|
2583
|
+
# order: "ASC", # accepts ASC, DESC
|
2584
|
+
# },
|
2585
|
+
# ],
|
2586
|
+
# limit: 1,
|
2587
|
+
# marker: "NextMarkerType",
|
2588
|
+
# })
|
2589
|
+
#
|
2590
|
+
# @example Response structure
|
2591
|
+
#
|
2592
|
+
# resp.items #=> Array
|
2593
|
+
# resp.items[0].resource_type #=> String, one of "DOCUMENT", "FOLDER", "COMMENT", "DOCUMENT_VERSION"
|
2594
|
+
# resp.items[0].web_url #=> String
|
2595
|
+
# resp.items[0].document_metadata.id #=> String
|
2596
|
+
# resp.items[0].document_metadata.creator_id #=> String
|
2597
|
+
# resp.items[0].document_metadata.parent_folder_id #=> String
|
2598
|
+
# resp.items[0].document_metadata.created_timestamp #=> Time
|
2599
|
+
# resp.items[0].document_metadata.modified_timestamp #=> Time
|
2600
|
+
# resp.items[0].document_metadata.latest_version_metadata.id #=> String
|
2601
|
+
# resp.items[0].document_metadata.latest_version_metadata.name #=> String
|
2602
|
+
# resp.items[0].document_metadata.latest_version_metadata.content_type #=> String
|
2603
|
+
# resp.items[0].document_metadata.latest_version_metadata.size #=> Integer
|
2604
|
+
# resp.items[0].document_metadata.latest_version_metadata.signature #=> String
|
2605
|
+
# resp.items[0].document_metadata.latest_version_metadata.status #=> String, one of "INITIALIZED", "ACTIVE"
|
2606
|
+
# resp.items[0].document_metadata.latest_version_metadata.created_timestamp #=> Time
|
2607
|
+
# resp.items[0].document_metadata.latest_version_metadata.modified_timestamp #=> Time
|
2608
|
+
# resp.items[0].document_metadata.latest_version_metadata.content_created_timestamp #=> Time
|
2609
|
+
# resp.items[0].document_metadata.latest_version_metadata.content_modified_timestamp #=> Time
|
2610
|
+
# resp.items[0].document_metadata.latest_version_metadata.creator_id #=> String
|
2611
|
+
# resp.items[0].document_metadata.latest_version_metadata.thumbnail #=> Hash
|
2612
|
+
# resp.items[0].document_metadata.latest_version_metadata.thumbnail["DocumentThumbnailType"] #=> String
|
2613
|
+
# resp.items[0].document_metadata.latest_version_metadata.source #=> Hash
|
2614
|
+
# resp.items[0].document_metadata.latest_version_metadata.source["DocumentSourceType"] #=> String
|
2615
|
+
# resp.items[0].document_metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
|
2616
|
+
# resp.items[0].document_metadata.labels #=> Array
|
2617
|
+
# resp.items[0].document_metadata.labels[0] #=> String
|
2618
|
+
# resp.items[0].folder_metadata.id #=> String
|
2619
|
+
# resp.items[0].folder_metadata.name #=> String
|
2620
|
+
# resp.items[0].folder_metadata.creator_id #=> String
|
2621
|
+
# resp.items[0].folder_metadata.parent_folder_id #=> String
|
2622
|
+
# resp.items[0].folder_metadata.created_timestamp #=> Time
|
2623
|
+
# resp.items[0].folder_metadata.modified_timestamp #=> Time
|
2624
|
+
# resp.items[0].folder_metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
|
2625
|
+
# resp.items[0].folder_metadata.signature #=> String
|
2626
|
+
# resp.items[0].folder_metadata.labels #=> Array
|
2627
|
+
# resp.items[0].folder_metadata.labels[0] #=> String
|
2628
|
+
# resp.items[0].folder_metadata.size #=> Integer
|
2629
|
+
# resp.items[0].folder_metadata.latest_version_size #=> Integer
|
2630
|
+
# resp.items[0].comment_metadata.comment_id #=> String
|
2631
|
+
# resp.items[0].comment_metadata.contributor.id #=> String
|
2632
|
+
# resp.items[0].comment_metadata.contributor.username #=> String
|
2633
|
+
# resp.items[0].comment_metadata.contributor.email_address #=> String
|
2634
|
+
# resp.items[0].comment_metadata.contributor.given_name #=> String
|
2635
|
+
# resp.items[0].comment_metadata.contributor.surname #=> String
|
2636
|
+
# resp.items[0].comment_metadata.contributor.organization_id #=> String
|
2637
|
+
# resp.items[0].comment_metadata.contributor.root_folder_id #=> String
|
2638
|
+
# resp.items[0].comment_metadata.contributor.recycle_bin_folder_id #=> String
|
2639
|
+
# resp.items[0].comment_metadata.contributor.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
|
2640
|
+
# resp.items[0].comment_metadata.contributor.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
|
2641
|
+
# resp.items[0].comment_metadata.contributor.created_timestamp #=> Time
|
2642
|
+
# resp.items[0].comment_metadata.contributor.modified_timestamp #=> Time
|
2643
|
+
# resp.items[0].comment_metadata.contributor.time_zone_id #=> String
|
2644
|
+
# resp.items[0].comment_metadata.contributor.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
|
2645
|
+
# resp.items[0].comment_metadata.contributor.storage.storage_utilized_in_bytes #=> Integer
|
2646
|
+
# resp.items[0].comment_metadata.contributor.storage.storage_rule.storage_allocated_in_bytes #=> Integer
|
2647
|
+
# resp.items[0].comment_metadata.contributor.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"
|
2648
|
+
# resp.items[0].comment_metadata.created_timestamp #=> Time
|
2649
|
+
# resp.items[0].comment_metadata.comment_status #=> String, one of "DRAFT", "PUBLISHED", "DELETED"
|
2650
|
+
# resp.items[0].comment_metadata.recipient_id #=> String
|
2651
|
+
# resp.items[0].comment_metadata.contributor_id #=> String
|
2652
|
+
# resp.items[0].document_version_metadata.id #=> String
|
2653
|
+
# resp.items[0].document_version_metadata.name #=> String
|
2654
|
+
# resp.items[0].document_version_metadata.content_type #=> String
|
2655
|
+
# resp.items[0].document_version_metadata.size #=> Integer
|
2656
|
+
# resp.items[0].document_version_metadata.signature #=> String
|
2657
|
+
# resp.items[0].document_version_metadata.status #=> String, one of "INITIALIZED", "ACTIVE"
|
2658
|
+
# resp.items[0].document_version_metadata.created_timestamp #=> Time
|
2659
|
+
# resp.items[0].document_version_metadata.modified_timestamp #=> Time
|
2660
|
+
# resp.items[0].document_version_metadata.content_created_timestamp #=> Time
|
2661
|
+
# resp.items[0].document_version_metadata.content_modified_timestamp #=> Time
|
2662
|
+
# resp.items[0].document_version_metadata.creator_id #=> String
|
2663
|
+
# resp.items[0].document_version_metadata.thumbnail #=> Hash
|
2664
|
+
# resp.items[0].document_version_metadata.thumbnail["DocumentThumbnailType"] #=> String
|
2665
|
+
# resp.items[0].document_version_metadata.source #=> Hash
|
2666
|
+
# resp.items[0].document_version_metadata.source["DocumentSourceType"] #=> String
|
2667
|
+
# resp.marker #=> String
|
2668
|
+
#
|
2669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchResources AWS API Documentation
|
2670
|
+
#
|
2671
|
+
# @overload search_resources(params = {})
|
2672
|
+
# @param [Hash] params ({})
|
2673
|
+
def search_resources(params = {}, options = {})
|
2674
|
+
req = build_request(:search_resources, params)
|
2675
|
+
req.send_request(options)
|
2676
|
+
end
|
2677
|
+
|
2487
2678
|
# Updates the specified attributes of a document. The user must have
|
2488
2679
|
# access to both the document and its parent folder, if applicable.
|
2489
2680
|
#
|
2490
2681
|
# @option params [String] :authentication_token
|
2491
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2492
|
-
# administrator credentials to access the API.
|
2682
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2683
|
+
# Web Services administrator credentials to access the API.
|
2493
2684
|
#
|
2494
2685
|
# @option params [required, String] :document_id
|
2495
2686
|
# The ID of the document.
|
@@ -2533,8 +2724,8 @@ module Aws::WorkDocs
|
|
2533
2724
|
# InitiateDocumentVersionUpload.
|
2534
2725
|
#
|
2535
2726
|
# @option params [String] :authentication_token
|
2536
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2537
|
-
# administrator credentials to access the API.
|
2727
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2728
|
+
# Web Services administrator credentials to access the API.
|
2538
2729
|
#
|
2539
2730
|
# @option params [required, String] :document_id
|
2540
2731
|
# The ID of the document.
|
@@ -2570,8 +2761,8 @@ module Aws::WorkDocs
|
|
2570
2761
|
# applicable.
|
2571
2762
|
#
|
2572
2763
|
# @option params [String] :authentication_token
|
2573
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2574
|
-
# administrator credentials to access the API.
|
2764
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2765
|
+
# Web Services administrator credentials to access the API.
|
2575
2766
|
#
|
2576
2767
|
# @option params [required, String] :folder_id
|
2577
2768
|
# The ID of the folder.
|
@@ -2611,8 +2802,8 @@ module Aws::WorkDocs
|
|
2611
2802
|
# revokes administrative privileges to the Amazon WorkDocs site.
|
2612
2803
|
#
|
2613
2804
|
# @option params [String] :authentication_token
|
2614
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2615
|
-
# administrator credentials to access the API.
|
2805
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2806
|
+
# Web Services administrator credentials to access the API.
|
2616
2807
|
#
|
2617
2808
|
# @option params [required, String] :user_id
|
2618
2809
|
# The ID of the user.
|
@@ -2636,7 +2827,7 @@ module Aws::WorkDocs
|
|
2636
2827
|
# The locale of the user.
|
2637
2828
|
#
|
2638
2829
|
# @option params [String] :grant_poweruser_privileges
|
2639
|
-
# Boolean value to determine whether the user is granted
|
2830
|
+
# Boolean value to determine whether the user is granted Power user
|
2640
2831
|
# privileges.
|
2641
2832
|
#
|
2642
2833
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2702,7 +2893,7 @@ module Aws::WorkDocs
|
|
2702
2893
|
params: params,
|
2703
2894
|
config: config)
|
2704
2895
|
context[:gem_name] = 'aws-sdk-workdocs'
|
2705
|
-
context[:gem_version] = '1.
|
2896
|
+
context[:gem_version] = '1.44.0'
|
2706
2897
|
Seahorse::Client::Request.new(handlers, context)
|
2707
2898
|
end
|
2708
2899
|
|