aws-sdk-directoryservice 1.83.0 → 1.85.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b71caf27144df09c8b51f56313b1a5c121185635b990ce3b365ee184b404bc4c
4
- data.tar.gz: eab37adb0947d86ca8f5675b8b2747486ec4d82da396975ca804ca92b68f7df6
3
+ metadata.gz: afd6a33c3e40d68200f9981772bf99709429781d5cf983fa59cad5fe0ee10379
4
+ data.tar.gz: 3690336488eda7f3ae77fe156697b17b1b25d7d58a5e59079394d1086fca5083
5
5
  SHA512:
6
- metadata.gz: 67cb917fcb0086d226aa3597c33c7dbec08542998da70e959835878d9fe8e23f8d9bd5e6ce2dc4c9e402beb5a1b330b63dd0ee883bf87c57964eaf6b7dc6ab39
7
- data.tar.gz: 58867ce5be8408997a0ffcd9d5a403474012fd025ab730f48aa6d6dd93652eeacd277f65458960402802c56b3ffcf0123edd6b1ead77519ed2e29ac9907be067
6
+ metadata.gz: 72fa9e7883907f0e644cdb259f967f099ff6ec6b3f875a3140206647017069f903eee5f25f97e09acf03dc86df8371c4edb6086e5535be2a69b6c8aa8f27a4fd
7
+ data.tar.gz: 021aceac17a266b800948d4c2362da31154c2febf7ea6c30e7bb6b23682ee6032e1e19956e5f504abf4b3d722483358014b85585729a7bf4075c08a06e831792
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.85.0 (2025-05-12)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.84.0 (2025-05-02)
10
+ ------------------
11
+
12
+ * Feature - Doc only update - fixed typos.
13
+
4
14
  1.83.0 (2025-05-01)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.83.0
1
+ 1.85.0
@@ -200,8 +200,7 @@ module Aws::DirectoryService
200
200
  # accepted modes and the configuration defaults that are included.
201
201
  #
202
202
  # @option options [Boolean] :disable_host_prefix_injection (false)
203
- # Set to true to disable SDK automatically adding host prefix
204
- # to default service endpoint when available.
203
+ # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
205
204
  #
206
205
  # @option options [Boolean] :disable_request_compression (false)
207
206
  # When set to 'true' the request body will not be compressed
@@ -612,6 +611,25 @@ module Aws::DirectoryService
612
611
  #
613
612
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
614
613
  #
614
+ #
615
+ # @example Example: To add a CIDR address block that routes traffic for Microsoft AD
616
+ #
617
+ # # The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.
618
+ #
619
+ # resp = client.add_ip_routes({
620
+ # directory_id: "d-92654abfed",
621
+ # ip_routes: [
622
+ # {
623
+ # cidr_ip: "12.12.12.12/32",
624
+ # description: "my IpRoute",
625
+ # },
626
+ # ],
627
+ # })
628
+ #
629
+ # resp.to_h outputs the following:
630
+ # {
631
+ # }
632
+ #
615
633
  # @example Request syntax with placeholder values
616
634
  #
617
635
  # resp = client.add_ip_routes({
@@ -683,6 +701,25 @@ module Aws::DirectoryService
683
701
  #
684
702
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
685
703
  #
704
+ #
705
+ # @example Example: To add tags to a directory
706
+ #
707
+ # # The following example adds or overwrites one or more tags for the specified directory.
708
+ #
709
+ # resp = client.add_tags_to_resource({
710
+ # resource_id: "d-92654abfed",
711
+ # tags: [
712
+ # {
713
+ # key: "environment",
714
+ # value: "production",
715
+ # },
716
+ # ],
717
+ # })
718
+ #
719
+ # resp.to_h outputs the following:
720
+ # {
721
+ # }
722
+ #
686
723
  # @example Request syntax with placeholder values
687
724
  #
688
725
  # resp = client.add_tags_to_resource({
@@ -719,6 +756,20 @@ module Aws::DirectoryService
719
756
  #
720
757
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
721
758
  #
759
+ #
760
+ # @example Example: To cancel a Microsoft AD schema extension that is in progress
761
+ #
762
+ # # The following example cancels an in-progress schema extension to a Microsoft AD directory.
763
+ #
764
+ # resp = client.cancel_schema_extension({
765
+ # directory_id: "d-92654abfed",
766
+ # schema_extension_id: "e-926731d2a0",
767
+ # })
768
+ #
769
+ # resp.to_h outputs the following:
770
+ # {
771
+ # }
772
+ #
722
773
  # @example Request syntax with placeholder values
723
774
  #
724
775
  # resp = client.cancel_schema_extension({
@@ -774,6 +825,35 @@ module Aws::DirectoryService
774
825
  #
775
826
  # * {Types::ConnectDirectoryResult#directory_id #directory_id} => String
776
827
  #
828
+ #
829
+ # @example Example: To connect to an on-premises directory
830
+ #
831
+ # # The following example creates an AD Connector to connect to an on-premises directory.
832
+ #
833
+ # resp = client.connect_directory({
834
+ # connect_settings: {
835
+ # customer_dns_ips: [
836
+ # "172.30.21.228",
837
+ # ],
838
+ # customer_user_name: "Administrator",
839
+ # subnet_ids: [
840
+ # "subnet-ba0146de",
841
+ # "subnet-bef46bc8",
842
+ # ],
843
+ # vpc_id: "vpc-45025421",
844
+ # },
845
+ # description: "Connector to corp",
846
+ # name: "corp.example.com",
847
+ # password: "Str0ngP@ssw0rd",
848
+ # short_name: "corp",
849
+ # size: "Small",
850
+ # })
851
+ #
852
+ # resp.to_h outputs the following:
853
+ # {
854
+ # directory_id: "d-92654abfed",
855
+ # }
856
+ #
777
857
  # @example Request syntax with placeholder values
778
858
  #
779
859
  # resp = client.connect_directory({
@@ -831,6 +911,22 @@ module Aws::DirectoryService
831
911
  # * {Types::CreateAliasResult#directory_id #directory_id} => String
832
912
  # * {Types::CreateAliasResult#alias #alias} => String
833
913
  #
914
+ #
915
+ # @example Example: To create an alias for a directory
916
+ #
917
+ # # The following example creates an alias for a directory.
918
+ #
919
+ # resp = client.create_alias({
920
+ # alias: "salesorg",
921
+ # directory_id: "d-92654abfed",
922
+ # })
923
+ #
924
+ # resp.to_h outputs the following:
925
+ # {
926
+ # alias: "salesorg",
927
+ # directory_id: "d-92654abfed",
928
+ # }
929
+ #
834
930
  # @example Request syntax with placeholder values
835
931
  #
836
932
  # resp = client.create_alias({
@@ -879,6 +975,42 @@ module Aws::DirectoryService
879
975
  #
880
976
  # * {Types::CreateComputerResult#computer #computer} => Types::Computer
881
977
  #
978
+ #
979
+ # @example Example: To create a computer account
980
+ #
981
+ # # The following example creates a computer account in the specified directory, and joins the computer to the directory.
982
+ #
983
+ # resp = client.create_computer({
984
+ # computer_attributes: [
985
+ # {
986
+ # name: "ip",
987
+ # value: "192.168.101.100",
988
+ # },
989
+ # ],
990
+ # computer_name: "labcomputer",
991
+ # directory_id: "d-92654abfed",
992
+ # organizational_unit_distinguished_name: "OU=Computers,OU=example,DC=corp,DC=example,DC=com",
993
+ # password: "Str0ngP@ssw0rd",
994
+ # })
995
+ #
996
+ # resp.to_h outputs the following:
997
+ # {
998
+ # computer: {
999
+ # computer_attributes: [
1000
+ # {
1001
+ # name: "DistinguishedName",
1002
+ # value: "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com",
1003
+ # },
1004
+ # {
1005
+ # name: "WindowsSamName",
1006
+ # value: "labcomputer$",
1007
+ # },
1008
+ # ],
1009
+ # computer_id: "S-1-5-21-1932691875-1648176379-1176097576-1124",
1010
+ # computer_name: "labcomputer",
1011
+ # },
1012
+ # }
1013
+ #
882
1014
  # @example Request syntax with placeholder values
883
1015
  #
884
1016
  # resp = client.create_computer({
@@ -930,6 +1062,23 @@ module Aws::DirectoryService
930
1062
  #
931
1063
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
932
1064
  #
1065
+ #
1066
+ # @example Example: To create a conditional forwarder
1067
+ #
1068
+ # # The following example creates a conditional forwarder associated with your AWS directory.
1069
+ #
1070
+ # resp = client.create_conditional_forwarder({
1071
+ # directory_id: "d-92654abfed",
1072
+ # dns_ip_addrs: [
1073
+ # "172.30.21.228",
1074
+ # ],
1075
+ # remote_domain_name: "sales.example.com",
1076
+ # })
1077
+ #
1078
+ # resp.to_h outputs the following:
1079
+ # {
1080
+ # }
1081
+ #
933
1082
  # @example Request syntax with placeholder values
934
1083
  #
935
1084
  # resp = client.create_conditional_forwarder({
@@ -1023,6 +1172,31 @@ module Aws::DirectoryService
1023
1172
  #
1024
1173
  # * {Types::CreateDirectoryResult#directory_id #directory_id} => String
1025
1174
  #
1175
+ #
1176
+ # @example Example: To create a Simple AD directory
1177
+ #
1178
+ # # The following example creates a Simple AD directory.
1179
+ #
1180
+ # resp = client.create_directory({
1181
+ # description: "Regional directory for example.com",
1182
+ # name: "seattle.example.com",
1183
+ # password: "Str0ngP@ssw0rd",
1184
+ # short_name: "seattle",
1185
+ # size: "Small",
1186
+ # vpc_settings: {
1187
+ # subnet_ids: [
1188
+ # "subnet-ba0146de",
1189
+ # "subnet-bef46bc8",
1190
+ # ],
1191
+ # vpc_id: "vpc-45025421",
1192
+ # },
1193
+ # })
1194
+ #
1195
+ # resp.to_h outputs the following:
1196
+ # {
1197
+ # directory_id: "d-92654abfed",
1198
+ # }
1199
+ #
1026
1200
  # @example Request syntax with placeholder values
1027
1201
  #
1028
1202
  # resp = client.create_directory({
@@ -1138,6 +1312,30 @@ module Aws::DirectoryService
1138
1312
  #
1139
1313
  # * {Types::CreateMicrosoftADResult#directory_id #directory_id} => String
1140
1314
  #
1315
+ #
1316
+ # @example Example: To create a Microsoft AD directory
1317
+ #
1318
+ # # The following example creates a Microsoft AD directory in the AWS cloud.
1319
+ #
1320
+ # resp = client.create_microsoft_ad({
1321
+ # description: "Corporate AD directory",
1322
+ # name: "ad.example.com",
1323
+ # password: "Str0ngP@ssw0rd",
1324
+ # short_name: "ad",
1325
+ # vpc_settings: {
1326
+ # subnet_ids: [
1327
+ # "subnet-ba0146de",
1328
+ # "subnet-bef46bc8",
1329
+ # ],
1330
+ # vpc_id: "vpc-45025421",
1331
+ # },
1332
+ # })
1333
+ #
1334
+ # resp.to_h outputs the following:
1335
+ # {
1336
+ # directory_id: "d-92654abfed",
1337
+ # }
1338
+ #
1141
1339
  # @example Request syntax with placeholder values
1142
1340
  #
1143
1341
  # resp = client.create_microsoft_ad({
@@ -1188,6 +1386,21 @@ module Aws::DirectoryService
1188
1386
  #
1189
1387
  # * {Types::CreateSnapshotResult#snapshot_id #snapshot_id} => String
1190
1388
  #
1389
+ #
1390
+ # @example Example: To create a snapshot of a directory
1391
+ #
1392
+ # # The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
1393
+ #
1394
+ # resp = client.create_snapshot({
1395
+ # directory_id: "d-92654abfed",
1396
+ # name: "ad.example.com",
1397
+ # })
1398
+ #
1399
+ # resp.to_h outputs the following:
1400
+ # {
1401
+ # snapshot_id: "s-9267f8d3f0",
1402
+ # }
1403
+ #
1191
1404
  # @example Request syntax with placeholder values
1192
1405
  #
1193
1406
  # resp = client.create_snapshot({
@@ -1249,6 +1462,27 @@ module Aws::DirectoryService
1249
1462
  #
1250
1463
  # * {Types::CreateTrustResult#trust_id #trust_id} => String
1251
1464
  #
1465
+ #
1466
+ # @example Example: To create a trust
1467
+ #
1468
+ # # The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.
1469
+ #
1470
+ # resp = client.create_trust({
1471
+ # conditional_forwarder_ip_addrs: [
1472
+ # "172.30.21.228",
1473
+ # ],
1474
+ # directory_id: "d-92654abfed",
1475
+ # remote_domain_name: "europe.example.com",
1476
+ # trust_direction: "One-Way: Outgoing",
1477
+ # trust_password: "Str0ngP@ssw0rd",
1478
+ # trust_type: "Forest",
1479
+ # })
1480
+ #
1481
+ # resp.to_h outputs the following:
1482
+ # {
1483
+ # trust_id: "t-9267353743",
1484
+ # }
1485
+ #
1252
1486
  # @example Request syntax with placeholder values
1253
1487
  #
1254
1488
  # resp = client.create_trust({
@@ -1286,6 +1520,20 @@ module Aws::DirectoryService
1286
1520
  #
1287
1521
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1288
1522
  #
1523
+ #
1524
+ # @example Example: To delete a conditional forwarder
1525
+ #
1526
+ # # The following example deletes a conditional forwarder.
1527
+ #
1528
+ # resp = client.delete_conditional_forwarder({
1529
+ # directory_id: "d-92654abfed",
1530
+ # remote_domain_name: "sales.example.com",
1531
+ # })
1532
+ #
1533
+ # resp.to_h outputs the following:
1534
+ # {
1535
+ # }
1536
+ #
1289
1537
  # @example Request syntax with placeholder values
1290
1538
  #
1291
1539
  # resp = client.delete_conditional_forwarder({
@@ -1321,6 +1569,20 @@ module Aws::DirectoryService
1321
1569
  #
1322
1570
  # * {Types::DeleteDirectoryResult#directory_id #directory_id} => String
1323
1571
  #
1572
+ #
1573
+ # @example Example: To delete a directory
1574
+ #
1575
+ # # The following example deletes a directory from your AWS account.
1576
+ #
1577
+ # resp = client.delete_directory({
1578
+ # directory_id: "d-92654abfed",
1579
+ # })
1580
+ #
1581
+ # resp.to_h outputs the following:
1582
+ # {
1583
+ # directory_id: "d-92654abfed",
1584
+ # }
1585
+ #
1324
1586
  # @example Request syntax with placeholder values
1325
1587
  #
1326
1588
  # resp = client.delete_directory({
@@ -1371,6 +1633,20 @@ module Aws::DirectoryService
1371
1633
  #
1372
1634
  # * {Types::DeleteSnapshotResult#snapshot_id #snapshot_id} => String
1373
1635
  #
1636
+ #
1637
+ # @example Example: To delete a snapshot
1638
+ #
1639
+ # # The following example deletes a directory snapshot.
1640
+ #
1641
+ # resp = client.delete_snapshot({
1642
+ # snapshot_id: "s-9267f8d3f0",
1643
+ # })
1644
+ #
1645
+ # resp.to_h outputs the following:
1646
+ # {
1647
+ # snapshot_id: "s-9267f8d3f0",
1648
+ # }
1649
+ #
1374
1650
  # @example Request syntax with placeholder values
1375
1651
  #
1376
1652
  # resp = client.delete_snapshot({
@@ -1403,6 +1679,21 @@ module Aws::DirectoryService
1403
1679
  #
1404
1680
  # * {Types::DeleteTrustResult#trust_id #trust_id} => String
1405
1681
  #
1682
+ #
1683
+ # @example Example: To delete a trust
1684
+ #
1685
+ # # The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.
1686
+ #
1687
+ # resp = client.delete_trust({
1688
+ # delete_associated_conditional_forwarder: true,
1689
+ # trust_id: "t-9267353743",
1690
+ # })
1691
+ #
1692
+ # resp.to_h outputs the following:
1693
+ # {
1694
+ # trust_id: "t-9267353743",
1695
+ # }
1696
+ #
1406
1697
  # @example Request syntax with placeholder values
1407
1698
  #
1408
1699
  # resp = client.delete_trust({
@@ -1463,6 +1754,20 @@ module Aws::DirectoryService
1463
1754
  #
1464
1755
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1465
1756
  #
1757
+ #
1758
+ # @example Example: To remove an event topic
1759
+ #
1760
+ # # The following example removes the specified directory as a publisher to the specified SNS topic.
1761
+ #
1762
+ # resp = client.deregister_event_topic({
1763
+ # directory_id: "d-92654abfed",
1764
+ # topic_name: "snstopicexample",
1765
+ # })
1766
+ #
1767
+ # resp.to_h outputs the following:
1768
+ # {
1769
+ # }
1770
+ #
1466
1771
  # @example Request syntax with placeholder values
1467
1772
  #
1468
1773
  # resp = client.deregister_event_topic({
@@ -1595,6 +1900,24 @@ module Aws::DirectoryService
1595
1900
  #
1596
1901
  # * {Types::DescribeConditionalForwardersResult#conditional_forwarders #conditional_forwarders} => Array<Types::ConditionalForwarder>
1597
1902
  #
1903
+ #
1904
+ # @example Example: To describe conditional forwarders
1905
+ #
1906
+ # # The following example obtains information about the conditional forwarders for a specified directory.
1907
+ #
1908
+ # resp = client.describe_conditional_forwarders({
1909
+ # directory_id: "d-92654abfed",
1910
+ # remote_domain_names: [
1911
+ # "sales.example.com",
1912
+ # ],
1913
+ # })
1914
+ #
1915
+ # resp.to_h outputs the following:
1916
+ # {
1917
+ # conditional_forwarders: [
1918
+ # ],
1919
+ # }
1920
+ #
1598
1921
  # @example Request syntax with placeholder values
1599
1922
  #
1600
1923
  # resp = client.describe_conditional_forwarders({
@@ -1657,6 +1980,51 @@ module Aws::DirectoryService
1657
1980
  #
1658
1981
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1659
1982
  #
1983
+ #
1984
+ # @example Example: To describe one or more directories
1985
+ #
1986
+ # # The following example obtains information about a specified directory.
1987
+ #
1988
+ # resp = client.describe_directories({
1989
+ # directory_ids: [
1990
+ # "d-92654abfed",
1991
+ # ],
1992
+ # limit: 0,
1993
+ # })
1994
+ #
1995
+ # resp.to_h outputs the following:
1996
+ # {
1997
+ # directory_descriptions: [
1998
+ # {
1999
+ # access_url: "myaccess.awsapps.com",
2000
+ # alias: "myaccess",
2001
+ # directory_id: "d-92654abfed",
2002
+ # dns_ip_addrs: [
2003
+ # "172.30.21.228",
2004
+ # "172.30.9.82",
2005
+ # ],
2006
+ # launch_time: Time.parse(1469737584.772),
2007
+ # name: "corp.example.com",
2008
+ # short_name: "example",
2009
+ # sso_enabled: true,
2010
+ # stage: "Active",
2011
+ # stage_last_updated_date_time: Time.parse(1469739131.71),
2012
+ # type: "MicrosoftAD",
2013
+ # vpc_settings: {
2014
+ # availability_zones: [
2015
+ # "us-west-2a",
2016
+ # "us-west-2b",
2017
+ # ],
2018
+ # subnet_ids: [
2019
+ # "subnet-ba0146de",
2020
+ # "subnet-bef46bc8",
2021
+ # ],
2022
+ # vpc_id: "vpc-45025421",
2023
+ # },
2024
+ # },
2025
+ # ],
2026
+ # }
2027
+ #
1660
2028
  # @example Request syntax with placeholder values
1661
2029
  #
1662
2030
  # resp = client.describe_directories({
@@ -1856,6 +2224,30 @@ module Aws::DirectoryService
1856
2224
  #
1857
2225
  # * {Types::DescribeEventTopicsResult#event_topics #event_topics} => Array<Types::EventTopic>
1858
2226
  #
2227
+ #
2228
+ # @example Example: To describe event topics
2229
+ #
2230
+ # # The following example obtains information about which SNS topics receive status messages from the specified directory.
2231
+ #
2232
+ # resp = client.describe_event_topics({
2233
+ # directory_id: "d-92654abfed",
2234
+ # topic_names: [
2235
+ # "snstopicexample",
2236
+ # ],
2237
+ # })
2238
+ #
2239
+ # resp.to_h outputs the following:
2240
+ # {
2241
+ # event_topics: [
2242
+ # {
2243
+ # directory_id: "d-92654abfed",
2244
+ # status: "Registered",
2245
+ # topic_arn: "arn:aws:sns:us-east-2:123456789012:snstopicexample",
2246
+ # topic_name: "snstopicexample",
2247
+ # },
2248
+ # ],
2249
+ # }
2250
+ #
1859
2251
  # @example Request syntax with placeholder values
1860
2252
  #
1861
2253
  # resp = client.describe_event_topics({
@@ -2127,6 +2519,32 @@ module Aws::DirectoryService
2127
2519
  #
2128
2520
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2129
2521
  #
2522
+ #
2523
+ # @example Example: To describe snapshots
2524
+ #
2525
+ # # The following example obtains information about a specified directory snapshot.
2526
+ #
2527
+ # resp = client.describe_snapshots({
2528
+ # directory_id: "d-92654abfed",
2529
+ # limit: 0,
2530
+ # snapshot_ids: [
2531
+ # "s-9267f6da4e",
2532
+ # ],
2533
+ # })
2534
+ #
2535
+ # resp.to_h outputs the following:
2536
+ # {
2537
+ # snapshots: [
2538
+ # {
2539
+ # directory_id: "d-92673c8a8f",
2540
+ # snapshot_id: "s-9267f6da4e",
2541
+ # start_time: Time.parse(1481289211.615),
2542
+ # status: "Completed",
2543
+ # type: "Auto",
2544
+ # },
2545
+ # ],
2546
+ # }
2547
+ #
2130
2548
  # @example Request syntax with placeholder values
2131
2549
  #
2132
2550
  # resp = client.describe_snapshots({
@@ -2187,6 +2605,37 @@ module Aws::DirectoryService
2187
2605
  #
2188
2606
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2189
2607
  #
2608
+ #
2609
+ # @example Example: To describe a trust
2610
+ #
2611
+ # # The following example obtains information about the trust relationship for a specified directory.
2612
+ #
2613
+ # resp = client.describe_trusts({
2614
+ # directory_id: "d-92654abfed",
2615
+ # limit: 0,
2616
+ # trust_ids: [
2617
+ # "t-9267353df0",
2618
+ # ],
2619
+ # })
2620
+ #
2621
+ # resp.to_h outputs the following:
2622
+ # {
2623
+ # trusts: [
2624
+ # {
2625
+ # created_date_time: Time.parse(1481749250.657),
2626
+ # directory_id: "d-92654abfed",
2627
+ # last_updated_date_time: Time.parse(1481749260.156),
2628
+ # remote_domain_name: "sales.example.com",
2629
+ # state_last_updated_date_time: Time.parse(1481749260.156),
2630
+ # trust_direction: "One-Way: Outgoing",
2631
+ # trust_id: "t-9267353df0",
2632
+ # trust_state: "Failed",
2633
+ # trust_state_reason: "The specified domain either does not exist or could not be contacted. Name: sales.example.com",
2634
+ # trust_type: "Forest",
2635
+ # },
2636
+ # ],
2637
+ # }
2638
+ #
2190
2639
  # @example Request syntax with placeholder values
2191
2640
  #
2192
2641
  # resp = client.describe_trusts({
@@ -2303,7 +2752,12 @@ module Aws::DirectoryService
2303
2752
  end
2304
2753
 
2305
2754
  # Deactivates access to directory data via the Directory Service Data
2306
- # API for the specified directory.
2755
+ # API for the specified directory. For more information, see [Directory
2756
+ # Service Data API Reference][1].
2757
+ #
2758
+ #
2759
+ #
2760
+ # [1]: https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html
2307
2761
  #
2308
2762
  # @option params [required, String] :directory_id
2309
2763
  # The directory identifier.
@@ -2361,6 +2815,20 @@ module Aws::DirectoryService
2361
2815
  #
2362
2816
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2363
2817
  #
2818
+ #
2819
+ # @example Example: To disable radius
2820
+ #
2821
+ # # The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service
2822
+ # # (RADIUS) server for an AD Connector directory.
2823
+ #
2824
+ # resp = client.disable_radius({
2825
+ # directory_id: "d-92654abfed",
2826
+ # })
2827
+ #
2828
+ # resp.to_h outputs the following:
2829
+ # {
2830
+ # }
2831
+ #
2364
2832
  # @example Request syntax with placeholder values
2365
2833
  #
2366
2834
  # resp = client.disable_radius({
@@ -2399,6 +2867,21 @@ module Aws::DirectoryService
2399
2867
  #
2400
2868
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2401
2869
  #
2870
+ #
2871
+ # @example Example: To disable SSO
2872
+ #
2873
+ # # The following example disables single sign-on for a specified directory.
2874
+ #
2875
+ # resp = client.disable_sso({
2876
+ # directory_id: "d-92654abfed",
2877
+ # password: "Str0ngP@ssw0rd",
2878
+ # user_name: "Admin",
2879
+ # })
2880
+ #
2881
+ # resp.to_h outputs the following:
2882
+ # {
2883
+ # }
2884
+ #
2402
2885
  # @example Request syntax with placeholder values
2403
2886
  #
2404
2887
  # resp = client.disable_sso({
@@ -2447,7 +2930,12 @@ module Aws::DirectoryService
2447
2930
  end
2448
2931
 
2449
2932
  # Enables access to directory data via the Directory Service Data API
2450
- # for the specified directory.
2933
+ # for the specified directory. For more information, see [Directory
2934
+ # Service Data API Reference][1].
2935
+ #
2936
+ #
2937
+ #
2938
+ # [1]: https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html
2451
2939
  #
2452
2940
  # @option params [required, String] :directory_id
2453
2941
  # The directory identifier.
@@ -2510,6 +2998,32 @@ module Aws::DirectoryService
2510
2998
  #
2511
2999
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2512
3000
  #
3001
+ #
3002
+ # @example Example: To enable radius
3003
+ #
3004
+ # # The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service
3005
+ # # (RADIUS) server for an AD Connector directory.
3006
+ #
3007
+ # resp = client.enable_radius({
3008
+ # directory_id: "d-92654abfed",
3009
+ # radius_settings: {
3010
+ # authentication_protocol: "PAP",
3011
+ # display_label: "MyRadius",
3012
+ # radius_port: 1200,
3013
+ # radius_retries: 2,
3014
+ # radius_servers: [
3015
+ # "172.168.111.12",
3016
+ # ],
3017
+ # radius_timeout: 1,
3018
+ # shared_secret: "123456789",
3019
+ # use_same_username: true,
3020
+ # },
3021
+ # })
3022
+ #
3023
+ # resp.to_h outputs the following:
3024
+ # {
3025
+ # }
3026
+ #
2513
3027
  # @example Request syntax with placeholder values
2514
3028
  #
2515
3029
  # resp = client.enable_radius({
@@ -2561,6 +3075,21 @@ module Aws::DirectoryService
2561
3075
  #
2562
3076
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2563
3077
  #
3078
+ #
3079
+ # @example Example: To enable SSO
3080
+ #
3081
+ # # To enable single sign-on for a specified directory.
3082
+ #
3083
+ # resp = client.enable_sso({
3084
+ # directory_id: "d-92654abfed",
3085
+ # password: "Str0ngP@ssw0rd",
3086
+ # user_name: "Admin",
3087
+ # })
3088
+ #
3089
+ # resp.to_h outputs the following:
3090
+ # {
3091
+ # }
3092
+ #
2564
3093
  # @example Request syntax with placeholder values
2565
3094
  #
2566
3095
  # resp = client.enable_sso({
@@ -2584,6 +3113,29 @@ module Aws::DirectoryService
2584
3113
  #
2585
3114
  # * {Types::GetDirectoryLimitsResult#directory_limits #directory_limits} => Types::DirectoryLimits
2586
3115
  #
3116
+ #
3117
+ # @example Example: To get directory limits
3118
+ #
3119
+ # # The following example obtains directory limit information for the current region.
3120
+ #
3121
+ # resp = client.get_directory_limits({
3122
+ # })
3123
+ #
3124
+ # resp.to_h outputs the following:
3125
+ # {
3126
+ # directory_limits: {
3127
+ # cloud_only_directories_current_count: 2,
3128
+ # cloud_only_directories_limit: 10,
3129
+ # cloud_only_directories_limit_reached: false,
3130
+ # cloud_only_microsoft_ad_current_count: 2,
3131
+ # cloud_only_microsoft_ad_limit: 10,
3132
+ # cloud_only_microsoft_ad_limit_reached: false,
3133
+ # connected_directories_current_count: 1,
3134
+ # connected_directories_limit: 10,
3135
+ # connected_directories_limit_reached: false,
3136
+ # },
3137
+ # }
3138
+ #
2587
3139
  # @example Response structure
2588
3140
  #
2589
3141
  # resp.directory_limits.cloud_only_directories_limit #=> Integer
@@ -2614,6 +3166,24 @@ module Aws::DirectoryService
2614
3166
  #
2615
3167
  # * {Types::GetSnapshotLimitsResult#snapshot_limits #snapshot_limits} => Types::SnapshotLimits
2616
3168
  #
3169
+ #
3170
+ # @example Example: To get snapshot limits
3171
+ #
3172
+ # # The following example obtains the manual snapshot limits for a specified directory.
3173
+ #
3174
+ # resp = client.get_snapshot_limits({
3175
+ # directory_id: "d-92654abfed",
3176
+ # })
3177
+ #
3178
+ # resp.to_h outputs the following:
3179
+ # {
3180
+ # snapshot_limits: {
3181
+ # manual_snapshots_current_count: 1,
3182
+ # manual_snapshots_limit: 5,
3183
+ # manual_snapshots_limit_reached: false,
3184
+ # },
3185
+ # }
3186
+ #
2617
3187
  # @example Request syntax with placeholder values
2618
3188
  #
2619
3189
  # resp = client.get_snapshot_limits({
@@ -2705,6 +3275,29 @@ module Aws::DirectoryService
2705
3275
  #
2706
3276
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2707
3277
  #
3278
+ #
3279
+ # @example Example: To list IP routes
3280
+ #
3281
+ # # The following example lists the address blocks that have been added to a specified directory.
3282
+ #
3283
+ # resp = client.list_ip_routes({
3284
+ # directory_id: "d-92654abfed",
3285
+ # limit: 0,
3286
+ # })
3287
+ #
3288
+ # resp.to_h outputs the following:
3289
+ # {
3290
+ # ip_routes_info: [
3291
+ # {
3292
+ # added_date_time: Time.parse(1481577631.63),
3293
+ # cidr_ip: "12.12.12.12/32",
3294
+ # description: "example",
3295
+ # directory_id: "d-92654abfed",
3296
+ # ip_route_status_msg: "Added",
3297
+ # },
3298
+ # ],
3299
+ # }
3300
+ #
2708
3301
  # @example Request syntax with placeholder values
2709
3302
  #
2710
3303
  # resp = client.list_ip_routes({
@@ -2801,6 +3394,31 @@ module Aws::DirectoryService
2801
3394
  #
2802
3395
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2803
3396
  #
3397
+ #
3398
+ # @example Example: To list schema extensions
3399
+ #
3400
+ # # The following example lists all schema extensions applied to a specified Microsoft AD Directory.
3401
+ #
3402
+ # resp = client.list_schema_extensions({
3403
+ # directory_id: "d-92654abfed",
3404
+ # limit: 0,
3405
+ # })
3406
+ #
3407
+ # resp.to_h outputs the following:
3408
+ # {
3409
+ # schema_extensions_info: [
3410
+ # {
3411
+ # description: "example text",
3412
+ # directory_id: "d-92654abfed",
3413
+ # end_date_time: Time.parse(1481586088.301),
3414
+ # schema_extension_id: "e-926731d2a0",
3415
+ # schema_extension_status: "Cancelled",
3416
+ # schema_extension_status_reason: "Cancellation is complete. No schema updates were applied to your directory.",
3417
+ # start_date_time: Time.parse(1481584463.548),
3418
+ # },
3419
+ # ],
3420
+ # }
3421
+ #
2804
3422
  # @example Request syntax with placeholder values
2805
3423
  #
2806
3424
  # resp = client.list_schema_extensions({
@@ -2848,6 +3466,26 @@ module Aws::DirectoryService
2848
3466
  #
2849
3467
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2850
3468
  #
3469
+ #
3470
+ # @example Example: To list tags for a directory
3471
+ #
3472
+ # # The following example lists all tags associated with a specified directory.
3473
+ #
3474
+ # resp = client.list_tags_for_resource({
3475
+ # limit: 0,
3476
+ # resource_id: "d-92654abfed",
3477
+ # })
3478
+ #
3479
+ # resp.to_h outputs the following:
3480
+ # {
3481
+ # tags: [
3482
+ # {
3483
+ # key: "environment",
3484
+ # value: "production",
3485
+ # },
3486
+ # ],
3487
+ # }
3488
+ #
2851
3489
  # @example Request syntax with placeholder values
2852
3490
  #
2853
3491
  # resp = client.list_tags_for_resource({
@@ -2936,6 +3574,20 @@ module Aws::DirectoryService
2936
3574
  #
2937
3575
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2938
3576
  #
3577
+ #
3578
+ # @example Example: To register an event topic
3579
+ #
3580
+ # # The following example associates a directory with an SNS topic.
3581
+ #
3582
+ # resp = client.register_event_topic({
3583
+ # directory_id: "d-92654abfed",
3584
+ # topic_name: "snstopicexample",
3585
+ # })
3586
+ #
3587
+ # resp.to_h outputs the following:
3588
+ # {
3589
+ # }
3590
+ #
2939
3591
  # @example Request syntax with placeholder values
2940
3592
  #
2941
3593
  # resp = client.register_event_topic({
@@ -2993,6 +3645,22 @@ module Aws::DirectoryService
2993
3645
  #
2994
3646
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2995
3647
  #
3648
+ #
3649
+ # @example Example: To remove IP routes
3650
+ #
3651
+ # # The following example removes IP address blocks from a specified directory.
3652
+ #
3653
+ # resp = client.remove_ip_routes({
3654
+ # cidr_ips: [
3655
+ # "12.12.12.12/32",
3656
+ # ],
3657
+ # directory_id: "d-92654abfed",
3658
+ # })
3659
+ #
3660
+ # resp.to_h outputs the following:
3661
+ # {
3662
+ # }
3663
+ #
2996
3664
  # @example Request syntax with placeholder values
2997
3665
  #
2998
3666
  # resp = client.remove_ip_routes({
@@ -3044,6 +3712,22 @@ module Aws::DirectoryService
3044
3712
  #
3045
3713
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3046
3714
  #
3715
+ #
3716
+ # @example Example: To remove tags from a directory
3717
+ #
3718
+ # # The following example removes a tag from a specified directory.
3719
+ #
3720
+ # resp = client.remove_tags_from_resource({
3721
+ # resource_id: "d-92654abfed",
3722
+ # tag_keys: [
3723
+ # "environment",
3724
+ # ],
3725
+ # })
3726
+ #
3727
+ # resp.to_h outputs the following:
3728
+ # {
3729
+ # }
3730
+ #
3047
3731
  # @example Request syntax with placeholder values
3048
3732
  #
3049
3733
  # resp = client.remove_tags_from_resource({
@@ -3128,6 +3812,19 @@ module Aws::DirectoryService
3128
3812
  #
3129
3813
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3130
3814
  #
3815
+ #
3816
+ # @example Example: To restore a snapshot
3817
+ #
3818
+ # # The following example restores a directory using an existing directory snapshot.
3819
+ #
3820
+ # resp = client.restore_from_snapshot({
3821
+ # snapshot_id: "s-9267f6da4e",
3822
+ # })
3823
+ #
3824
+ # resp.to_h outputs the following:
3825
+ # {
3826
+ # }
3827
+ #
3131
3828
  # @example Request syntax with placeholder values
3132
3829
  #
3133
3830
  # resp = client.restore_from_snapshot({
@@ -3236,6 +3933,23 @@ module Aws::DirectoryService
3236
3933
  #
3237
3934
  # * {Types::StartSchemaExtensionResult#schema_extension_id #schema_extension_id} => String
3238
3935
  #
3936
+ #
3937
+ # @example Example: To start a schema extension
3938
+ #
3939
+ # # The following example applies a schema extension to a specified Microsoft AD directory.
3940
+ #
3941
+ # resp = client.start_schema_extension({
3942
+ # create_snapshot_before_schema_extension: true,
3943
+ # description: "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file.",
3944
+ # directory_id: "d-92654abfed",
3945
+ # ldif_content: "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com\nchangetype: modify\nadd: mayContain\nmayContain: drink\n-\n\nDN:\nchangetype: modify\nreplace: schemaupdatenow\nschemaupdatenow: 1\n-",
3946
+ # })
3947
+ #
3948
+ # resp.to_h outputs the following:
3949
+ # {
3950
+ # schema_extension_id: "e-926731dc50",
3951
+ # }
3952
+ #
3239
3953
  # @example Request syntax with placeholder values
3240
3954
  #
3241
3955
  # resp = client.start_schema_extension({
@@ -3313,6 +4027,23 @@ module Aws::DirectoryService
3313
4027
  #
3314
4028
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3315
4029
  #
4030
+ #
4031
+ # @example Example: To update a conditional forwarder
4032
+ #
4033
+ # # The following example updates a conditional forwarder for a specified directory.
4034
+ #
4035
+ # resp = client.update_conditional_forwarder({
4036
+ # directory_id: "d-92654abfed",
4037
+ # dns_ip_addrs: [
4038
+ # "172.168.101.11",
4039
+ # ],
4040
+ # remote_domain_name: "sales.example.com",
4041
+ # })
4042
+ #
4043
+ # resp.to_h outputs the following:
4044
+ # {
4045
+ # }
4046
+ #
3316
4047
  # @example Request syntax with placeholder values
3317
4048
  #
3318
4049
  # resp = client.update_conditional_forwarder({
@@ -3415,6 +4146,32 @@ module Aws::DirectoryService
3415
4146
  #
3416
4147
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3417
4148
  #
4149
+ #
4150
+ # @example Example: To update Radius
4151
+ #
4152
+ # # The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD
4153
+ # # Connector directory.
4154
+ #
4155
+ # resp = client.update_radius({
4156
+ # directory_id: "d-92654abfed",
4157
+ # radius_settings: {
4158
+ # authentication_protocol: "PAP",
4159
+ # display_label: "MyRadius",
4160
+ # radius_port: 1027,
4161
+ # radius_retries: 1,
4162
+ # radius_servers: [
4163
+ # "172.168.101.113",
4164
+ # ],
4165
+ # radius_timeout: 1,
4166
+ # shared_secret: "12345678",
4167
+ # use_same_username: true,
4168
+ # },
4169
+ # })
4170
+ #
4171
+ # resp.to_h outputs the following:
4172
+ # {
4173
+ # }
4174
+ #
3418
4175
  # @example Request syntax with placeholder values
3419
4176
  #
3420
4177
  # resp = client.update_radius({
@@ -3525,6 +4282,20 @@ module Aws::DirectoryService
3525
4282
  #
3526
4283
  # * {Types::VerifyTrustResult#trust_id #trust_id} => String
3527
4284
  #
4285
+ #
4286
+ # @example Example: To verify a trust
4287
+ #
4288
+ # # The following example verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
4289
+ #
4290
+ # resp = client.verify_trust({
4291
+ # trust_id: "t-9267353df0",
4292
+ # })
4293
+ #
4294
+ # resp.to_h outputs the following:
4295
+ # {
4296
+ # trust_id: "t-9267353df0",
4297
+ # }
4298
+ #
3528
4299
  # @example Request syntax with placeholder values
3529
4300
  #
3530
4301
  # resp = client.verify_trust({
@@ -3562,7 +4333,7 @@ module Aws::DirectoryService
3562
4333
  tracer: tracer
3563
4334
  )
3564
4335
  context[:gem_name] = 'aws-sdk-directoryservice'
3565
- context[:gem_version] = '1.83.0'
4336
+ context[:gem_version] = '1.85.0'
3566
4337
  Seahorse::Client::Request.new(handlers, context)
3567
4338
  end
3568
4339
 
@@ -1375,7 +1375,8 @@ module Aws::DirectoryService
1375
1375
  # Contains the results of the DescribeDirectories operation.
1376
1376
  #
1377
1377
  # @!attribute [rw] directory_descriptions
1378
- # The list of DirectoryDescription objects that were retrieved.
1378
+ # The list of available DirectoryDescription objects that were
1379
+ # retrieved.
1379
1380
  #
1380
1381
  # It is possible that this list contains less than the number of items
1381
1382
  # specified in the `Limit` member of the request. This occurs if there
@@ -54,7 +54,7 @@ module Aws::DirectoryService
54
54
  autoload :EndpointProvider, 'aws-sdk-directoryservice/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-directoryservice/endpoints'
56
56
 
57
- GEM_VERSION = '1.83.0'
57
+ GEM_VERSION = '1.85.0'
58
58
 
59
59
  end
60
60
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-directoryservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.83.0
4
+ version: 1.85.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services