aws-sdk-workdocs 1.40.0 → 1.42.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 +13 -1
- 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/endpoint_provider.rb +35 -95
- 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 +73 -476
- data/lib/aws-sdk-workdocs.rb +1 -1
- metadata +2 -2
@@ -10,15 +10,6 @@
|
|
10
10
|
module Aws::WorkDocs
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# @note When making an API call, you may pass AbortDocumentVersionUploadRequest
|
14
|
-
# data as a hash:
|
15
|
-
#
|
16
|
-
# {
|
17
|
-
# authentication_token: "AuthenticationHeaderType",
|
18
|
-
# document_id: "ResourceIdType", # required
|
19
|
-
# version_id: "DocumentVersionIdType", # required
|
20
|
-
# }
|
21
|
-
#
|
22
13
|
# @!attribute [rw] authentication_token
|
23
14
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
24
15
|
# administrator credentials to access the API.
|
@@ -42,14 +33,6 @@ module Aws::WorkDocs
|
|
42
33
|
include Aws::Structure
|
43
34
|
end
|
44
35
|
|
45
|
-
# @note When making an API call, you may pass ActivateUserRequest
|
46
|
-
# data as a hash:
|
47
|
-
#
|
48
|
-
# {
|
49
|
-
# user_id: "IdType", # required
|
50
|
-
# authentication_token: "AuthenticationHeaderType",
|
51
|
-
# }
|
52
|
-
#
|
53
36
|
# @!attribute [rw] user_id
|
54
37
|
# The ID of the user.
|
55
38
|
# @return [String]
|
@@ -143,25 +126,6 @@ module Aws::WorkDocs
|
|
143
126
|
include Aws::Structure
|
144
127
|
end
|
145
128
|
|
146
|
-
# @note When making an API call, you may pass AddResourcePermissionsRequest
|
147
|
-
# data as a hash:
|
148
|
-
#
|
149
|
-
# {
|
150
|
-
# authentication_token: "AuthenticationHeaderType",
|
151
|
-
# resource_id: "ResourceIdType", # required
|
152
|
-
# principals: [ # required
|
153
|
-
# {
|
154
|
-
# id: "IdType", # required
|
155
|
-
# type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
156
|
-
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
157
|
-
# },
|
158
|
-
# ],
|
159
|
-
# notification_options: {
|
160
|
-
# send_email: false,
|
161
|
-
# email_message: "MessageType",
|
162
|
-
# },
|
163
|
-
# }
|
164
|
-
#
|
165
129
|
# @!attribute [rw] authentication_token
|
166
130
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
167
131
|
# administrator credentials to access the API.
|
@@ -321,20 +285,6 @@ module Aws::WorkDocs
|
|
321
285
|
include Aws::Structure
|
322
286
|
end
|
323
287
|
|
324
|
-
# @note When making an API call, you may pass CreateCommentRequest
|
325
|
-
# data as a hash:
|
326
|
-
#
|
327
|
-
# {
|
328
|
-
# authentication_token: "AuthenticationHeaderType",
|
329
|
-
# document_id: "ResourceIdType", # required
|
330
|
-
# version_id: "DocumentVersionIdType", # required
|
331
|
-
# parent_id: "CommentIdType",
|
332
|
-
# thread_id: "CommentIdType",
|
333
|
-
# text: "CommentTextType", # required
|
334
|
-
# visibility: "PUBLIC", # accepts PUBLIC, PRIVATE
|
335
|
-
# notify_collaborators: false,
|
336
|
-
# }
|
337
|
-
#
|
338
288
|
# @!attribute [rw] authentication_token
|
339
289
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
340
290
|
# administrator credentials to access the API.
|
@@ -399,18 +349,6 @@ module Aws::WorkDocs
|
|
399
349
|
include Aws::Structure
|
400
350
|
end
|
401
351
|
|
402
|
-
# @note When making an API call, you may pass CreateCustomMetadataRequest
|
403
|
-
# data as a hash:
|
404
|
-
#
|
405
|
-
# {
|
406
|
-
# authentication_token: "AuthenticationHeaderType",
|
407
|
-
# resource_id: "ResourceIdType", # required
|
408
|
-
# version_id: "DocumentVersionIdType",
|
409
|
-
# custom_metadata: { # required
|
410
|
-
# "CustomMetadataKeyType" => "CustomMetadataValueType",
|
411
|
-
# },
|
412
|
-
# }
|
413
|
-
#
|
414
352
|
# @!attribute [rw] authentication_token
|
415
353
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
416
354
|
# administrator credentials to access the API.
|
@@ -444,15 +382,6 @@ module Aws::WorkDocs
|
|
444
382
|
#
|
445
383
|
class CreateCustomMetadataResponse < Aws::EmptyStructure; end
|
446
384
|
|
447
|
-
# @note When making an API call, you may pass CreateFolderRequest
|
448
|
-
# data as a hash:
|
449
|
-
#
|
450
|
-
# {
|
451
|
-
# authentication_token: "AuthenticationHeaderType",
|
452
|
-
# name: "ResourceNameType",
|
453
|
-
# parent_folder_id: "ResourceIdType", # required
|
454
|
-
# }
|
455
|
-
#
|
456
385
|
# @!attribute [rw] authentication_token
|
457
386
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
458
387
|
# administrator credentials to access the API.
|
@@ -488,15 +417,6 @@ module Aws::WorkDocs
|
|
488
417
|
include Aws::Structure
|
489
418
|
end
|
490
419
|
|
491
|
-
# @note When making an API call, you may pass CreateLabelsRequest
|
492
|
-
# data as a hash:
|
493
|
-
#
|
494
|
-
# {
|
495
|
-
# resource_id: "ResourceIdType", # required
|
496
|
-
# labels: ["SharedLabel"], # required
|
497
|
-
# authentication_token: "AuthenticationHeaderType",
|
498
|
-
# }
|
499
|
-
#
|
500
420
|
# @!attribute [rw] resource_id
|
501
421
|
# The ID of the resource.
|
502
422
|
# @return [String]
|
@@ -524,16 +444,6 @@ module Aws::WorkDocs
|
|
524
444
|
#
|
525
445
|
class CreateLabelsResponse < Aws::EmptyStructure; end
|
526
446
|
|
527
|
-
# @note When making an API call, you may pass CreateNotificationSubscriptionRequest
|
528
|
-
# data as a hash:
|
529
|
-
#
|
530
|
-
# {
|
531
|
-
# organization_id: "IdType", # required
|
532
|
-
# endpoint: "SubscriptionEndPointType", # required
|
533
|
-
# protocol: "HTTPS", # required, accepts HTTPS
|
534
|
-
# subscription_type: "ALL", # required, accepts ALL
|
535
|
-
# }
|
536
|
-
#
|
537
447
|
# @!attribute [rw] organization_id
|
538
448
|
# The ID of the organization.
|
539
449
|
# @return [String]
|
@@ -575,24 +485,6 @@ module Aws::WorkDocs
|
|
575
485
|
include Aws::Structure
|
576
486
|
end
|
577
487
|
|
578
|
-
# @note When making an API call, you may pass CreateUserRequest
|
579
|
-
# data as a hash:
|
580
|
-
#
|
581
|
-
# {
|
582
|
-
# organization_id: "IdType",
|
583
|
-
# username: "UsernameType", # required
|
584
|
-
# email_address: "EmailAddressType",
|
585
|
-
# given_name: "UserAttributeValueType", # required
|
586
|
-
# surname: "UserAttributeValueType", # required
|
587
|
-
# password: "PasswordType", # required
|
588
|
-
# time_zone_id: "TimeZoneIdType",
|
589
|
-
# storage_rule: {
|
590
|
-
# storage_allocated_in_bytes: 1,
|
591
|
-
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
592
|
-
# },
|
593
|
-
# authentication_token: "AuthenticationHeaderType",
|
594
|
-
# }
|
595
|
-
#
|
596
488
|
# @!attribute [rw] organization_id
|
597
489
|
# The ID of the organization.
|
598
490
|
# @return [String]
|
@@ -642,7 +534,7 @@ module Aws::WorkDocs
|
|
642
534
|
:time_zone_id,
|
643
535
|
:storage_rule,
|
644
536
|
:authentication_token)
|
645
|
-
SENSITIVE = [:password, :authentication_token]
|
537
|
+
SENSITIVE = [:email_address, :password, :authentication_token]
|
646
538
|
include Aws::Structure
|
647
539
|
end
|
648
540
|
|
@@ -672,14 +564,6 @@ module Aws::WorkDocs
|
|
672
564
|
include Aws::Structure
|
673
565
|
end
|
674
566
|
|
675
|
-
# @note When making an API call, you may pass DeactivateUserRequest
|
676
|
-
# data as a hash:
|
677
|
-
#
|
678
|
-
# {
|
679
|
-
# user_id: "IdType", # required
|
680
|
-
# authentication_token: "AuthenticationHeaderType",
|
681
|
-
# }
|
682
|
-
#
|
683
567
|
# @!attribute [rw] user_id
|
684
568
|
# The ID of the user.
|
685
569
|
# @return [String]
|
@@ -704,16 +588,6 @@ module Aws::WorkDocs
|
|
704
588
|
#
|
705
589
|
class DeactivatingLastSystemUserException < Aws::EmptyStructure; end
|
706
590
|
|
707
|
-
# @note When making an API call, you may pass DeleteCommentRequest
|
708
|
-
# data as a hash:
|
709
|
-
#
|
710
|
-
# {
|
711
|
-
# authentication_token: "AuthenticationHeaderType",
|
712
|
-
# document_id: "ResourceIdType", # required
|
713
|
-
# version_id: "DocumentVersionIdType", # required
|
714
|
-
# comment_id: "CommentIdType", # required
|
715
|
-
# }
|
716
|
-
#
|
717
591
|
# @!attribute [rw] authentication_token
|
718
592
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
719
593
|
# administrator credentials to access the API.
|
@@ -742,17 +616,6 @@ module Aws::WorkDocs
|
|
742
616
|
include Aws::Structure
|
743
617
|
end
|
744
618
|
|
745
|
-
# @note When making an API call, you may pass DeleteCustomMetadataRequest
|
746
|
-
# data as a hash:
|
747
|
-
#
|
748
|
-
# {
|
749
|
-
# authentication_token: "AuthenticationHeaderType",
|
750
|
-
# resource_id: "ResourceIdType", # required
|
751
|
-
# version_id: "DocumentVersionIdType",
|
752
|
-
# keys: ["CustomMetadataKeyType"],
|
753
|
-
# delete_all: false,
|
754
|
-
# }
|
755
|
-
#
|
756
619
|
# @!attribute [rw] authentication_token
|
757
620
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
758
621
|
# administrator credentials to access the API.
|
@@ -792,14 +655,6 @@ module Aws::WorkDocs
|
|
792
655
|
#
|
793
656
|
class DeleteCustomMetadataResponse < Aws::EmptyStructure; end
|
794
657
|
|
795
|
-
# @note When making an API call, you may pass DeleteDocumentRequest
|
796
|
-
# data as a hash:
|
797
|
-
#
|
798
|
-
# {
|
799
|
-
# authentication_token: "AuthenticationHeaderType",
|
800
|
-
# document_id: "ResourceIdType", # required
|
801
|
-
# }
|
802
|
-
#
|
803
658
|
# @!attribute [rw] authentication_token
|
804
659
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
805
660
|
# administrator credentials to access the API.
|
@@ -818,14 +673,35 @@ module Aws::WorkDocs
|
|
818
673
|
include Aws::Structure
|
819
674
|
end
|
820
675
|
|
821
|
-
#
|
822
|
-
#
|
676
|
+
# @!attribute [rw] authentication_token
|
677
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
678
|
+
# administrator credentials to access the API.
|
679
|
+
# @return [String]
|
823
680
|
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
# }
|
681
|
+
# @!attribute [rw] document_id
|
682
|
+
# The ID of a document.
|
683
|
+
# @return [String]
|
828
684
|
#
|
685
|
+
# @!attribute [rw] version_id
|
686
|
+
# The version ID of a document.
|
687
|
+
# @return [String]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] delete_prior_versions
|
690
|
+
# When set to `TRUE`, deletes the specified version and *all prior
|
691
|
+
# versions* of a document.
|
692
|
+
# @return [Boolean]
|
693
|
+
#
|
694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersionRequest AWS API Documentation
|
695
|
+
#
|
696
|
+
class DeleteDocumentVersionRequest < Struct.new(
|
697
|
+
:authentication_token,
|
698
|
+
:document_id,
|
699
|
+
:version_id,
|
700
|
+
:delete_prior_versions)
|
701
|
+
SENSITIVE = [:authentication_token]
|
702
|
+
include Aws::Structure
|
703
|
+
end
|
704
|
+
|
829
705
|
# @!attribute [rw] authentication_token
|
830
706
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
831
707
|
# administrator credentials to access the API.
|
@@ -844,14 +720,6 @@ module Aws::WorkDocs
|
|
844
720
|
include Aws::Structure
|
845
721
|
end
|
846
722
|
|
847
|
-
# @note When making an API call, you may pass DeleteFolderRequest
|
848
|
-
# data as a hash:
|
849
|
-
#
|
850
|
-
# {
|
851
|
-
# authentication_token: "AuthenticationHeaderType",
|
852
|
-
# folder_id: "ResourceIdType", # required
|
853
|
-
# }
|
854
|
-
#
|
855
723
|
# @!attribute [rw] authentication_token
|
856
724
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
857
725
|
# administrator credentials to access the API.
|
@@ -870,16 +738,6 @@ module Aws::WorkDocs
|
|
870
738
|
include Aws::Structure
|
871
739
|
end
|
872
740
|
|
873
|
-
# @note When making an API call, you may pass DeleteLabelsRequest
|
874
|
-
# data as a hash:
|
875
|
-
#
|
876
|
-
# {
|
877
|
-
# resource_id: "ResourceIdType", # required
|
878
|
-
# authentication_token: "AuthenticationHeaderType",
|
879
|
-
# labels: ["SharedLabel"],
|
880
|
-
# delete_all: false,
|
881
|
-
# }
|
882
|
-
#
|
883
741
|
# @!attribute [rw] resource_id
|
884
742
|
# The ID of the resource.
|
885
743
|
# @return [String]
|
@@ -912,14 +770,6 @@ module Aws::WorkDocs
|
|
912
770
|
#
|
913
771
|
class DeleteLabelsResponse < Aws::EmptyStructure; end
|
914
772
|
|
915
|
-
# @note When making an API call, you may pass DeleteNotificationSubscriptionRequest
|
916
|
-
# data as a hash:
|
917
|
-
#
|
918
|
-
# {
|
919
|
-
# subscription_id: "IdType", # required
|
920
|
-
# organization_id: "IdType", # required
|
921
|
-
# }
|
922
|
-
#
|
923
773
|
# @!attribute [rw] subscription_id
|
924
774
|
# The ID of the subscription.
|
925
775
|
# @return [String]
|
@@ -937,14 +787,6 @@ module Aws::WorkDocs
|
|
937
787
|
include Aws::Structure
|
938
788
|
end
|
939
789
|
|
940
|
-
# @note When making an API call, you may pass DeleteUserRequest
|
941
|
-
# data as a hash:
|
942
|
-
#
|
943
|
-
# {
|
944
|
-
# authentication_token: "AuthenticationHeaderType",
|
945
|
-
# user_id: "IdType", # required
|
946
|
-
# }
|
947
|
-
#
|
948
790
|
# @!attribute [rw] authentication_token
|
949
791
|
# Amazon WorkDocs authentication token. Do not set this field when
|
950
792
|
# using administrative API actions, as in accessing the API using AWS
|
@@ -964,22 +806,6 @@ module Aws::WorkDocs
|
|
964
806
|
include Aws::Structure
|
965
807
|
end
|
966
808
|
|
967
|
-
# @note When making an API call, you may pass DescribeActivitiesRequest
|
968
|
-
# data as a hash:
|
969
|
-
#
|
970
|
-
# {
|
971
|
-
# authentication_token: "AuthenticationHeaderType",
|
972
|
-
# start_time: Time.now,
|
973
|
-
# end_time: Time.now,
|
974
|
-
# organization_id: "IdType",
|
975
|
-
# activity_types: "ActivityNamesFilterType",
|
976
|
-
# resource_id: "IdType",
|
977
|
-
# user_id: "IdType",
|
978
|
-
# include_indirect_activities: false,
|
979
|
-
# limit: 1,
|
980
|
-
# marker: "MarkerType",
|
981
|
-
# }
|
982
|
-
#
|
983
809
|
# @!attribute [rw] authentication_token
|
984
810
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
985
811
|
# administrator credentials to access the API.
|
@@ -1066,17 +892,6 @@ module Aws::WorkDocs
|
|
1066
892
|
include Aws::Structure
|
1067
893
|
end
|
1068
894
|
|
1069
|
-
# @note When making an API call, you may pass DescribeCommentsRequest
|
1070
|
-
# data as a hash:
|
1071
|
-
#
|
1072
|
-
# {
|
1073
|
-
# authentication_token: "AuthenticationHeaderType",
|
1074
|
-
# document_id: "ResourceIdType", # required
|
1075
|
-
# version_id: "DocumentVersionIdType", # required
|
1076
|
-
# limit: 1,
|
1077
|
-
# marker: "MarkerType",
|
1078
|
-
# }
|
1079
|
-
#
|
1080
895
|
# @!attribute [rw] authentication_token
|
1081
896
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1082
897
|
# administrator credentials to access the API.
|
@@ -1129,18 +944,6 @@ module Aws::WorkDocs
|
|
1129
944
|
include Aws::Structure
|
1130
945
|
end
|
1131
946
|
|
1132
|
-
# @note When making an API call, you may pass DescribeDocumentVersionsRequest
|
1133
|
-
# data as a hash:
|
1134
|
-
#
|
1135
|
-
# {
|
1136
|
-
# authentication_token: "AuthenticationHeaderType",
|
1137
|
-
# document_id: "ResourceIdType", # required
|
1138
|
-
# marker: "PageMarkerType",
|
1139
|
-
# limit: 1,
|
1140
|
-
# include: "FieldNamesType",
|
1141
|
-
# fields: "FieldNamesType",
|
1142
|
-
# }
|
1143
|
-
#
|
1144
947
|
# @!attribute [rw] authentication_token
|
1145
948
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1146
949
|
# administrator credentials to access the API.
|
@@ -1200,20 +1003,6 @@ module Aws::WorkDocs
|
|
1200
1003
|
include Aws::Structure
|
1201
1004
|
end
|
1202
1005
|
|
1203
|
-
# @note When making an API call, you may pass DescribeFolderContentsRequest
|
1204
|
-
# data as a hash:
|
1205
|
-
#
|
1206
|
-
# {
|
1207
|
-
# authentication_token: "AuthenticationHeaderType",
|
1208
|
-
# folder_id: "ResourceIdType", # required
|
1209
|
-
# sort: "DATE", # accepts DATE, NAME
|
1210
|
-
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1211
|
-
# limit: 1,
|
1212
|
-
# marker: "PageMarkerType",
|
1213
|
-
# type: "ALL", # accepts ALL, DOCUMENT, FOLDER
|
1214
|
-
# include: "FieldNamesType",
|
1215
|
-
# }
|
1216
|
-
#
|
1217
1006
|
# @!attribute [rw] authentication_token
|
1218
1007
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1219
1008
|
# administrator credentials to access the API.
|
@@ -1287,17 +1076,6 @@ module Aws::WorkDocs
|
|
1287
1076
|
include Aws::Structure
|
1288
1077
|
end
|
1289
1078
|
|
1290
|
-
# @note When making an API call, you may pass DescribeGroupsRequest
|
1291
|
-
# data as a hash:
|
1292
|
-
#
|
1293
|
-
# {
|
1294
|
-
# authentication_token: "AuthenticationHeaderType",
|
1295
|
-
# search_query: "SearchQueryType", # required
|
1296
|
-
# organization_id: "IdType",
|
1297
|
-
# marker: "MarkerType",
|
1298
|
-
# limit: 1,
|
1299
|
-
# }
|
1300
|
-
#
|
1301
1079
|
# @!attribute [rw] authentication_token
|
1302
1080
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1303
1081
|
# administrator credentials to access the API.
|
@@ -1350,15 +1128,6 @@ module Aws::WorkDocs
|
|
1350
1128
|
include Aws::Structure
|
1351
1129
|
end
|
1352
1130
|
|
1353
|
-
# @note When making an API call, you may pass DescribeNotificationSubscriptionsRequest
|
1354
|
-
# data as a hash:
|
1355
|
-
#
|
1356
|
-
# {
|
1357
|
-
# organization_id: "IdType", # required
|
1358
|
-
# marker: "PageMarkerType",
|
1359
|
-
# limit: 1,
|
1360
|
-
# }
|
1361
|
-
#
|
1362
1131
|
# @!attribute [rw] organization_id
|
1363
1132
|
# The ID of the organization.
|
1364
1133
|
# @return [String]
|
@@ -1400,17 +1169,6 @@ module Aws::WorkDocs
|
|
1400
1169
|
include Aws::Structure
|
1401
1170
|
end
|
1402
1171
|
|
1403
|
-
# @note When making an API call, you may pass DescribeResourcePermissionsRequest
|
1404
|
-
# data as a hash:
|
1405
|
-
#
|
1406
|
-
# {
|
1407
|
-
# authentication_token: "AuthenticationHeaderType",
|
1408
|
-
# resource_id: "ResourceIdType", # required
|
1409
|
-
# principal_id: "IdType",
|
1410
|
-
# limit: 1,
|
1411
|
-
# marker: "PageMarkerType",
|
1412
|
-
# }
|
1413
|
-
#
|
1414
1172
|
# @!attribute [rw] authentication_token
|
1415
1173
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1416
1174
|
# administrator credentials to access the API.
|
@@ -1463,15 +1221,6 @@ module Aws::WorkDocs
|
|
1463
1221
|
include Aws::Structure
|
1464
1222
|
end
|
1465
1223
|
|
1466
|
-
# @note When making an API call, you may pass DescribeRootFoldersRequest
|
1467
|
-
# data as a hash:
|
1468
|
-
#
|
1469
|
-
# {
|
1470
|
-
# authentication_token: "AuthenticationHeaderType", # required
|
1471
|
-
# limit: 1,
|
1472
|
-
# marker: "PageMarkerType",
|
1473
|
-
# }
|
1474
|
-
#
|
1475
1224
|
# @!attribute [rw] authentication_token
|
1476
1225
|
# Amazon WorkDocs authentication token.
|
1477
1226
|
# @return [String]
|
@@ -1512,22 +1261,6 @@ module Aws::WorkDocs
|
|
1512
1261
|
include Aws::Structure
|
1513
1262
|
end
|
1514
1263
|
|
1515
|
-
# @note When making an API call, you may pass DescribeUsersRequest
|
1516
|
-
# data as a hash:
|
1517
|
-
#
|
1518
|
-
# {
|
1519
|
-
# authentication_token: "AuthenticationHeaderType",
|
1520
|
-
# organization_id: "IdType",
|
1521
|
-
# user_ids: "UserIdsType",
|
1522
|
-
# query: "SearchQueryType",
|
1523
|
-
# include: "ALL", # accepts ALL, ACTIVE_PENDING
|
1524
|
-
# order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
1525
|
-
# sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
|
1526
|
-
# marker: "PageMarkerType",
|
1527
|
-
# limit: 1,
|
1528
|
-
# fields: "FieldNamesType",
|
1529
|
-
# }
|
1530
|
-
#
|
1531
1264
|
# @!attribute [rw] authentication_token
|
1532
1265
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1533
1266
|
# administrator credentials to access the API.
|
@@ -1542,7 +1275,28 @@ module Aws::WorkDocs
|
|
1542
1275
|
# @return [String]
|
1543
1276
|
#
|
1544
1277
|
# @!attribute [rw] query
|
1545
|
-
# A query to filter users by user name.
|
1278
|
+
# A query to filter users by user name. Remember the following about
|
1279
|
+
# the `Userids` and `Query` parameters:
|
1280
|
+
#
|
1281
|
+
# * If you don't use either parameter, the API returns a paginated
|
1282
|
+
# list of all users on the site.
|
1283
|
+
#
|
1284
|
+
# * If you use both parameters, the API ignores the `Query` parameter.
|
1285
|
+
#
|
1286
|
+
# * The `Userid` parameter only returns user names that match a
|
1287
|
+
# corresponding user ID.
|
1288
|
+
#
|
1289
|
+
# * The `Query` parameter runs a "prefix" search for users by the
|
1290
|
+
# `GivenName`, `SurName`, or `UserName` fields included in a
|
1291
|
+
# [CreateUser][1] API call. For example, querying on `Ma` returns
|
1292
|
+
# Márcia Oliveira, María García, and Mateo Jackson. If you use
|
1293
|
+
# multiple characters, the API only returns data that matches all
|
1294
|
+
# characters. For example, querying on `Ma J` only returns Mateo
|
1295
|
+
# Jackson.
|
1296
|
+
#
|
1297
|
+
#
|
1298
|
+
#
|
1299
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html
|
1546
1300
|
# @return [String]
|
1547
1301
|
#
|
1548
1302
|
# @!attribute [rw] include
|
@@ -1783,6 +1537,7 @@ module Aws::WorkDocs
|
|
1783
1537
|
# @return [String]
|
1784
1538
|
#
|
1785
1539
|
# @!attribute [rw] entity_ids
|
1540
|
+
# The IDs of the non-existent resources.
|
1786
1541
|
# @return [Array<String>]
|
1787
1542
|
#
|
1788
1543
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/EntityNotExistsException AWS API Documentation
|
@@ -1874,13 +1629,6 @@ module Aws::WorkDocs
|
|
1874
1629
|
include Aws::Structure
|
1875
1630
|
end
|
1876
1631
|
|
1877
|
-
# @note When making an API call, you may pass GetCurrentUserRequest
|
1878
|
-
# data as a hash:
|
1879
|
-
#
|
1880
|
-
# {
|
1881
|
-
# authentication_token: "AuthenticationHeaderType", # required
|
1882
|
-
# }
|
1883
|
-
#
|
1884
1632
|
# @!attribute [rw] authentication_token
|
1885
1633
|
# Amazon WorkDocs authentication token.
|
1886
1634
|
# @return [String]
|
@@ -1905,17 +1653,6 @@ module Aws::WorkDocs
|
|
1905
1653
|
include Aws::Structure
|
1906
1654
|
end
|
1907
1655
|
|
1908
|
-
# @note When making an API call, you may pass GetDocumentPathRequest
|
1909
|
-
# data as a hash:
|
1910
|
-
#
|
1911
|
-
# {
|
1912
|
-
# authentication_token: "AuthenticationHeaderType",
|
1913
|
-
# document_id: "IdType", # required
|
1914
|
-
# limit: 1,
|
1915
|
-
# fields: "FieldNamesType",
|
1916
|
-
# marker: "PageMarkerType",
|
1917
|
-
# }
|
1918
|
-
#
|
1919
1656
|
# @!attribute [rw] authentication_token
|
1920
1657
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1921
1658
|
# administrator credentials to access the API.
|
@@ -1962,15 +1699,6 @@ module Aws::WorkDocs
|
|
1962
1699
|
include Aws::Structure
|
1963
1700
|
end
|
1964
1701
|
|
1965
|
-
# @note When making an API call, you may pass GetDocumentRequest
|
1966
|
-
# data as a hash:
|
1967
|
-
#
|
1968
|
-
# {
|
1969
|
-
# authentication_token: "AuthenticationHeaderType",
|
1970
|
-
# document_id: "ResourceIdType", # required
|
1971
|
-
# include_custom_metadata: false,
|
1972
|
-
# }
|
1973
|
-
#
|
1974
1702
|
# @!attribute [rw] authentication_token
|
1975
1703
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
1976
1704
|
# administrator credentials to access the API.
|
@@ -2011,17 +1739,6 @@ module Aws::WorkDocs
|
|
2011
1739
|
include Aws::Structure
|
2012
1740
|
end
|
2013
1741
|
|
2014
|
-
# @note When making an API call, you may pass GetDocumentVersionRequest
|
2015
|
-
# data as a hash:
|
2016
|
-
#
|
2017
|
-
# {
|
2018
|
-
# authentication_token: "AuthenticationHeaderType",
|
2019
|
-
# document_id: "ResourceIdType", # required
|
2020
|
-
# version_id: "DocumentVersionIdType", # required
|
2021
|
-
# fields: "FieldNamesType",
|
2022
|
-
# include_custom_metadata: false,
|
2023
|
-
# }
|
2024
|
-
#
|
2025
1742
|
# @!attribute [rw] authentication_token
|
2026
1743
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2027
1744
|
# administrator credentials to access the API.
|
@@ -2073,17 +1790,6 @@ module Aws::WorkDocs
|
|
2073
1790
|
include Aws::Structure
|
2074
1791
|
end
|
2075
1792
|
|
2076
|
-
# @note When making an API call, you may pass GetFolderPathRequest
|
2077
|
-
# data as a hash:
|
2078
|
-
#
|
2079
|
-
# {
|
2080
|
-
# authentication_token: "AuthenticationHeaderType",
|
2081
|
-
# folder_id: "IdType", # required
|
2082
|
-
# limit: 1,
|
2083
|
-
# fields: "FieldNamesType",
|
2084
|
-
# marker: "PageMarkerType",
|
2085
|
-
# }
|
2086
|
-
#
|
2087
1793
|
# @!attribute [rw] authentication_token
|
2088
1794
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2089
1795
|
# administrator credentials to access the API.
|
@@ -2130,15 +1836,6 @@ module Aws::WorkDocs
|
|
2130
1836
|
include Aws::Structure
|
2131
1837
|
end
|
2132
1838
|
|
2133
|
-
# @note When making an API call, you may pass GetFolderRequest
|
2134
|
-
# data as a hash:
|
2135
|
-
#
|
2136
|
-
# {
|
2137
|
-
# authentication_token: "AuthenticationHeaderType",
|
2138
|
-
# folder_id: "ResourceIdType", # required
|
2139
|
-
# include_custom_metadata: false,
|
2140
|
-
# }
|
2141
|
-
#
|
2142
1839
|
# @!attribute [rw] authentication_token
|
2143
1840
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2144
1841
|
# administrator credentials to access the API.
|
@@ -2179,17 +1876,6 @@ module Aws::WorkDocs
|
|
2179
1876
|
include Aws::Structure
|
2180
1877
|
end
|
2181
1878
|
|
2182
|
-
# @note When making an API call, you may pass GetResourcesRequest
|
2183
|
-
# data as a hash:
|
2184
|
-
#
|
2185
|
-
# {
|
2186
|
-
# authentication_token: "AuthenticationHeaderType",
|
2187
|
-
# user_id: "IdType",
|
2188
|
-
# collection_type: "SHARED_WITH_ME", # accepts SHARED_WITH_ME
|
2189
|
-
# limit: 1,
|
2190
|
-
# marker: "PageMarkerType",
|
2191
|
-
# }
|
2192
|
-
#
|
2193
1879
|
# @!attribute [rw] authentication_token
|
2194
1880
|
# The Amazon WorkDocs authentication token. Not required when using
|
2195
1881
|
# AWS administrator credentials to access the API.
|
@@ -2280,20 +1966,6 @@ module Aws::WorkDocs
|
|
2280
1966
|
include Aws::Structure
|
2281
1967
|
end
|
2282
1968
|
|
2283
|
-
# @note When making an API call, you may pass InitiateDocumentVersionUploadRequest
|
2284
|
-
# data as a hash:
|
2285
|
-
#
|
2286
|
-
# {
|
2287
|
-
# authentication_token: "AuthenticationHeaderType",
|
2288
|
-
# id: "ResourceIdType",
|
2289
|
-
# name: "ResourceNameType",
|
2290
|
-
# content_created_timestamp: Time.now,
|
2291
|
-
# content_modified_timestamp: Time.now,
|
2292
|
-
# content_type: "DocumentContentType",
|
2293
|
-
# document_size_in_bytes: 1,
|
2294
|
-
# parent_folder_id: "ResourceIdType", # required
|
2295
|
-
# }
|
2296
|
-
#
|
2297
1969
|
# @!attribute [rw] authentication_token
|
2298
1970
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2299
1971
|
# administrator credentials to access the API.
|
@@ -2413,8 +2085,8 @@ module Aws::WorkDocs
|
|
2413
2085
|
include Aws::Structure
|
2414
2086
|
end
|
2415
2087
|
|
2416
|
-
# The maximum of 100,000 folders under the parent folder has
|
2417
|
-
# exceeded.
|
2088
|
+
# The maximum of 100,000 files and folders under the parent folder has
|
2089
|
+
# been exceeded.
|
2418
2090
|
#
|
2419
2091
|
# @!attribute [rw] message
|
2420
2092
|
# @return [String]
|
@@ -2429,14 +2101,6 @@ module Aws::WorkDocs
|
|
2429
2101
|
|
2430
2102
|
# Set of options which defines notification preferences of given action.
|
2431
2103
|
#
|
2432
|
-
# @note When making an API call, you may pass NotificationOptions
|
2433
|
-
# data as a hash:
|
2434
|
-
#
|
2435
|
-
# {
|
2436
|
-
# send_email: false,
|
2437
|
-
# email_message: "MessageType",
|
2438
|
-
# }
|
2439
|
-
#
|
2440
2104
|
# @!attribute [rw] send_email
|
2441
2105
|
# Boolean value to indicate an email notification should be sent to
|
2442
2106
|
# the receipients.
|
@@ -2530,14 +2194,6 @@ module Aws::WorkDocs
|
|
2530
2194
|
include Aws::Structure
|
2531
2195
|
end
|
2532
2196
|
|
2533
|
-
# @note When making an API call, you may pass RemoveAllResourcePermissionsRequest
|
2534
|
-
# data as a hash:
|
2535
|
-
#
|
2536
|
-
# {
|
2537
|
-
# authentication_token: "AuthenticationHeaderType",
|
2538
|
-
# resource_id: "ResourceIdType", # required
|
2539
|
-
# }
|
2540
|
-
#
|
2541
2197
|
# @!attribute [rw] authentication_token
|
2542
2198
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2543
2199
|
# administrator credentials to access the API.
|
@@ -2556,16 +2212,6 @@ module Aws::WorkDocs
|
|
2556
2212
|
include Aws::Structure
|
2557
2213
|
end
|
2558
2214
|
|
2559
|
-
# @note When making an API call, you may pass RemoveResourcePermissionRequest
|
2560
|
-
# data as a hash:
|
2561
|
-
#
|
2562
|
-
# {
|
2563
|
-
# authentication_token: "AuthenticationHeaderType",
|
2564
|
-
# resource_id: "ResourceIdType", # required
|
2565
|
-
# principal_id: "IdType", # required
|
2566
|
-
# principal_type: "USER", # accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
2567
|
-
# }
|
2568
|
-
#
|
2569
2215
|
# @!attribute [rw] authentication_token
|
2570
2216
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2571
2217
|
# administrator credentials to access the API.
|
@@ -2699,6 +2345,24 @@ module Aws::WorkDocs
|
|
2699
2345
|
include Aws::Structure
|
2700
2346
|
end
|
2701
2347
|
|
2348
|
+
# @!attribute [rw] authentication_token
|
2349
|
+
# Amazon WorkDocs authentication token. Not required when using AWS
|
2350
|
+
# administrator credentials to access the API.
|
2351
|
+
# @return [String]
|
2352
|
+
#
|
2353
|
+
# @!attribute [rw] document_id
|
2354
|
+
# The ID of the document.
|
2355
|
+
# @return [String]
|
2356
|
+
#
|
2357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersionsRequest AWS API Documentation
|
2358
|
+
#
|
2359
|
+
class RestoreDocumentVersionsRequest < Struct.new(
|
2360
|
+
:authentication_token,
|
2361
|
+
:document_id)
|
2362
|
+
SENSITIVE = [:authentication_token]
|
2363
|
+
include Aws::Structure
|
2364
|
+
end
|
2365
|
+
|
2702
2366
|
# One or more of the dependencies is unavailable.
|
2703
2367
|
#
|
2704
2368
|
# @!attribute [rw] message
|
@@ -2714,15 +2378,6 @@ module Aws::WorkDocs
|
|
2714
2378
|
|
2715
2379
|
# Describes the recipient type and ID, if available.
|
2716
2380
|
#
|
2717
|
-
# @note When making an API call, you may pass SharePrincipal
|
2718
|
-
# data as a hash:
|
2719
|
-
#
|
2720
|
-
# {
|
2721
|
-
# id: "IdType", # required
|
2722
|
-
# type: "USER", # required, accepts USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION
|
2723
|
-
# role: "VIEWER", # required, accepts VIEWER, CONTRIBUTOR, OWNER, COOWNER
|
2724
|
-
# }
|
2725
|
-
#
|
2726
2381
|
# @!attribute [rw] id
|
2727
2382
|
# The ID of the recipient.
|
2728
2383
|
# @return [String]
|
@@ -2812,14 +2467,6 @@ module Aws::WorkDocs
|
|
2812
2467
|
|
2813
2468
|
# Describes the storage for a user.
|
2814
2469
|
#
|
2815
|
-
# @note When making an API call, you may pass StorageRuleType
|
2816
|
-
# data as a hash:
|
2817
|
-
#
|
2818
|
-
# {
|
2819
|
-
# storage_allocated_in_bytes: 1,
|
2820
|
-
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
2821
|
-
# }
|
2822
|
-
#
|
2823
2470
|
# @!attribute [rw] storage_allocated_in_bytes
|
2824
2471
|
# The amount of storage allocated, in bytes.
|
2825
2472
|
# @return [Integer]
|
@@ -2908,17 +2555,6 @@ module Aws::WorkDocs
|
|
2908
2555
|
include Aws::Structure
|
2909
2556
|
end
|
2910
2557
|
|
2911
|
-
# @note When making an API call, you may pass UpdateDocumentRequest
|
2912
|
-
# data as a hash:
|
2913
|
-
#
|
2914
|
-
# {
|
2915
|
-
# authentication_token: "AuthenticationHeaderType",
|
2916
|
-
# document_id: "ResourceIdType", # required
|
2917
|
-
# name: "ResourceNameType",
|
2918
|
-
# parent_folder_id: "ResourceIdType",
|
2919
|
-
# resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
|
2920
|
-
# }
|
2921
|
-
#
|
2922
2558
|
# @!attribute [rw] authentication_token
|
2923
2559
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2924
2560
|
# administrator credentials to access the API.
|
@@ -2953,16 +2589,6 @@ module Aws::WorkDocs
|
|
2953
2589
|
include Aws::Structure
|
2954
2590
|
end
|
2955
2591
|
|
2956
|
-
# @note When making an API call, you may pass UpdateDocumentVersionRequest
|
2957
|
-
# data as a hash:
|
2958
|
-
#
|
2959
|
-
# {
|
2960
|
-
# authentication_token: "AuthenticationHeaderType",
|
2961
|
-
# document_id: "ResourceIdType", # required
|
2962
|
-
# version_id: "DocumentVersionIdType", # required
|
2963
|
-
# version_status: "ACTIVE", # accepts ACTIVE
|
2964
|
-
# }
|
2965
|
-
#
|
2966
2592
|
# @!attribute [rw] authentication_token
|
2967
2593
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
2968
2594
|
# administrator credentials to access the API.
|
@@ -2991,17 +2617,6 @@ module Aws::WorkDocs
|
|
2991
2617
|
include Aws::Structure
|
2992
2618
|
end
|
2993
2619
|
|
2994
|
-
# @note When making an API call, you may pass UpdateFolderRequest
|
2995
|
-
# data as a hash:
|
2996
|
-
#
|
2997
|
-
# {
|
2998
|
-
# authentication_token: "AuthenticationHeaderType",
|
2999
|
-
# folder_id: "ResourceIdType", # required
|
3000
|
-
# name: "ResourceNameType",
|
3001
|
-
# parent_folder_id: "ResourceIdType",
|
3002
|
-
# resource_state: "ACTIVE", # accepts ACTIVE, RESTORING, RECYCLING, RECYCLED
|
3003
|
-
# }
|
3004
|
-
#
|
3005
2620
|
# @!attribute [rw] authentication_token
|
3006
2621
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
3007
2622
|
# administrator credentials to access the API.
|
@@ -3036,24 +2651,6 @@ module Aws::WorkDocs
|
|
3036
2651
|
include Aws::Structure
|
3037
2652
|
end
|
3038
2653
|
|
3039
|
-
# @note When making an API call, you may pass UpdateUserRequest
|
3040
|
-
# data as a hash:
|
3041
|
-
#
|
3042
|
-
# {
|
3043
|
-
# authentication_token: "AuthenticationHeaderType",
|
3044
|
-
# user_id: "IdType", # required
|
3045
|
-
# given_name: "UserAttributeValueType",
|
3046
|
-
# surname: "UserAttributeValueType",
|
3047
|
-
# type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
|
3048
|
-
# storage_rule: {
|
3049
|
-
# storage_allocated_in_bytes: 1,
|
3050
|
-
# storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
|
3051
|
-
# },
|
3052
|
-
# time_zone_id: "TimeZoneIdType",
|
3053
|
-
# locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
|
3054
|
-
# grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
|
3055
|
-
# }
|
3056
|
-
#
|
3057
2654
|
# @!attribute [rw] authentication_token
|
3058
2655
|
# Amazon WorkDocs authentication token. Not required when using AWS
|
3059
2656
|
# administrator credentials to access the API.
|
@@ -3219,7 +2816,7 @@ module Aws::WorkDocs
|
|
3219
2816
|
:time_zone_id,
|
3220
2817
|
:locale,
|
3221
2818
|
:storage)
|
3222
|
-
SENSITIVE = []
|
2819
|
+
SENSITIVE = [:email_address]
|
3223
2820
|
include Aws::Structure
|
3224
2821
|
end
|
3225
2822
|
|
@@ -3253,7 +2850,7 @@ module Aws::WorkDocs
|
|
3253
2850
|
:given_name,
|
3254
2851
|
:surname,
|
3255
2852
|
:email_address)
|
3256
|
-
SENSITIVE = []
|
2853
|
+
SENSITIVE = [:email_address]
|
3257
2854
|
include Aws::Structure
|
3258
2855
|
end
|
3259
2856
|
|