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
@@ -11,8 +11,8 @@ module Aws::WorkDocs
|
|
11
11
|
module Types
|
12
12
|
|
13
13
|
# @!attribute [rw] authentication_token
|
14
|
-
# Amazon WorkDocs authentication token. Not required when using
|
15
|
-
# administrator credentials to access the API.
|
14
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
15
|
+
# Web Services administrator credentials to access the API.
|
16
16
|
# @return [String]
|
17
17
|
#
|
18
18
|
# @!attribute [rw] document_id
|
@@ -38,8 +38,8 @@ module Aws::WorkDocs
|
|
38
38
|
# @return [String]
|
39
39
|
#
|
40
40
|
# @!attribute [rw] authentication_token
|
41
|
-
# Amazon WorkDocs authentication token. Not required when using
|
42
|
-
# administrator credentials to access the API.
|
41
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
42
|
+
# Web Services administrator credentials to access the API.
|
43
43
|
# @return [String]
|
44
44
|
#
|
45
45
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ActivateUserRequest AWS API Documentation
|
@@ -127,8 +127,8 @@ module Aws::WorkDocs
|
|
127
127
|
end
|
128
128
|
|
129
129
|
# @!attribute [rw] authentication_token
|
130
|
-
# Amazon WorkDocs authentication token. Not required when using
|
131
|
-
# administrator credentials to access the API.
|
130
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
131
|
+
# Web Services administrator credentials to access the API.
|
132
132
|
# @return [String]
|
133
133
|
#
|
134
134
|
# @!attribute [rw] resource_id
|
@@ -246,6 +246,10 @@ module Aws::WorkDocs
|
|
246
246
|
# The ID of the user being replied to.
|
247
247
|
# @return [String]
|
248
248
|
#
|
249
|
+
# @!attribute [rw] contributor_id
|
250
|
+
# The ID of the user who made the comment.
|
251
|
+
# @return [String]
|
252
|
+
#
|
249
253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CommentMetadata AWS API Documentation
|
250
254
|
#
|
251
255
|
class CommentMetadata < Struct.new(
|
@@ -253,7 +257,8 @@ module Aws::WorkDocs
|
|
253
257
|
:contributor,
|
254
258
|
:created_timestamp,
|
255
259
|
:comment_status,
|
256
|
-
:recipient_id
|
260
|
+
:recipient_id,
|
261
|
+
:contributor_id)
|
257
262
|
SENSITIVE = []
|
258
263
|
include Aws::Structure
|
259
264
|
end
|
@@ -286,8 +291,8 @@ module Aws::WorkDocs
|
|
286
291
|
end
|
287
292
|
|
288
293
|
# @!attribute [rw] authentication_token
|
289
|
-
# Amazon WorkDocs authentication token. Not required when using
|
290
|
-
# administrator credentials to access the API.
|
294
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
295
|
+
# Web Services administrator credentials to access the API.
|
291
296
|
# @return [String]
|
292
297
|
#
|
293
298
|
# @!attribute [rw] document_id
|
@@ -350,8 +355,8 @@ module Aws::WorkDocs
|
|
350
355
|
end
|
351
356
|
|
352
357
|
# @!attribute [rw] authentication_token
|
353
|
-
# Amazon WorkDocs authentication token. Not required when using
|
354
|
-
# administrator credentials to access the API.
|
358
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
359
|
+
# Web Services administrator credentials to access the API.
|
355
360
|
# @return [String]
|
356
361
|
#
|
357
362
|
# @!attribute [rw] resource_id
|
@@ -383,8 +388,8 @@ module Aws::WorkDocs
|
|
383
388
|
class CreateCustomMetadataResponse < Aws::EmptyStructure; end
|
384
389
|
|
385
390
|
# @!attribute [rw] authentication_token
|
386
|
-
# Amazon WorkDocs authentication token. Not required when using
|
387
|
-
# administrator credentials to access the API.
|
391
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
392
|
+
# Web Services administrator credentials to access the API.
|
388
393
|
# @return [String]
|
389
394
|
#
|
390
395
|
# @!attribute [rw] name
|
@@ -401,7 +406,7 @@ module Aws::WorkDocs
|
|
401
406
|
:authentication_token,
|
402
407
|
:name,
|
403
408
|
:parent_folder_id)
|
404
|
-
SENSITIVE = [:authentication_token]
|
409
|
+
SENSITIVE = [:authentication_token, :name]
|
405
410
|
include Aws::Structure
|
406
411
|
end
|
407
412
|
|
@@ -426,8 +431,8 @@ module Aws::WorkDocs
|
|
426
431
|
# @return [Array<String>]
|
427
432
|
#
|
428
433
|
# @!attribute [rw] authentication_token
|
429
|
-
# Amazon WorkDocs authentication token. Not required when using
|
430
|
-
# administrator credentials to access the API.
|
434
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
435
|
+
# Web Services administrator credentials to access the API.
|
431
436
|
# @return [String]
|
432
437
|
#
|
433
438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateLabelsRequest AWS API Documentation
|
@@ -518,8 +523,8 @@ module Aws::WorkDocs
|
|
518
523
|
# @return [Types::StorageRuleType]
|
519
524
|
#
|
520
525
|
# @!attribute [rw] authentication_token
|
521
|
-
# Amazon WorkDocs authentication token. Not required when using
|
522
|
-
# administrator credentials to access the API.
|
526
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
527
|
+
# Web Services administrator credentials to access the API.
|
523
528
|
# @return [String]
|
524
529
|
#
|
525
530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/CreateUserRequest AWS API Documentation
|
@@ -534,7 +539,7 @@ module Aws::WorkDocs
|
|
534
539
|
:time_zone_id,
|
535
540
|
:storage_rule,
|
536
541
|
:authentication_token)
|
537
|
-
SENSITIVE = [:email_address, :password, :authentication_token]
|
542
|
+
SENSITIVE = [:username, :email_address, :given_name, :surname, :password, :authentication_token]
|
538
543
|
include Aws::Structure
|
539
544
|
end
|
540
545
|
|
@@ -564,13 +569,32 @@ module Aws::WorkDocs
|
|
564
569
|
include Aws::Structure
|
565
570
|
end
|
566
571
|
|
572
|
+
# Filters results based on timestamp range (in epochs).
|
573
|
+
#
|
574
|
+
# @!attribute [rw] start_value
|
575
|
+
# Timestamp range start value (in epochs)
|
576
|
+
# @return [Time]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] end_value
|
579
|
+
# Timestamp range end value (in epochs).
|
580
|
+
# @return [Time]
|
581
|
+
#
|
582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DateRangeType AWS API Documentation
|
583
|
+
#
|
584
|
+
class DateRangeType < Struct.new(
|
585
|
+
:start_value,
|
586
|
+
:end_value)
|
587
|
+
SENSITIVE = []
|
588
|
+
include Aws::Structure
|
589
|
+
end
|
590
|
+
|
567
591
|
# @!attribute [rw] user_id
|
568
592
|
# The ID of the user.
|
569
593
|
# @return [String]
|
570
594
|
#
|
571
595
|
# @!attribute [rw] authentication_token
|
572
|
-
# Amazon WorkDocs authentication token. Not required when using
|
573
|
-
# administrator credentials to access the API.
|
596
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
597
|
+
# Web Services administrator credentials to access the API.
|
574
598
|
# @return [String]
|
575
599
|
#
|
576
600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeactivateUserRequest AWS API Documentation
|
@@ -589,8 +613,8 @@ module Aws::WorkDocs
|
|
589
613
|
class DeactivatingLastSystemUserException < Aws::EmptyStructure; end
|
590
614
|
|
591
615
|
# @!attribute [rw] authentication_token
|
592
|
-
# Amazon WorkDocs authentication token. Not required when using
|
593
|
-
# administrator credentials to access the API.
|
616
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
617
|
+
# Web Services administrator credentials to access the API.
|
594
618
|
# @return [String]
|
595
619
|
#
|
596
620
|
# @!attribute [rw] document_id
|
@@ -617,8 +641,8 @@ module Aws::WorkDocs
|
|
617
641
|
end
|
618
642
|
|
619
643
|
# @!attribute [rw] authentication_token
|
620
|
-
# Amazon WorkDocs authentication token. Not required when using
|
621
|
-
# administrator credentials to access the API.
|
644
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
645
|
+
# Web Services administrator credentials to access the API.
|
622
646
|
# @return [String]
|
623
647
|
#
|
624
648
|
# @!attribute [rw] resource_id
|
@@ -656,8 +680,8 @@ module Aws::WorkDocs
|
|
656
680
|
class DeleteCustomMetadataResponse < Aws::EmptyStructure; end
|
657
681
|
|
658
682
|
# @!attribute [rw] authentication_token
|
659
|
-
# Amazon WorkDocs authentication token. Not required when using
|
660
|
-
# administrator credentials to access the API.
|
683
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
684
|
+
# Web Services administrator credentials to access the API.
|
661
685
|
# @return [String]
|
662
686
|
#
|
663
687
|
# @!attribute [rw] document_id
|
@@ -674,21 +698,20 @@ module Aws::WorkDocs
|
|
674
698
|
end
|
675
699
|
|
676
700
|
# @!attribute [rw] authentication_token
|
677
|
-
# Amazon WorkDocs authentication token. Not required when using
|
678
|
-
# administrator credentials to access the API.
|
701
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
702
|
+
# Web Services administrator credentials to access the API.
|
679
703
|
# @return [String]
|
680
704
|
#
|
681
705
|
# @!attribute [rw] document_id
|
682
|
-
# The ID of
|
706
|
+
# The ID of the document associated with the version being deleted.
|
683
707
|
# @return [String]
|
684
708
|
#
|
685
709
|
# @!attribute [rw] version_id
|
686
|
-
# The
|
710
|
+
# The ID of the version being deleted.
|
687
711
|
# @return [String]
|
688
712
|
#
|
689
713
|
# @!attribute [rw] delete_prior_versions
|
690
|
-
#
|
691
|
-
# versions* of a document.
|
714
|
+
# Deletes all versions of a document prior to the current version.
|
692
715
|
# @return [Boolean]
|
693
716
|
#
|
694
717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersionRequest AWS API Documentation
|
@@ -703,8 +726,8 @@ module Aws::WorkDocs
|
|
703
726
|
end
|
704
727
|
|
705
728
|
# @!attribute [rw] authentication_token
|
706
|
-
# Amazon WorkDocs authentication token. Not required when using
|
707
|
-
# administrator credentials to access the API.
|
729
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
730
|
+
# Web Services administrator credentials to access the API.
|
708
731
|
# @return [String]
|
709
732
|
#
|
710
733
|
# @!attribute [rw] folder_id
|
@@ -721,8 +744,8 @@ module Aws::WorkDocs
|
|
721
744
|
end
|
722
745
|
|
723
746
|
# @!attribute [rw] authentication_token
|
724
|
-
# Amazon WorkDocs authentication token. Not required when using
|
725
|
-
# administrator credentials to access the API.
|
747
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
748
|
+
# Web Services administrator credentials to access the API.
|
726
749
|
# @return [String]
|
727
750
|
#
|
728
751
|
# @!attribute [rw] folder_id
|
@@ -743,8 +766,8 @@ module Aws::WorkDocs
|
|
743
766
|
# @return [String]
|
744
767
|
#
|
745
768
|
# @!attribute [rw] authentication_token
|
746
|
-
# Amazon WorkDocs authentication token. Not required when using
|
747
|
-
# administrator credentials to access the API.
|
769
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
770
|
+
# Web Services administrator credentials to access the API.
|
748
771
|
# @return [String]
|
749
772
|
#
|
750
773
|
# @!attribute [rw] labels
|
@@ -789,8 +812,8 @@ module Aws::WorkDocs
|
|
789
812
|
|
790
813
|
# @!attribute [rw] authentication_token
|
791
814
|
# Amazon WorkDocs authentication token. Do not set this field when
|
792
|
-
# using administrative API actions, as in accessing the API using
|
793
|
-
# credentials.
|
815
|
+
# using administrative API actions, as in accessing the API using
|
816
|
+
# Amazon Web Services credentials.
|
794
817
|
# @return [String]
|
795
818
|
#
|
796
819
|
# @!attribute [rw] user_id
|
@@ -807,8 +830,8 @@ module Aws::WorkDocs
|
|
807
830
|
end
|
808
831
|
|
809
832
|
# @!attribute [rw] authentication_token
|
810
|
-
# Amazon WorkDocs authentication token. Not required when using
|
811
|
-
# administrator credentials to access the API.
|
833
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
834
|
+
# Web Services administrator credentials to access the API.
|
812
835
|
# @return [String]
|
813
836
|
#
|
814
837
|
# @!attribute [rw] start_time
|
@@ -893,8 +916,8 @@ module Aws::WorkDocs
|
|
893
916
|
end
|
894
917
|
|
895
918
|
# @!attribute [rw] authentication_token
|
896
|
-
# Amazon WorkDocs authentication token. Not required when using
|
897
|
-
# administrator credentials to access the API.
|
919
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
920
|
+
# Web Services administrator credentials to access the API.
|
898
921
|
# @return [String]
|
899
922
|
#
|
900
923
|
# @!attribute [rw] document_id
|
@@ -945,8 +968,8 @@ module Aws::WorkDocs
|
|
945
968
|
end
|
946
969
|
|
947
970
|
# @!attribute [rw] authentication_token
|
948
|
-
# Amazon WorkDocs authentication token. Not required when using
|
949
|
-
# administrator credentials to access the API.
|
971
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
972
|
+
# Web Services administrator credentials to access the API.
|
950
973
|
# @return [String]
|
951
974
|
#
|
952
975
|
# @!attribute [rw] document_id
|
@@ -1004,8 +1027,8 @@ module Aws::WorkDocs
|
|
1004
1027
|
end
|
1005
1028
|
|
1006
1029
|
# @!attribute [rw] authentication_token
|
1007
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1008
|
-
# administrator credentials to access the API.
|
1030
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1031
|
+
# Web Services administrator credentials to access the API.
|
1009
1032
|
# @return [String]
|
1010
1033
|
#
|
1011
1034
|
# @!attribute [rw] folder_id
|
@@ -1077,8 +1100,8 @@ module Aws::WorkDocs
|
|
1077
1100
|
end
|
1078
1101
|
|
1079
1102
|
# @!attribute [rw] authentication_token
|
1080
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1081
|
-
# administrator credentials to access the API.
|
1103
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1104
|
+
# Web Services administrator credentials to access the API.
|
1082
1105
|
# @return [String]
|
1083
1106
|
#
|
1084
1107
|
# @!attribute [rw] search_query
|
@@ -1170,8 +1193,8 @@ module Aws::WorkDocs
|
|
1170
1193
|
end
|
1171
1194
|
|
1172
1195
|
# @!attribute [rw] authentication_token
|
1173
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1174
|
-
# administrator credentials to access the API.
|
1196
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1197
|
+
# Web Services administrator credentials to access the API.
|
1175
1198
|
# @return [String]
|
1176
1199
|
#
|
1177
1200
|
# @!attribute [rw] resource_id
|
@@ -1262,8 +1285,8 @@ module Aws::WorkDocs
|
|
1262
1285
|
end
|
1263
1286
|
|
1264
1287
|
# @!attribute [rw] authentication_token
|
1265
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1266
|
-
# administrator credentials to access the API.
|
1288
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1289
|
+
# Web Services administrator credentials to access the API.
|
1267
1290
|
# @return [String]
|
1268
1291
|
#
|
1269
1292
|
# @!attribute [rw] organization_id
|
@@ -1499,7 +1522,7 @@ module Aws::WorkDocs
|
|
1499
1522
|
:creator_id,
|
1500
1523
|
:thumbnail,
|
1501
1524
|
:source)
|
1502
|
-
SENSITIVE = []
|
1525
|
+
SENSITIVE = [:name]
|
1503
1526
|
include Aws::Structure
|
1504
1527
|
end
|
1505
1528
|
|
@@ -1549,7 +1572,7 @@ module Aws::WorkDocs
|
|
1549
1572
|
include Aws::Structure
|
1550
1573
|
end
|
1551
1574
|
|
1552
|
-
# The
|
1575
|
+
# The Directory Service cannot reach an on-premises instance. Or a
|
1553
1576
|
# dependency under the control of the organization is failing, such as a
|
1554
1577
|
# connected Active Directory.
|
1555
1578
|
#
|
@@ -1564,6 +1587,65 @@ module Aws::WorkDocs
|
|
1564
1587
|
include Aws::Structure
|
1565
1588
|
end
|
1566
1589
|
|
1590
|
+
# Filters results based on entity metadata.
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] text_locales
|
1593
|
+
# Filters by the locale of the content or comment.
|
1594
|
+
# @return [Array<String>]
|
1595
|
+
#
|
1596
|
+
# @!attribute [rw] content_categories
|
1597
|
+
# Filters by content category.
|
1598
|
+
# @return [Array<String>]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] resource_types
|
1601
|
+
# Filters based on entity type.
|
1602
|
+
# @return [Array<String>]
|
1603
|
+
#
|
1604
|
+
# @!attribute [rw] labels
|
1605
|
+
# Filter by labels using exact match.
|
1606
|
+
# @return [Array<String>]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] principals
|
1609
|
+
# Filter based on UserIds or GroupIds.
|
1610
|
+
# @return [Array<Types::SearchPrincipalType>]
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] ancestor_ids
|
1613
|
+
# Filter based on resource’s path.
|
1614
|
+
# @return [Array<String>]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] search_collection_types
|
1617
|
+
# Filter based on file groupings.
|
1618
|
+
# @return [Array<String>]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] size_range
|
1621
|
+
# Filter based on size (in bytes).
|
1622
|
+
# @return [Types::LongRangeType]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] created_range
|
1625
|
+
# Filter based on resource’s creation timestamp.
|
1626
|
+
# @return [Types::DateRangeType]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] modified_range
|
1629
|
+
# Filter based on resource’s modified timestamp.
|
1630
|
+
# @return [Types::DateRangeType]
|
1631
|
+
#
|
1632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/Filters AWS API Documentation
|
1633
|
+
#
|
1634
|
+
class Filters < Struct.new(
|
1635
|
+
:text_locales,
|
1636
|
+
:content_categories,
|
1637
|
+
:resource_types,
|
1638
|
+
:labels,
|
1639
|
+
:principals,
|
1640
|
+
:ancestor_ids,
|
1641
|
+
:search_collection_types,
|
1642
|
+
:size_range,
|
1643
|
+
:created_range,
|
1644
|
+
:modified_range)
|
1645
|
+
SENSITIVE = []
|
1646
|
+
include Aws::Structure
|
1647
|
+
end
|
1648
|
+
|
1567
1649
|
# Describes a folder.
|
1568
1650
|
#
|
1569
1651
|
# @!attribute [rw] id
|
@@ -1625,7 +1707,7 @@ module Aws::WorkDocs
|
|
1625
1707
|
:labels,
|
1626
1708
|
:size,
|
1627
1709
|
:latest_version_size)
|
1628
|
-
SENSITIVE = []
|
1710
|
+
SENSITIVE = [:name]
|
1629
1711
|
include Aws::Structure
|
1630
1712
|
end
|
1631
1713
|
|
@@ -1654,8 +1736,8 @@ module Aws::WorkDocs
|
|
1654
1736
|
end
|
1655
1737
|
|
1656
1738
|
# @!attribute [rw] authentication_token
|
1657
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1658
|
-
# administrator credentials to access the API.
|
1739
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1740
|
+
# Web Services administrator credentials to access the API.
|
1659
1741
|
# @return [String]
|
1660
1742
|
#
|
1661
1743
|
# @!attribute [rw] document_id
|
@@ -1700,8 +1782,8 @@ module Aws::WorkDocs
|
|
1700
1782
|
end
|
1701
1783
|
|
1702
1784
|
# @!attribute [rw] authentication_token
|
1703
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1704
|
-
# administrator credentials to access the API.
|
1785
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1786
|
+
# Web Services administrator credentials to access the API.
|
1705
1787
|
# @return [String]
|
1706
1788
|
#
|
1707
1789
|
# @!attribute [rw] document_id
|
@@ -1740,8 +1822,8 @@ module Aws::WorkDocs
|
|
1740
1822
|
end
|
1741
1823
|
|
1742
1824
|
# @!attribute [rw] authentication_token
|
1743
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1744
|
-
# administrator credentials to access the API.
|
1825
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1826
|
+
# Web Services administrator credentials to access the API.
|
1745
1827
|
# @return [String]
|
1746
1828
|
#
|
1747
1829
|
# @!attribute [rw] document_id
|
@@ -1791,8 +1873,8 @@ module Aws::WorkDocs
|
|
1791
1873
|
end
|
1792
1874
|
|
1793
1875
|
# @!attribute [rw] authentication_token
|
1794
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1795
|
-
# administrator credentials to access the API.
|
1876
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1877
|
+
# Web Services administrator credentials to access the API.
|
1796
1878
|
# @return [String]
|
1797
1879
|
#
|
1798
1880
|
# @!attribute [rw] folder_id
|
@@ -1837,8 +1919,8 @@ module Aws::WorkDocs
|
|
1837
1919
|
end
|
1838
1920
|
|
1839
1921
|
# @!attribute [rw] authentication_token
|
1840
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1841
|
-
# administrator credentials to access the API.
|
1922
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
1923
|
+
# Web Services administrator credentials to access the API.
|
1842
1924
|
# @return [String]
|
1843
1925
|
#
|
1844
1926
|
# @!attribute [rw] folder_id
|
@@ -1878,7 +1960,7 @@ module Aws::WorkDocs
|
|
1878
1960
|
|
1879
1961
|
# @!attribute [rw] authentication_token
|
1880
1962
|
# The Amazon WorkDocs authentication token. Not required when using
|
1881
|
-
#
|
1963
|
+
# Amazon Web Services administrator credentials to access the API.
|
1882
1964
|
# @return [String]
|
1883
1965
|
#
|
1884
1966
|
# @!attribute [rw] user_id
|
@@ -1967,8 +2049,8 @@ module Aws::WorkDocs
|
|
1967
2049
|
end
|
1968
2050
|
|
1969
2051
|
# @!attribute [rw] authentication_token
|
1970
|
-
# Amazon WorkDocs authentication token. Not required when using
|
1971
|
-
# administrator credentials to access the API.
|
2052
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2053
|
+
# Web Services administrator credentials to access the API.
|
1972
2054
|
# @return [String]
|
1973
2055
|
#
|
1974
2056
|
# @!attribute [rw] id
|
@@ -2011,7 +2093,7 @@ module Aws::WorkDocs
|
|
2011
2093
|
:content_type,
|
2012
2094
|
:document_size_in_bytes,
|
2013
2095
|
:parent_folder_id)
|
2014
|
-
SENSITIVE = [:authentication_token]
|
2096
|
+
SENSITIVE = [:authentication_token, :name]
|
2015
2097
|
include Aws::Structure
|
2016
2098
|
end
|
2017
2099
|
|
@@ -2099,11 +2181,30 @@ module Aws::WorkDocs
|
|
2099
2181
|
include Aws::Structure
|
2100
2182
|
end
|
2101
2183
|
|
2184
|
+
# Filter based on size (in bytes).
|
2185
|
+
#
|
2186
|
+
# @!attribute [rw] start_value
|
2187
|
+
# The size start range (in bytes).
|
2188
|
+
# @return [Integer]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] end_value
|
2191
|
+
# The size end range (in bytes).
|
2192
|
+
# @return [Integer]
|
2193
|
+
#
|
2194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/LongRangeType AWS API Documentation
|
2195
|
+
#
|
2196
|
+
class LongRangeType < Struct.new(
|
2197
|
+
:start_value,
|
2198
|
+
:end_value)
|
2199
|
+
SENSITIVE = []
|
2200
|
+
include Aws::Structure
|
2201
|
+
end
|
2202
|
+
|
2102
2203
|
# Set of options which defines notification preferences of given action.
|
2103
2204
|
#
|
2104
2205
|
# @!attribute [rw] send_email
|
2105
2206
|
# Boolean value to indicate an email notification should be sent to
|
2106
|
-
# the
|
2207
|
+
# the recipients.
|
2107
2208
|
# @return [Boolean]
|
2108
2209
|
#
|
2109
2210
|
# @!attribute [rw] email_message
|
@@ -2195,8 +2296,8 @@ module Aws::WorkDocs
|
|
2195
2296
|
end
|
2196
2297
|
|
2197
2298
|
# @!attribute [rw] authentication_token
|
2198
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2199
|
-
# administrator credentials to access the API.
|
2299
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2300
|
+
# Web Services administrator credentials to access the API.
|
2200
2301
|
# @return [String]
|
2201
2302
|
#
|
2202
2303
|
# @!attribute [rw] resource_id
|
@@ -2213,8 +2314,8 @@ module Aws::WorkDocs
|
|
2213
2314
|
end
|
2214
2315
|
|
2215
2316
|
# @!attribute [rw] authentication_token
|
2216
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2217
|
-
# administrator credentials to access the API.
|
2317
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2318
|
+
# Web Services administrator credentials to access the API.
|
2218
2319
|
# @return [String]
|
2219
2320
|
#
|
2220
2321
|
# @!attribute [rw] resource_id
|
@@ -2308,7 +2409,7 @@ module Aws::WorkDocs
|
|
2308
2409
|
:version_id,
|
2309
2410
|
:owner,
|
2310
2411
|
:parent_id)
|
2311
|
-
SENSITIVE = []
|
2412
|
+
SENSITIVE = [:name, :original_name]
|
2312
2413
|
include Aws::Structure
|
2313
2414
|
end
|
2314
2415
|
|
@@ -2341,13 +2442,53 @@ module Aws::WorkDocs
|
|
2341
2442
|
class ResourcePathComponent < Struct.new(
|
2342
2443
|
:id,
|
2343
2444
|
:name)
|
2344
|
-
SENSITIVE = []
|
2445
|
+
SENSITIVE = [:name]
|
2446
|
+
include Aws::Structure
|
2447
|
+
end
|
2448
|
+
|
2449
|
+
# List of Documents, Folders, Comments, and Document Versions matching
|
2450
|
+
# the query.
|
2451
|
+
#
|
2452
|
+
# @!attribute [rw] resource_type
|
2453
|
+
# The type of item being returned.
|
2454
|
+
# @return [String]
|
2455
|
+
#
|
2456
|
+
# @!attribute [rw] web_url
|
2457
|
+
# The webUrl of the item being returned.
|
2458
|
+
# @return [String]
|
2459
|
+
#
|
2460
|
+
# @!attribute [rw] document_metadata
|
2461
|
+
# The document that matches the query.
|
2462
|
+
# @return [Types::DocumentMetadata]
|
2463
|
+
#
|
2464
|
+
# @!attribute [rw] folder_metadata
|
2465
|
+
# The folder that matches the query.
|
2466
|
+
# @return [Types::FolderMetadata]
|
2467
|
+
#
|
2468
|
+
# @!attribute [rw] comment_metadata
|
2469
|
+
# The comment that matches the query.
|
2470
|
+
# @return [Types::CommentMetadata]
|
2471
|
+
#
|
2472
|
+
# @!attribute [rw] document_version_metadata
|
2473
|
+
# The document version that matches the metadata.
|
2474
|
+
# @return [Types::DocumentVersionMetadata]
|
2475
|
+
#
|
2476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/ResponseItem AWS API Documentation
|
2477
|
+
#
|
2478
|
+
class ResponseItem < Struct.new(
|
2479
|
+
:resource_type,
|
2480
|
+
:web_url,
|
2481
|
+
:document_metadata,
|
2482
|
+
:folder_metadata,
|
2483
|
+
:comment_metadata,
|
2484
|
+
:document_version_metadata)
|
2485
|
+
SENSITIVE = [:web_url]
|
2345
2486
|
include Aws::Structure
|
2346
2487
|
end
|
2347
2488
|
|
2348
2489
|
# @!attribute [rw] authentication_token
|
2349
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2350
|
-
# administrator credentials to access the API.
|
2490
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2491
|
+
# Web Services administrator credentials to access the API.
|
2351
2492
|
# @return [String]
|
2352
2493
|
#
|
2353
2494
|
# @!attribute [rw] document_id
|
@@ -2363,6 +2504,122 @@ module Aws::WorkDocs
|
|
2363
2504
|
include Aws::Structure
|
2364
2505
|
end
|
2365
2506
|
|
2507
|
+
# Filter based on UserIds or GroupIds.
|
2508
|
+
#
|
2509
|
+
# @!attribute [rw] id
|
2510
|
+
# UserIds or GroupIds.
|
2511
|
+
# @return [String]
|
2512
|
+
#
|
2513
|
+
# @!attribute [rw] roles
|
2514
|
+
# The Role of a User or Group.
|
2515
|
+
# @return [Array<String>]
|
2516
|
+
#
|
2517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchPrincipalType AWS API Documentation
|
2518
|
+
#
|
2519
|
+
class SearchPrincipalType < Struct.new(
|
2520
|
+
:id,
|
2521
|
+
:roles)
|
2522
|
+
SENSITIVE = []
|
2523
|
+
include Aws::Structure
|
2524
|
+
end
|
2525
|
+
|
2526
|
+
# @!attribute [rw] authentication_token
|
2527
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2528
|
+
# Web Services administrator credentials to access the API.
|
2529
|
+
# @return [String]
|
2530
|
+
#
|
2531
|
+
# @!attribute [rw] query_text
|
2532
|
+
# The String to search for. Searches across different text fields
|
2533
|
+
# based on request parameters. Use double quotes around the query
|
2534
|
+
# string for exact phrase matches.
|
2535
|
+
# @return [String]
|
2536
|
+
#
|
2537
|
+
# @!attribute [rw] query_scopes
|
2538
|
+
# Filter based on the text field type. A Folder has only a name and no
|
2539
|
+
# content. A Comment has only content and no name. A Document or
|
2540
|
+
# Document Version has a name and content
|
2541
|
+
# @return [Array<String>]
|
2542
|
+
#
|
2543
|
+
# @!attribute [rw] organization_id
|
2544
|
+
# Filters based on the resource owner OrgId. This is a mandatory
|
2545
|
+
# parameter when using Admin SigV4 credentials.
|
2546
|
+
# @return [String]
|
2547
|
+
#
|
2548
|
+
# @!attribute [rw] additional_response_fields
|
2549
|
+
# A list of attributes to include in the response. Used to request
|
2550
|
+
# fields that are not normally returned in a standard response.
|
2551
|
+
# @return [Array<String>]
|
2552
|
+
#
|
2553
|
+
# @!attribute [rw] filters
|
2554
|
+
# Filters results based on entity metadata.
|
2555
|
+
# @return [Types::Filters]
|
2556
|
+
#
|
2557
|
+
# @!attribute [rw] order_by
|
2558
|
+
# Order by results in one or more categories.
|
2559
|
+
# @return [Array<Types::SearchSortResult>]
|
2560
|
+
#
|
2561
|
+
# @!attribute [rw] limit
|
2562
|
+
# Max results count per page.
|
2563
|
+
# @return [Integer]
|
2564
|
+
#
|
2565
|
+
# @!attribute [rw] marker
|
2566
|
+
# The marker for the next set of results.
|
2567
|
+
# @return [String]
|
2568
|
+
#
|
2569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchResourcesRequest AWS API Documentation
|
2570
|
+
#
|
2571
|
+
class SearchResourcesRequest < Struct.new(
|
2572
|
+
:authentication_token,
|
2573
|
+
:query_text,
|
2574
|
+
:query_scopes,
|
2575
|
+
:organization_id,
|
2576
|
+
:additional_response_fields,
|
2577
|
+
:filters,
|
2578
|
+
:order_by,
|
2579
|
+
:limit,
|
2580
|
+
:marker)
|
2581
|
+
SENSITIVE = [:authentication_token, :query_text]
|
2582
|
+
include Aws::Structure
|
2583
|
+
end
|
2584
|
+
|
2585
|
+
# @!attribute [rw] items
|
2586
|
+
# List of Documents, Folders, Comments, and Document Versions matching
|
2587
|
+
# the query.
|
2588
|
+
# @return [Array<Types::ResponseItem>]
|
2589
|
+
#
|
2590
|
+
# @!attribute [rw] marker
|
2591
|
+
# The marker to use when requesting the next set of results. If there
|
2592
|
+
# are no additional results, the string is empty.
|
2593
|
+
# @return [String]
|
2594
|
+
#
|
2595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchResourcesResponse AWS API Documentation
|
2596
|
+
#
|
2597
|
+
class SearchResourcesResponse < Struct.new(
|
2598
|
+
:items,
|
2599
|
+
:marker)
|
2600
|
+
SENSITIVE = []
|
2601
|
+
include Aws::Structure
|
2602
|
+
end
|
2603
|
+
|
2604
|
+
# The result of the sort operation.
|
2605
|
+
#
|
2606
|
+
# @!attribute [rw] field
|
2607
|
+
# Sort search results based on this field name.
|
2608
|
+
# @return [String]
|
2609
|
+
#
|
2610
|
+
# @!attribute [rw] order
|
2611
|
+
# Sort direction.
|
2612
|
+
# @return [String]
|
2613
|
+
#
|
2614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/SearchSortResult AWS API Documentation
|
2615
|
+
#
|
2616
|
+
class SearchSortResult < Struct.new(
|
2617
|
+
:field,
|
2618
|
+
:order)
|
2619
|
+
SENSITIVE = []
|
2620
|
+
include Aws::Structure
|
2621
|
+
end
|
2622
|
+
|
2366
2623
|
# One or more of the dependencies is unavailable.
|
2367
2624
|
#
|
2368
2625
|
# @!attribute [rw] message
|
@@ -2556,8 +2813,8 @@ module Aws::WorkDocs
|
|
2556
2813
|
end
|
2557
2814
|
|
2558
2815
|
# @!attribute [rw] authentication_token
|
2559
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2560
|
-
# administrator credentials to access the API.
|
2816
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2817
|
+
# Web Services administrator credentials to access the API.
|
2561
2818
|
# @return [String]
|
2562
2819
|
#
|
2563
2820
|
# @!attribute [rw] document_id
|
@@ -2585,13 +2842,13 @@ module Aws::WorkDocs
|
|
2585
2842
|
:name,
|
2586
2843
|
:parent_folder_id,
|
2587
2844
|
:resource_state)
|
2588
|
-
SENSITIVE = [:authentication_token]
|
2845
|
+
SENSITIVE = [:authentication_token, :name]
|
2589
2846
|
include Aws::Structure
|
2590
2847
|
end
|
2591
2848
|
|
2592
2849
|
# @!attribute [rw] authentication_token
|
2593
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2594
|
-
# administrator credentials to access the API.
|
2850
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2851
|
+
# Web Services administrator credentials to access the API.
|
2595
2852
|
# @return [String]
|
2596
2853
|
#
|
2597
2854
|
# @!attribute [rw] document_id
|
@@ -2618,8 +2875,8 @@ module Aws::WorkDocs
|
|
2618
2875
|
end
|
2619
2876
|
|
2620
2877
|
# @!attribute [rw] authentication_token
|
2621
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2622
|
-
# administrator credentials to access the API.
|
2878
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2879
|
+
# Web Services administrator credentials to access the API.
|
2623
2880
|
# @return [String]
|
2624
2881
|
#
|
2625
2882
|
# @!attribute [rw] folder_id
|
@@ -2647,13 +2904,13 @@ module Aws::WorkDocs
|
|
2647
2904
|
:name,
|
2648
2905
|
:parent_folder_id,
|
2649
2906
|
:resource_state)
|
2650
|
-
SENSITIVE = [:authentication_token]
|
2907
|
+
SENSITIVE = [:authentication_token, :name]
|
2651
2908
|
include Aws::Structure
|
2652
2909
|
end
|
2653
2910
|
|
2654
2911
|
# @!attribute [rw] authentication_token
|
2655
|
-
# Amazon WorkDocs authentication token. Not required when using
|
2656
|
-
# administrator credentials to access the API.
|
2912
|
+
# Amazon WorkDocs authentication token. Not required when using Amazon
|
2913
|
+
# Web Services administrator credentials to access the API.
|
2657
2914
|
# @return [String]
|
2658
2915
|
#
|
2659
2916
|
# @!attribute [rw] user_id
|
@@ -2685,7 +2942,7 @@ module Aws::WorkDocs
|
|
2685
2942
|
# @return [String]
|
2686
2943
|
#
|
2687
2944
|
# @!attribute [rw] grant_poweruser_privileges
|
2688
|
-
# Boolean value to determine whether the user is granted
|
2945
|
+
# Boolean value to determine whether the user is granted Power user
|
2689
2946
|
# privileges.
|
2690
2947
|
# @return [String]
|
2691
2948
|
#
|
@@ -2701,7 +2958,7 @@ module Aws::WorkDocs
|
|
2701
2958
|
:time_zone_id,
|
2702
2959
|
:locale,
|
2703
2960
|
:grant_poweruser_privileges)
|
2704
|
-
SENSITIVE = [:authentication_token]
|
2961
|
+
SENSITIVE = [:authentication_token, :given_name, :surname]
|
2705
2962
|
include Aws::Structure
|
2706
2963
|
end
|
2707
2964
|
|
@@ -2816,7 +3073,7 @@ module Aws::WorkDocs
|
|
2816
3073
|
:time_zone_id,
|
2817
3074
|
:locale,
|
2818
3075
|
:storage)
|
2819
|
-
SENSITIVE = [:email_address]
|
3076
|
+
SENSITIVE = [:username, :email_address, :given_name, :surname]
|
2820
3077
|
include Aws::Structure
|
2821
3078
|
end
|
2822
3079
|
|
@@ -2850,7 +3107,7 @@ module Aws::WorkDocs
|
|
2850
3107
|
:given_name,
|
2851
3108
|
:surname,
|
2852
3109
|
:email_address)
|
2853
|
-
SENSITIVE = [:email_address]
|
3110
|
+
SENSITIVE = [:username, :given_name, :surname, :email_address]
|
2854
3111
|
include Aws::Structure
|
2855
3112
|
end
|
2856
3113
|
|