aws-sdk-workdocs 1.40.0 → 1.41.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workdocs/client.rb +96 -11
- data/lib/aws-sdk-workdocs/client_api.rb +60 -3
- data/lib/aws-sdk-workdocs/endpoints.rb +28 -0
- data/lib/aws-sdk-workdocs/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-workdocs/types.rb +96 -9
- data/lib/aws-sdk-workdocs.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fb3755c2b0e1596753305f33cadb44e4335392016055ec67faf0baa40b972f03
|
4
|
+
data.tar.gz: b5dcae499206eb19c044c58ee9db7ca6a839fff55ecf075be3a1354d3fbc6fe8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7b9532b5799de86e2b1acd4a44572cce6b8846db75eb4f06774ab342097d544401af027f1cd31fb71cec6d99d68b3f8f057b4545d28502736c04ca71db81be2e
|
7
|
+
data.tar.gz: 367cd6dfa942e67b411c4de60cc4d7a175c945f5d9198663a12b7c9e318fe6f3f89d9d963d931cd35c59b7cfd4a8d6b915dbc15a9bb72a9161aff133be971e90
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.41.0
|
@@ -718,12 +718,12 @@ module Aws::WorkDocs
|
|
718
718
|
# endpoint receives a confirmation message, and must confirm the
|
719
719
|
# subscription.
|
720
720
|
#
|
721
|
-
# For more information, see [
|
722
|
-
# *Amazon WorkDocs Developer Guide*.
|
721
|
+
# For more information, see [Setting up notifications for an IAM user or
|
722
|
+
# role][1] in the *Amazon WorkDocs Developer Guide*.
|
723
723
|
#
|
724
724
|
#
|
725
725
|
#
|
726
|
-
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/
|
726
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/developerguide/manage-notifications.html
|
727
727
|
#
|
728
728
|
# @option params [required, String] :organization_id
|
729
729
|
# The ID of the organization.
|
@@ -748,7 +748,7 @@ module Aws::WorkDocs
|
|
748
748
|
# resp = client.create_notification_subscription({
|
749
749
|
# organization_id: "IdType", # required
|
750
750
|
# endpoint: "SubscriptionEndPointType", # required
|
751
|
-
# protocol: "HTTPS", # required, accepts HTTPS
|
751
|
+
# protocol: "HTTPS", # required, accepts HTTPS, SQS
|
752
752
|
# subscription_type: "ALL", # required, accepts ALL
|
753
753
|
# })
|
754
754
|
#
|
@@ -756,7 +756,7 @@ module Aws::WorkDocs
|
|
756
756
|
#
|
757
757
|
# resp.subscription.subscription_id #=> String
|
758
758
|
# resp.subscription.end_point #=> String
|
759
|
-
# resp.subscription.protocol #=> String, one of "HTTPS"
|
759
|
+
# resp.subscription.protocol #=> String, one of "HTTPS", "SQS"
|
760
760
|
#
|
761
761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateNotificationSubscription AWS API Documentation
|
762
762
|
#
|
@@ -981,6 +981,43 @@ module Aws::WorkDocs
|
|
981
981
|
req.send_request(options)
|
982
982
|
end
|
983
983
|
|
984
|
+
# Deletes a version of an Amazon WorkDocs document. Use the
|
985
|
+
# `DeletePriorVersions` parameter to delete prior versions.
|
986
|
+
#
|
987
|
+
# @option params [String] :authentication_token
|
988
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
989
|
+
# administrator credentials to access the API.
|
990
|
+
#
|
991
|
+
# @option params [required, String] :document_id
|
992
|
+
# The ID of a document.
|
993
|
+
#
|
994
|
+
# @option params [required, String] :version_id
|
995
|
+
# The version ID of a document.
|
996
|
+
#
|
997
|
+
# @option params [required, Boolean] :delete_prior_versions
|
998
|
+
# When set to `TRUE`, deletes the specified version and *all prior
|
999
|
+
# versions* of a document.
|
1000
|
+
#
|
1001
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1002
|
+
#
|
1003
|
+
# @example Request syntax with placeholder values
|
1004
|
+
#
|
1005
|
+
# resp = client.delete_document_version({
|
1006
|
+
# authentication_token: "AuthenticationHeaderType",
|
1007
|
+
# document_id: "ResourceIdType", # required
|
1008
|
+
# version_id: "DocumentVersionIdType", # required
|
1009
|
+
# delete_prior_versions: false, # required
|
1010
|
+
# })
|
1011
|
+
#
|
1012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersion AWS API Documentation
|
1013
|
+
#
|
1014
|
+
# @overload delete_document_version(params = {})
|
1015
|
+
# @param [Hash] params ({})
|
1016
|
+
def delete_document_version(params = {}, options = {})
|
1017
|
+
req = build_request(:delete_document_version, params)
|
1018
|
+
req.send_request(options)
|
1019
|
+
end
|
1020
|
+
|
984
1021
|
# Permanently deletes the specified folder and its contents.
|
985
1022
|
#
|
986
1023
|
# @option params [String] :authentication_token
|
@@ -1185,7 +1222,7 @@ module Aws::WorkDocs
|
|
1185
1222
|
# user_id: "IdType",
|
1186
1223
|
# include_indirect_activities: false,
|
1187
1224
|
# limit: 1,
|
1188
|
-
# marker: "
|
1225
|
+
# marker: "SearchMarkerType",
|
1189
1226
|
# })
|
1190
1227
|
#
|
1191
1228
|
# @example Response structure
|
@@ -1596,7 +1633,7 @@ module Aws::WorkDocs
|
|
1596
1633
|
# resp.subscriptions #=> Array
|
1597
1634
|
# resp.subscriptions[0].subscription_id #=> String
|
1598
1635
|
# resp.subscriptions[0].end_point #=> String
|
1599
|
-
# resp.subscriptions[0].protocol #=> String, one of "HTTPS"
|
1636
|
+
# resp.subscriptions[0].protocol #=> String, one of "HTTPS", "SQS"
|
1600
1637
|
# resp.marker #=> String
|
1601
1638
|
#
|
1602
1639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeNotificationSubscriptions AWS API Documentation
|
@@ -1742,7 +1779,28 @@ module Aws::WorkDocs
|
|
1742
1779
|
# The IDs of the users.
|
1743
1780
|
#
|
1744
1781
|
# @option params [String] :query
|
1745
|
-
# A query to filter users by user name.
|
1782
|
+
# A query to filter users by user name. Remember the following about the
|
1783
|
+
# `Userids` and `Query` parameters:
|
1784
|
+
#
|
1785
|
+
# * If you don't use either parameter, the API returns a paginated list
|
1786
|
+
# of all users on the site.
|
1787
|
+
#
|
1788
|
+
# * If you use both parameters, the API ignores the `Query` parameter.
|
1789
|
+
#
|
1790
|
+
# * The `Userid` parameter only returns user names that match a
|
1791
|
+
# corresponding user ID.
|
1792
|
+
#
|
1793
|
+
# * The `Query` parameter runs a "prefix" search for users by the
|
1794
|
+
# `GivenName`, `SurName`, or `UserName` fields included in a
|
1795
|
+
# [CreateUser][1] API call. For example, querying on `Ma` returns
|
1796
|
+
# Márcia Oliveira, María García, and Mateo Jackson. If you use
|
1797
|
+
# multiple characters, the API only returns data that matches all
|
1798
|
+
# characters. For example, querying on `Ma J` only returns Mateo
|
1799
|
+
# Jackson.
|
1800
|
+
#
|
1801
|
+
#
|
1802
|
+
#
|
1803
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html
|
1746
1804
|
#
|
1747
1805
|
# @option params [String] :include
|
1748
1806
|
# The state of the users. Specify "ALL" to include inactive users.
|
@@ -2277,7 +2335,7 @@ module Aws::WorkDocs
|
|
2277
2335
|
# @option params [Integer] :document_size_in_bytes
|
2278
2336
|
# The size of the document, in bytes.
|
2279
2337
|
#
|
2280
|
-
# @option params [
|
2338
|
+
# @option params [String] :parent_folder_id
|
2281
2339
|
# The ID of the parent folder.
|
2282
2340
|
#
|
2283
2341
|
# @return [Types::InitiateDocumentVersionUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2295,7 +2353,7 @@ module Aws::WorkDocs
|
|
2295
2353
|
# content_modified_timestamp: Time.now,
|
2296
2354
|
# content_type: "DocumentContentType",
|
2297
2355
|
# document_size_in_bytes: 1,
|
2298
|
-
# parent_folder_id: "ResourceIdType",
|
2356
|
+
# parent_folder_id: "ResourceIdType",
|
2299
2357
|
# })
|
2300
2358
|
#
|
2301
2359
|
# @example Response structure
|
@@ -2399,6 +2457,33 @@ module Aws::WorkDocs
|
|
2399
2457
|
req.send_request(options)
|
2400
2458
|
end
|
2401
2459
|
|
2460
|
+
# Recovers a deleted version of an Amazon WorkDocs document.
|
2461
|
+
#
|
2462
|
+
# @option params [String] :authentication_token
|
2463
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2464
|
+
# administrator credentials to access the API.
|
2465
|
+
#
|
2466
|
+
# @option params [required, String] :document_id
|
2467
|
+
# The ID of the document.
|
2468
|
+
#
|
2469
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2470
|
+
#
|
2471
|
+
# @example Request syntax with placeholder values
|
2472
|
+
#
|
2473
|
+
# resp = client.restore_document_versions({
|
2474
|
+
# authentication_token: "AuthenticationHeaderType",
|
2475
|
+
# document_id: "ResourceIdType", # required
|
2476
|
+
# })
|
2477
|
+
#
|
2478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersions AWS API Documentation
|
2479
|
+
#
|
2480
|
+
# @overload restore_document_versions(params = {})
|
2481
|
+
# @param [Hash] params ({})
|
2482
|
+
def restore_document_versions(params = {}, options = {})
|
2483
|
+
req = build_request(:restore_document_versions, params)
|
2484
|
+
req.send_request(options)
|
2485
|
+
end
|
2486
|
+
|
2402
2487
|
# Updates the specified attributes of a document. The user must have
|
2403
2488
|
# access to both the document and its parent folder, if applicable.
|
2404
2489
|
#
|
@@ -2617,7 +2702,7 @@ module Aws::WorkDocs
|
|
2617
2702
|
params: params,
|
2618
2703
|
config: config)
|
2619
2704
|
context[:gem_name] = 'aws-sdk-workdocs'
|
2620
|
-
context[:gem_version] = '1.
|
2705
|
+
context[:gem_version] = '1.41.0'
|
2621
2706
|
Seahorse::Client::Request.new(handlers, context)
|
2622
2707
|
end
|
2623
2708
|
|
@@ -56,6 +56,7 @@ module Aws::WorkDocs
|
|
56
56
|
DeleteCustomMetadataRequest = Shapes::StructureShape.new(name: 'DeleteCustomMetadataRequest')
|
57
57
|
DeleteCustomMetadataResponse = Shapes::StructureShape.new(name: 'DeleteCustomMetadataResponse')
|
58
58
|
DeleteDocumentRequest = Shapes::StructureShape.new(name: 'DeleteDocumentRequest')
|
59
|
+
DeleteDocumentVersionRequest = Shapes::StructureShape.new(name: 'DeleteDocumentVersionRequest')
|
59
60
|
DeleteFolderContentsRequest = Shapes::StructureShape.new(name: 'DeleteFolderContentsRequest')
|
60
61
|
DeleteFolderRequest = Shapes::StructureShape.new(name: 'DeleteFolderRequest')
|
61
62
|
DeleteLabelsRequest = Shapes::StructureShape.new(name: 'DeleteLabelsRequest')
|
@@ -165,8 +166,10 @@ module Aws::WorkDocs
|
|
165
166
|
ResourceSortType = Shapes::StringShape.new(name: 'ResourceSortType')
|
166
167
|
ResourceStateType = Shapes::StringShape.new(name: 'ResourceStateType')
|
167
168
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
169
|
+
RestoreDocumentVersionsRequest = Shapes::StructureShape.new(name: 'RestoreDocumentVersionsRequest')
|
168
170
|
RolePermissionType = Shapes::StringShape.new(name: 'RolePermissionType')
|
169
171
|
RoleType = Shapes::StringShape.new(name: 'RoleType')
|
172
|
+
SearchMarkerType = Shapes::StringShape.new(name: 'SearchMarkerType')
|
170
173
|
SearchQueryType = Shapes::StringShape.new(name: 'SearchQueryType')
|
171
174
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
172
175
|
SharePrincipal = Shapes::StructureShape.new(name: 'SharePrincipal')
|
@@ -363,6 +366,12 @@ module Aws::WorkDocs
|
|
363
366
|
DeleteDocumentRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "DocumentId"))
|
364
367
|
DeleteDocumentRequest.struct_class = Types::DeleteDocumentRequest
|
365
368
|
|
369
|
+
DeleteDocumentVersionRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
370
|
+
DeleteDocumentVersionRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "DocumentId"))
|
371
|
+
DeleteDocumentVersionRequest.add_member(:version_id, Shapes::ShapeRef.new(shape: DocumentVersionIdType, required: true, location: "uri", location_name: "VersionId"))
|
372
|
+
DeleteDocumentVersionRequest.add_member(:delete_prior_versions, Shapes::ShapeRef.new(shape: BooleanType, required: true, location: "querystring", location_name: "deletePriorVersions"))
|
373
|
+
DeleteDocumentVersionRequest.struct_class = Types::DeleteDocumentVersionRequest
|
374
|
+
|
366
375
|
DeleteFolderContentsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
367
376
|
DeleteFolderContentsRequest.add_member(:folder_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "FolderId"))
|
368
377
|
DeleteFolderContentsRequest.struct_class = Types::DeleteFolderContentsRequest
|
@@ -396,11 +405,11 @@ module Aws::WorkDocs
|
|
396
405
|
DescribeActivitiesRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: IdType, location: "querystring", location_name: "userId"))
|
397
406
|
DescribeActivitiesRequest.add_member(:include_indirect_activities, Shapes::ShapeRef.new(shape: BooleanType, location: "querystring", location_name: "includeIndirectActivities"))
|
398
407
|
DescribeActivitiesRequest.add_member(:limit, Shapes::ShapeRef.new(shape: LimitType, location: "querystring", location_name: "limit"))
|
399
|
-
DescribeActivitiesRequest.add_member(:marker, Shapes::ShapeRef.new(shape:
|
408
|
+
DescribeActivitiesRequest.add_member(:marker, Shapes::ShapeRef.new(shape: SearchMarkerType, location: "querystring", location_name: "marker"))
|
400
409
|
DescribeActivitiesRequest.struct_class = Types::DescribeActivitiesRequest
|
401
410
|
|
402
411
|
DescribeActivitiesResponse.add_member(:user_activities, Shapes::ShapeRef.new(shape: UserActivities, location_name: "UserActivities"))
|
403
|
-
DescribeActivitiesResponse.add_member(:marker, Shapes::ShapeRef.new(shape:
|
412
|
+
DescribeActivitiesResponse.add_member(:marker, Shapes::ShapeRef.new(shape: SearchMarkerType, location_name: "Marker"))
|
404
413
|
DescribeActivitiesResponse.struct_class = Types::DescribeActivitiesResponse
|
405
414
|
|
406
415
|
DescribeCommentsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
@@ -649,7 +658,7 @@ module Aws::WorkDocs
|
|
649
658
|
InitiateDocumentVersionUploadRequest.add_member(:content_modified_timestamp, Shapes::ShapeRef.new(shape: TimestampType, location_name: "ContentModifiedTimestamp"))
|
650
659
|
InitiateDocumentVersionUploadRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: DocumentContentType, location_name: "ContentType"))
|
651
660
|
InitiateDocumentVersionUploadRequest.add_member(:document_size_in_bytes, Shapes::ShapeRef.new(shape: SizeType, location_name: "DocumentSizeInBytes"))
|
652
|
-
InitiateDocumentVersionUploadRequest.add_member(:parent_folder_id, Shapes::ShapeRef.new(shape: ResourceIdType,
|
661
|
+
InitiateDocumentVersionUploadRequest.add_member(:parent_folder_id, Shapes::ShapeRef.new(shape: ResourceIdType, location_name: "ParentFolderId"))
|
653
662
|
InitiateDocumentVersionUploadRequest.struct_class = Types::InitiateDocumentVersionUploadRequest
|
654
663
|
|
655
664
|
InitiateDocumentVersionUploadResponse.add_member(:metadata, Shapes::ShapeRef.new(shape: DocumentMetadata, location_name: "Metadata"))
|
@@ -731,6 +740,10 @@ module Aws::WorkDocs
|
|
731
740
|
|
732
741
|
ResourcePathComponentList.member = Shapes::ShapeRef.new(shape: ResourcePathComponent)
|
733
742
|
|
743
|
+
RestoreDocumentVersionsRequest.add_member(:authentication_token, Shapes::ShapeRef.new(shape: AuthenticationHeaderType, location: "header", location_name: "Authentication"))
|
744
|
+
RestoreDocumentVersionsRequest.add_member(:document_id, Shapes::ShapeRef.new(shape: ResourceIdType, required: true, location: "uri", location_name: "DocumentId"))
|
745
|
+
RestoreDocumentVersionsRequest.struct_class = Types::RestoreDocumentVersionsRequest
|
746
|
+
|
734
747
|
ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessageType, location_name: "Message"))
|
735
748
|
ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
|
736
749
|
|
@@ -883,6 +896,7 @@ module Aws::WorkDocs
|
|
883
896
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
884
897
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
885
898
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
899
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
886
900
|
end)
|
887
901
|
|
888
902
|
api.add_operation(:activate_user, Seahorse::Model::Operation.new.tap do |o|
|
@@ -908,6 +922,7 @@ module Aws::WorkDocs
|
|
908
922
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
909
923
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
910
924
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
925
|
+
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
911
926
|
end)
|
912
927
|
|
913
928
|
api.add_operation(:create_comment, Seahorse::Model::Operation.new.tap do |o|
|
@@ -951,6 +966,7 @@ module Aws::WorkDocs
|
|
951
966
|
o.errors << Shapes::ShapeRef.new(shape: EntityAlreadyExistsException)
|
952
967
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
953
968
|
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
969
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
954
970
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
955
971
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
956
972
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
@@ -981,6 +997,7 @@ module Aws::WorkDocs
|
|
981
997
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
982
998
|
o.errors << Shapes::ShapeRef.new(shape: TooManySubscriptionsException)
|
983
999
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1000
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
984
1001
|
end)
|
985
1002
|
|
986
1003
|
api.add_operation(:create_user, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1045,6 +1062,7 @@ module Aws::WorkDocs
|
|
1045
1062
|
o.input = Shapes::ShapeRef.new(shape: DeleteDocumentRequest)
|
1046
1063
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1047
1064
|
o.errors << Shapes::ShapeRef.new(shape: EntityNotExistsException)
|
1065
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1048
1066
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1049
1067
|
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1050
1068
|
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
@@ -1054,6 +1072,22 @@ module Aws::WorkDocs
|
|
1054
1072
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1055
1073
|
end)
|
1056
1074
|
|
1075
|
+
api.add_operation(:delete_document_version, Seahorse::Model::Operation.new.tap do |o|
|
1076
|
+
o.name = "DeleteDocumentVersion"
|
1077
|
+
o.http_method = "DELETE"
|
1078
|
+
o.http_request_uri = "/api/v1/documentVersions/{DocumentId}/versions/{VersionId}"
|
1079
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteDocumentVersionRequest)
|
1080
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1081
|
+
o.errors << Shapes::ShapeRef.new(shape: EntityNotExistsException)
|
1082
|
+
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1083
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1084
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
1085
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1086
|
+
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1087
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
|
1088
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1089
|
+
end)
|
1090
|
+
|
1057
1091
|
api.add_operation(:delete_folder, Seahorse::Model::Operation.new.tap do |o|
|
1058
1092
|
o.name = "DeleteFolder"
|
1059
1093
|
o.http_method = "DELETE"
|
@@ -1061,6 +1095,7 @@ module Aws::WorkDocs
|
|
1061
1095
|
o.input = Shapes::ShapeRef.new(shape: DeleteFolderRequest)
|
1062
1096
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1063
1097
|
o.errors << Shapes::ShapeRef.new(shape: EntityNotExistsException)
|
1098
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1064
1099
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1065
1100
|
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1066
1101
|
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
@@ -1096,6 +1131,7 @@ module Aws::WorkDocs
|
|
1096
1131
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1097
1132
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1098
1133
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1134
|
+
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1099
1135
|
end)
|
1100
1136
|
|
1101
1137
|
api.add_operation(:delete_notification_subscription, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1163,6 +1199,7 @@ module Aws::WorkDocs
|
|
1163
1199
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1164
1200
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1165
1201
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1202
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidPasswordException)
|
1166
1203
|
o[:pager] = Aws::Pager.new(
|
1167
1204
|
limit_key: "limit",
|
1168
1205
|
tokens: {
|
@@ -1220,6 +1257,7 @@ module Aws::WorkDocs
|
|
1220
1257
|
o.http_request_uri = "/api/v1/resources/{ResourceId}/permissions"
|
1221
1258
|
o.input = Shapes::ShapeRef.new(shape: DescribeResourcePermissionsRequest)
|
1222
1259
|
o.output = Shapes::ShapeRef.new(shape: DescribeResourcePermissionsResponse)
|
1260
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
1223
1261
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1224
1262
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1225
1263
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
@@ -1367,6 +1405,7 @@ module Aws::WorkDocs
|
|
1367
1405
|
o.errors << Shapes::ShapeRef.new(shape: EntityAlreadyExistsException)
|
1368
1406
|
o.errors << Shapes::ShapeRef.new(shape: StorageLimitExceededException)
|
1369
1407
|
o.errors << Shapes::ShapeRef.new(shape: StorageLimitWillExceedException)
|
1408
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1370
1409
|
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1371
1410
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1372
1411
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
@@ -1374,6 +1413,7 @@ module Aws::WorkDocs
|
|
1374
1413
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1375
1414
|
o.errors << Shapes::ShapeRef.new(shape: DraftUploadOutOfSyncException)
|
1376
1415
|
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyCheckedOutException)
|
1416
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidPasswordException)
|
1377
1417
|
end)
|
1378
1418
|
|
1379
1419
|
api.add_operation(:remove_all_resource_permissions, Seahorse::Model::Operation.new.tap do |o|
|
@@ -1400,6 +1440,22 @@ module Aws::WorkDocs
|
|
1400
1440
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1401
1441
|
end)
|
1402
1442
|
|
1443
|
+
api.add_operation(:restore_document_versions, Seahorse::Model::Operation.new.tap do |o|
|
1444
|
+
o.name = "RestoreDocumentVersions"
|
1445
|
+
o.http_method = "POST"
|
1446
|
+
o.http_request_uri = "/api/v1/documentVersions/restore/{DocumentId}"
|
1447
|
+
o.input = Shapes::ShapeRef.new(shape: RestoreDocumentVersionsRequest)
|
1448
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1449
|
+
o.errors << Shapes::ShapeRef.new(shape: EntityNotExistsException)
|
1450
|
+
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1451
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1452
|
+
o.errors << Shapes::ShapeRef.new(shape: ConcurrentModificationException)
|
1453
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1454
|
+
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1455
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidOperationException)
|
1456
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1457
|
+
end)
|
1458
|
+
|
1403
1459
|
api.add_operation(:update_document, Seahorse::Model::Operation.new.tap do |o|
|
1404
1460
|
o.name = "UpdateDocument"
|
1405
1461
|
o.http_method = "PATCH"
|
@@ -1462,6 +1518,7 @@ module Aws::WorkDocs
|
|
1462
1518
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedOperationException)
|
1463
1519
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedResourceAccessException)
|
1464
1520
|
o.errors << Shapes::ShapeRef.new(shape: IllegalUserStateException)
|
1521
|
+
o.errors << Shapes::ShapeRef.new(shape: ProhibitedStateException)
|
1465
1522
|
o.errors << Shapes::ShapeRef.new(shape: FailedDependencyException)
|
1466
1523
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1467
1524
|
o.errors << Shapes::ShapeRef.new(shape: DeactivatingLastSystemUserException)
|
@@ -193,6 +193,20 @@ module Aws::WorkDocs
|
|
193
193
|
end
|
194
194
|
end
|
195
195
|
|
196
|
+
class DeleteDocumentVersion
|
197
|
+
def self.build(context)
|
198
|
+
unless context.config.regional_endpoint
|
199
|
+
endpoint = context.config.endpoint.to_s
|
200
|
+
end
|
201
|
+
Aws::WorkDocs::EndpointParameters.new(
|
202
|
+
region: context.config.region,
|
203
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
204
|
+
use_fips: context.config.use_fips_endpoint,
|
205
|
+
endpoint: endpoint,
|
206
|
+
)
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
196
210
|
class DeleteFolder
|
197
211
|
def self.build(context)
|
198
212
|
unless context.config.regional_endpoint
|
@@ -529,6 +543,20 @@ module Aws::WorkDocs
|
|
529
543
|
end
|
530
544
|
end
|
531
545
|
|
546
|
+
class RestoreDocumentVersions
|
547
|
+
def self.build(context)
|
548
|
+
unless context.config.regional_endpoint
|
549
|
+
endpoint = context.config.endpoint.to_s
|
550
|
+
end
|
551
|
+
Aws::WorkDocs::EndpointParameters.new(
|
552
|
+
region: context.config.region,
|
553
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
554
|
+
use_fips: context.config.use_fips_endpoint,
|
555
|
+
endpoint: endpoint,
|
556
|
+
)
|
557
|
+
end
|
558
|
+
end
|
559
|
+
|
532
560
|
class UpdateDocument
|
533
561
|
def self.build(context)
|
534
562
|
unless context.config.regional_endpoint
|
@@ -82,6 +82,8 @@ module Aws::WorkDocs
|
|
82
82
|
Aws::WorkDocs::Endpoints::DeleteCustomMetadata.build(context)
|
83
83
|
when :delete_document
|
84
84
|
Aws::WorkDocs::Endpoints::DeleteDocument.build(context)
|
85
|
+
when :delete_document_version
|
86
|
+
Aws::WorkDocs::Endpoints::DeleteDocumentVersion.build(context)
|
85
87
|
when :delete_folder
|
86
88
|
Aws::WorkDocs::Endpoints::DeleteFolder.build(context)
|
87
89
|
when :delete_folder_contents
|
@@ -130,6 +132,8 @@ module Aws::WorkDocs
|
|
130
132
|
Aws::WorkDocs::Endpoints::RemoveAllResourcePermissions.build(context)
|
131
133
|
when :remove_resource_permission
|
132
134
|
Aws::WorkDocs::Endpoints::RemoveResourcePermission.build(context)
|
135
|
+
when :restore_document_versions
|
136
|
+
Aws::WorkDocs::Endpoints::RestoreDocumentVersions.build(context)
|
133
137
|
when :update_document
|
134
138
|
Aws::WorkDocs::Endpoints::UpdateDocument.build(context)
|
135
139
|
when :update_document_version
|
@@ -530,7 +530,7 @@ module Aws::WorkDocs
|
|
530
530
|
# {
|
531
531
|
# organization_id: "IdType", # required
|
532
532
|
# endpoint: "SubscriptionEndPointType", # required
|
533
|
-
# protocol: "HTTPS", # required, accepts HTTPS
|
533
|
+
# protocol: "HTTPS", # required, accepts HTTPS, SQS
|
534
534
|
# subscription_type: "ALL", # required, accepts ALL
|
535
535
|
# }
|
536
536
|
#
|
@@ -642,7 +642,7 @@ module Aws::WorkDocs
|
|
642
642
|
:time_zone_id,
|
643
643
|
:storage_rule,
|
644
644
|
:authentication_token)
|
645
|
-
SENSITIVE = [:password, :authentication_token]
|
645
|
+
SENSITIVE = [:email_address, :password, :authentication_token]
|
646
646
|
include Aws::Structure
|
647
647
|
end
|
648
648
|
|
@@ -818,6 +818,45 @@ module Aws::WorkDocs
|
|
818
818
|
include Aws::Structure
|
819
819
|
end
|
820
820
|
|
821
|
+
# @note When making an API call, you may pass DeleteDocumentVersionRequest
|
822
|
+
# data as a hash:
|
823
|
+
#
|
824
|
+
# {
|
825
|
+
# authentication_token: "AuthenticationHeaderType",
|
826
|
+
# document_id: "ResourceIdType", # required
|
827
|
+
# version_id: "DocumentVersionIdType", # required
|
828
|
+
# delete_prior_versions: false, # required
|
829
|
+
# }
|
830
|
+
#
|
831
|
+
# @!attribute [rw] authentication_token
|
832
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
833
|
+
# administrator credentials to access the API.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] document_id
|
837
|
+
# The ID of a document.
|
838
|
+
# @return [String]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] version_id
|
841
|
+
# The version ID of a document.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] delete_prior_versions
|
845
|
+
# When set to `TRUE`, deletes the specified version and *all prior
|
846
|
+
# versions* of a document.
|
847
|
+
# @return [Boolean]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersionRequest AWS API Documentation
|
850
|
+
#
|
851
|
+
class DeleteDocumentVersionRequest < Struct.new(
|
852
|
+
:authentication_token,
|
853
|
+
:document_id,
|
854
|
+
:version_id,
|
855
|
+
:delete_prior_versions)
|
856
|
+
SENSITIVE = [:authentication_token]
|
857
|
+
include Aws::Structure
|
858
|
+
end
|
859
|
+
|
821
860
|
# @note When making an API call, you may pass DeleteFolderContentsRequest
|
822
861
|
# data as a hash:
|
823
862
|
#
|
@@ -977,7 +1016,7 @@ module Aws::WorkDocs
|
|
977
1016
|
# user_id: "IdType",
|
978
1017
|
# include_indirect_activities: false,
|
979
1018
|
# limit: 1,
|
980
|
-
# marker: "
|
1019
|
+
# marker: "SearchMarkerType",
|
981
1020
|
# }
|
982
1021
|
#
|
983
1022
|
# @!attribute [rw] authentication_token
|
@@ -1542,7 +1581,28 @@ module Aws::WorkDocs
|
|
1542
1581
|
# @return [String]
|
1543
1582
|
#
|
1544
1583
|
# @!attribute [rw] query
|
1545
|
-
# A query to filter users by user name.
|
1584
|
+
# A query to filter users by user name. Remember the following about
|
1585
|
+
# the `Userids` and `Query` parameters:
|
1586
|
+
#
|
1587
|
+
# * If you don't use either parameter, the API returns a paginated
|
1588
|
+
# list of all users on the site.
|
1589
|
+
#
|
1590
|
+
# * If you use both parameters, the API ignores the `Query` parameter.
|
1591
|
+
#
|
1592
|
+
# * The `Userid` parameter only returns user names that match a
|
1593
|
+
# corresponding user ID.
|
1594
|
+
#
|
1595
|
+
# * The `Query` parameter runs a "prefix" search for users by the
|
1596
|
+
# `GivenName`, `SurName`, or `UserName` fields included in a
|
1597
|
+
# [CreateUser][1] API call. For example, querying on `Ma` returns
|
1598
|
+
# Márcia Oliveira, María García, and Mateo Jackson. If you use
|
1599
|
+
# multiple characters, the API only returns data that matches all
|
1600
|
+
# characters. For example, querying on `Ma J` only returns Mateo
|
1601
|
+
# Jackson.
|
1602
|
+
#
|
1603
|
+
#
|
1604
|
+
#
|
1605
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html
|
1546
1606
|
# @return [String]
|
1547
1607
|
#
|
1548
1608
|
# @!attribute [rw] include
|
@@ -1783,6 +1843,7 @@ module Aws::WorkDocs
|
|
1783
1843
|
# @return [String]
|
1784
1844
|
#
|
1785
1845
|
# @!attribute [rw] entity_ids
|
1846
|
+
# The IDs of the non-existent resources.
|
1786
1847
|
# @return [Array<String>]
|
1787
1848
|
#
|
1788
1849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/EntityNotExistsException AWS API Documentation
|
@@ -2291,7 +2352,7 @@ module Aws::WorkDocs
|
|
2291
2352
|
# content_modified_timestamp: Time.now,
|
2292
2353
|
# content_type: "DocumentContentType",
|
2293
2354
|
# document_size_in_bytes: 1,
|
2294
|
-
# parent_folder_id: "ResourceIdType",
|
2355
|
+
# parent_folder_id: "ResourceIdType",
|
2295
2356
|
# }
|
2296
2357
|
#
|
2297
2358
|
# @!attribute [rw] authentication_token
|
@@ -2413,8 +2474,8 @@ module Aws::WorkDocs
|
|
2413
2474
|
include Aws::Structure
|
2414
2475
|
end
|
2415
2476
|
|
2416
|
-
# The maximum of 100,000 folders under the parent folder has
|
2417
|
-
# exceeded.
|
2477
|
+
# The maximum of 100,000 files and folders under the parent folder has
|
2478
|
+
# been exceeded.
|
2418
2479
|
#
|
2419
2480
|
# @!attribute [rw] message
|
2420
2481
|
# @return [String]
|
@@ -2699,6 +2760,32 @@ module Aws::WorkDocs
|
|
2699
2760
|
include Aws::Structure
|
2700
2761
|
end
|
2701
2762
|
|
2763
|
+
# @note When making an API call, you may pass RestoreDocumentVersionsRequest
|
2764
|
+
# data as a hash:
|
2765
|
+
#
|
2766
|
+
# {
|
2767
|
+
# authentication_token: "AuthenticationHeaderType",
|
2768
|
+
# document_id: "ResourceIdType", # required
|
2769
|
+
# }
|
2770
|
+
#
|
2771
|
+
# @!attribute [rw] authentication_token
|
2772
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2773
|
+
# administrator credentials to access the API.
|
2774
|
+
# @return [String]
|
2775
|
+
#
|
2776
|
+
# @!attribute [rw] document_id
|
2777
|
+
# The ID of the document.
|
2778
|
+
# @return [String]
|
2779
|
+
#
|
2780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersionsRequest AWS API Documentation
|
2781
|
+
#
|
2782
|
+
class RestoreDocumentVersionsRequest < Struct.new(
|
2783
|
+
:authentication_token,
|
2784
|
+
:document_id)
|
2785
|
+
SENSITIVE = [:authentication_token]
|
2786
|
+
include Aws::Structure
|
2787
|
+
end
|
2788
|
+
|
2702
2789
|
# One or more of the dependencies is unavailable.
|
2703
2790
|
#
|
2704
2791
|
# @!attribute [rw] message
|
@@ -3219,7 +3306,7 @@ module Aws::WorkDocs
|
|
3219
3306
|
:time_zone_id,
|
3220
3307
|
:locale,
|
3221
3308
|
:storage)
|
3222
|
-
SENSITIVE = []
|
3309
|
+
SENSITIVE = [:email_address]
|
3223
3310
|
include Aws::Structure
|
3224
3311
|
end
|
3225
3312
|
|
@@ -3253,7 +3340,7 @@ module Aws::WorkDocs
|
|
3253
3340
|
:given_name,
|
3254
3341
|
:surname,
|
3255
3342
|
:email_address)
|
3256
|
-
SENSITIVE = []
|
3343
|
+
SENSITIVE = [:email_address]
|
3257
3344
|
include Aws::Structure
|
3258
3345
|
end
|
3259
3346
|
|
data/lib/aws-sdk-workdocs.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-workdocs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.41.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-11-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|