aws-sdk-directoryservice 1.83.0 → 1.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71caf27144df09c8b51f56313b1a5c121185635b990ce3b365ee184b404bc4c
-  data.tar.gz: eab37adb0947d86ca8f5675b8b2747486ec4d82da396975ca804ca92b68f7df6
+  metadata.gz: ab5ac9509f3969a852edeab48f440d2e6e7932c0c760402333ada1405edcf71b
+  data.tar.gz: 9a7277c7838c834c1c8400542a68b8aa2ee58cce40b1ef83791297387314390c
 SHA512:
-  metadata.gz: 67cb917fcb0086d226aa3597c33c7dbec08542998da70e959835878d9fe8e23f8d9bd5e6ce2dc4c9e402beb5a1b330b63dd0ee883bf87c57964eaf6b7dc6ab39
-  data.tar.gz: 58867ce5be8408997a0ffcd9d5a403474012fd025ab730f48aa6d6dd93652eeacd277f65458960402802c56b3ffcf0123edd6b1ead77519ed2e29ac9907be067
+  metadata.gz: 5d40d854172ec703381c8926b6ba59ec445af1f49b2e940b01dd61f094e97d19a2797065050152c56ebae22908b13f1a9389ba0fe186aed4826c408be000f47e
+  data.tar.gz: 66a95ebcc7615e478ae72362123378a08f9c77cf45eaac6840b2840674723726a527e234c53830dcc42baf33e7919b3b29c0ad7032a6cc31bc80c03af4e8de45

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.84.0 (2025-05-02)
+------------------
+
+* Feature - Doc only update - fixed typos.
+
 1.83.0 (2025-05-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.83.0
+1.84.0

data/lib/aws-sdk-directoryservice/client.rb

@@ -612,6 +612,25 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To add a CIDR address block that routes traffic for Microsoft AD
+    #
+    #   # The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.
+    #
+    #   resp = client.add_ip_routes({
+    #     directory_id: "d-92654abfed", 
+    #     ip_routes: [
+    #       {
+    #         cidr_ip: "12.12.12.12/32", 
+    #         description: "my IpRoute", 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.add_ip_routes({
@@ -683,6 +702,25 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To add tags to a directory
+    #
+    #   # The following example adds or overwrites one or more tags for the specified directory.
+    #
+    #   resp = client.add_tags_to_resource({
+    #     resource_id: "d-92654abfed", 
+    #     tags: [
+    #       {
+    #         key: "environment", 
+    #         value: "production", 
+    #       }, 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.add_tags_to_resource({
@@ -719,6 +757,20 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To cancel a Microsoft AD schema extension that is in progress
+    #
+    #   # The following example cancels an in-progress schema extension to a Microsoft AD directory.
+    #
+    #   resp = client.cancel_schema_extension({
+    #     directory_id: "d-92654abfed", 
+    #     schema_extension_id: "e-926731d2a0", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.cancel_schema_extension({
@@ -774,6 +826,35 @@ module Aws::DirectoryService
     #
     #   * {Types::ConnectDirectoryResult#directory_id #directory_id} => String
     #
+    #
+    # @example Example: To connect to an on-premises directory
+    #
+    #   # The following example creates an AD Connector to connect to an on-premises directory.
+    #
+    #   resp = client.connect_directory({
+    #     connect_settings: {
+    #       customer_dns_ips: [
+    #         "172.30.21.228", 
+    #       ], 
+    #       customer_user_name: "Administrator", 
+    #       subnet_ids: [
+    #         "subnet-ba0146de", 
+    #         "subnet-bef46bc8", 
+    #       ], 
+    #       vpc_id: "vpc-45025421", 
+    #     }, 
+    #     description: "Connector to corp", 
+    #     name: "corp.example.com", 
+    #     password: "Str0ngP@ssw0rd", 
+    #     short_name: "corp", 
+    #     size: "Small", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_id: "d-92654abfed", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.connect_directory({
@@ -831,6 +912,22 @@ module Aws::DirectoryService
     #   * {Types::CreateAliasResult#directory_id #directory_id} => String
     #   * {Types::CreateAliasResult#alias #alias} => String
     #
+    #
+    # @example Example: To create an alias for a directory
+    #
+    #   # The following example creates an alias for a directory.
+    #
+    #   resp = client.create_alias({
+    #     alias: "salesorg", 
+    #     directory_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     alias: "salesorg", 
+    #     directory_id: "d-92654abfed", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_alias({
@@ -879,6 +976,42 @@ module Aws::DirectoryService
     #
     #   * {Types::CreateComputerResult#computer #computer} => Types::Computer
     #
+    #
+    # @example Example: To create a computer account
+    #
+    #   # The following example creates a computer account in the specified directory, and joins the computer to the directory.
+    #
+    #   resp = client.create_computer({
+    #     computer_attributes: [
+    #       {
+    #         name: "ip", 
+    #         value: "192.168.101.100", 
+    #       }, 
+    #     ], 
+    #     computer_name: "labcomputer", 
+    #     directory_id: "d-92654abfed", 
+    #     organizational_unit_distinguished_name: "OU=Computers,OU=example,DC=corp,DC=example,DC=com", 
+    #     password: "Str0ngP@ssw0rd", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     computer: {
+    #       computer_attributes: [
+    #         {
+    #           name: "DistinguishedName", 
+    #           value: "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com", 
+    #         }, 
+    #         {
+    #           name: "WindowsSamName", 
+    #           value: "labcomputer$", 
+    #         }, 
+    #       ], 
+    #       computer_id: "S-1-5-21-1932691875-1648176379-1176097576-1124", 
+    #       computer_name: "labcomputer", 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_computer({
@@ -930,6 +1063,23 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To create a conditional forwarder
+    #
+    #   # The following example creates a conditional forwarder associated with your AWS directory.
+    #
+    #   resp = client.create_conditional_forwarder({
+    #     directory_id: "d-92654abfed", 
+    #     dns_ip_addrs: [
+    #       "172.30.21.228", 
+    #     ], 
+    #     remote_domain_name: "sales.example.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_conditional_forwarder({
@@ -1023,6 +1173,31 @@ module Aws::DirectoryService
     #
     #   * {Types::CreateDirectoryResult#directory_id #directory_id} => String
     #
+    #
+    # @example Example: To create a Simple AD directory
+    #
+    #   # The following example creates a Simple AD directory.
+    #
+    #   resp = client.create_directory({
+    #     description: "Regional directory for example.com", 
+    #     name: "seattle.example.com", 
+    #     password: "Str0ngP@ssw0rd", 
+    #     short_name: "seattle", 
+    #     size: "Small", 
+    #     vpc_settings: {
+    #       subnet_ids: [
+    #         "subnet-ba0146de", 
+    #         "subnet-bef46bc8", 
+    #       ], 
+    #       vpc_id: "vpc-45025421", 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_id: "d-92654abfed", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_directory({
@@ -1138,6 +1313,30 @@ module Aws::DirectoryService
     #
     #   * {Types::CreateMicrosoftADResult#directory_id #directory_id} => String
     #
+    #
+    # @example Example: To create a Microsoft AD directory
+    #
+    #   # The following example creates a Microsoft AD directory in the AWS cloud.
+    #
+    #   resp = client.create_microsoft_ad({
+    #     description: "Corporate AD directory", 
+    #     name: "ad.example.com", 
+    #     password: "Str0ngP@ssw0rd", 
+    #     short_name: "ad", 
+    #     vpc_settings: {
+    #       subnet_ids: [
+    #         "subnet-ba0146de", 
+    #         "subnet-bef46bc8", 
+    #       ], 
+    #       vpc_id: "vpc-45025421", 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_id: "d-92654abfed", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_microsoft_ad({
@@ -1188,6 +1387,21 @@ module Aws::DirectoryService
     #
     #   * {Types::CreateSnapshotResult#snapshot_id #snapshot_id} => String
     #
+    #
+    # @example Example: To create a snapshot of a directory
+    #
+    #   # The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
+    #
+    #   resp = client.create_snapshot({
+    #     directory_id: "d-92654abfed", 
+    #     name: "ad.example.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     snapshot_id: "s-9267f8d3f0", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_snapshot({
@@ -1249,6 +1463,27 @@ module Aws::DirectoryService
     #
     #   * {Types::CreateTrustResult#trust_id #trust_id} => String
     #
+    #
+    # @example Example: To create a trust
+    #
+    #   # The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.
+    #
+    #   resp = client.create_trust({
+    #     conditional_forwarder_ip_addrs: [
+    #       "172.30.21.228", 
+    #     ], 
+    #     directory_id: "d-92654abfed", 
+    #     remote_domain_name: "europe.example.com", 
+    #     trust_direction: "One-Way: Outgoing", 
+    #     trust_password: "Str0ngP@ssw0rd", 
+    #     trust_type: "Forest", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     trust_id: "t-9267353743", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_trust({
@@ -1286,6 +1521,20 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To delete a conditional forwarder
+    #
+    #   # The following example deletes a conditional forwarder. 
+    #
+    #   resp = client.delete_conditional_forwarder({
+    #     directory_id: "d-92654abfed", 
+    #     remote_domain_name: "sales.example.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_conditional_forwarder({
@@ -1321,6 +1570,20 @@ module Aws::DirectoryService
     #
     #   * {Types::DeleteDirectoryResult#directory_id #directory_id} => String
     #
+    #
+    # @example Example: To delete a directory
+    #
+    #   # The following example deletes a directory from your AWS account.
+    #
+    #   resp = client.delete_directory({
+    #     directory_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_id: "d-92654abfed", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_directory({
@@ -1371,6 +1634,20 @@ module Aws::DirectoryService
     #
     #   * {Types::DeleteSnapshotResult#snapshot_id #snapshot_id} => String
     #
+    #
+    # @example Example: To delete a snapshot
+    #
+    #   # The following example deletes a directory snapshot.
+    #
+    #   resp = client.delete_snapshot({
+    #     snapshot_id: "s-9267f8d3f0", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     snapshot_id: "s-9267f8d3f0", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_snapshot({
@@ -1403,6 +1680,21 @@ module Aws::DirectoryService
     #
     #   * {Types::DeleteTrustResult#trust_id #trust_id} => String
     #
+    #
+    # @example Example: To delete a trust
+    #
+    #   # The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.
+    #
+    #   resp = client.delete_trust({
+    #     delete_associated_conditional_forwarder: true, 
+    #     trust_id: "t-9267353743", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     trust_id: "t-9267353743", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.delete_trust({
@@ -1463,6 +1755,20 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To remove an event topic
+    #
+    #   # The following example removes the specified directory as a publisher to the specified SNS topic.
+    #
+    #   resp = client.deregister_event_topic({
+    #     directory_id: "d-92654abfed", 
+    #     topic_name: "snstopicexample", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.deregister_event_topic({
@@ -1595,6 +1901,24 @@ module Aws::DirectoryService
     #
     #   * {Types::DescribeConditionalForwardersResult#conditional_forwarders #conditional_forwarders} => Array<Types::ConditionalForwarder>
     #
+    #
+    # @example Example: To describe conditional forwarders
+    #
+    #   # The following example obtains information about the conditional forwarders for a specified directory.
+    #
+    #   resp = client.describe_conditional_forwarders({
+    #     directory_id: "d-92654abfed", 
+    #     remote_domain_names: [
+    #       "sales.example.com", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     conditional_forwarders: [
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_conditional_forwarders({
@@ -1657,6 +1981,51 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To describe one or more directories
+    #
+    #   # The following example obtains information about a specified directory.
+    #
+    #   resp = client.describe_directories({
+    #     directory_ids: [
+    #       "d-92654abfed", 
+    #     ], 
+    #     limit: 0, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_descriptions: [
+    #       {
+    #         access_url: "myaccess.awsapps.com", 
+    #         alias: "myaccess", 
+    #         directory_id: "d-92654abfed", 
+    #         dns_ip_addrs: [
+    #           "172.30.21.228", 
+    #           "172.30.9.82", 
+    #         ], 
+    #         launch_time: Time.parse(1469737584.772), 
+    #         name: "corp.example.com", 
+    #         short_name: "example", 
+    #         sso_enabled: true, 
+    #         stage: "Active", 
+    #         stage_last_updated_date_time: Time.parse(1469739131.71), 
+    #         type: "MicrosoftAD", 
+    #         vpc_settings: {
+    #           availability_zones: [
+    #             "us-west-2a", 
+    #             "us-west-2b", 
+    #           ], 
+    #           subnet_ids: [
+    #             "subnet-ba0146de", 
+    #             "subnet-bef46bc8", 
+    #           ], 
+    #           vpc_id: "vpc-45025421", 
+    #         }, 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_directories({
@@ -1856,6 +2225,30 @@ module Aws::DirectoryService
     #
     #   * {Types::DescribeEventTopicsResult#event_topics #event_topics} => Array<Types::EventTopic>
     #
+    #
+    # @example Example: To describe event topics
+    #
+    #   # The following example obtains information about which SNS topics receive status messages from the specified directory.
+    #
+    #   resp = client.describe_event_topics({
+    #     directory_id: "d-92654abfed", 
+    #     topic_names: [
+    #       "snstopicexample", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     event_topics: [
+    #       {
+    #         directory_id: "d-92654abfed", 
+    #         status: "Registered", 
+    #         topic_arn: "arn:aws:sns:us-east-2:123456789012:snstopicexample", 
+    #         topic_name: "snstopicexample", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_event_topics({
@@ -2127,6 +2520,32 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To describe snapshots
+    #
+    #   # The following example obtains information about a specified directory snapshot.
+    #
+    #   resp = client.describe_snapshots({
+    #     directory_id: "d-92654abfed", 
+    #     limit: 0, 
+    #     snapshot_ids: [
+    #       "s-9267f6da4e", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     snapshots: [
+    #       {
+    #         directory_id: "d-92673c8a8f", 
+    #         snapshot_id: "s-9267f6da4e", 
+    #         start_time: Time.parse(1481289211.615), 
+    #         status: "Completed", 
+    #         type: "Auto", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_snapshots({
@@ -2187,6 +2606,37 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To describe a trust 
+    #
+    #   # The following example obtains information about the trust relationship for a specified directory.
+    #
+    #   resp = client.describe_trusts({
+    #     directory_id: "d-92654abfed", 
+    #     limit: 0, 
+    #     trust_ids: [
+    #       "t-9267353df0", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     trusts: [
+    #       {
+    #         created_date_time: Time.parse(1481749250.657), 
+    #         directory_id: "d-92654abfed", 
+    #         last_updated_date_time: Time.parse(1481749260.156), 
+    #         remote_domain_name: "sales.example.com", 
+    #         state_last_updated_date_time: Time.parse(1481749260.156), 
+    #         trust_direction: "One-Way: Outgoing", 
+    #         trust_id: "t-9267353df0", 
+    #         trust_state: "Failed", 
+    #         trust_state_reason: "The specified domain either does not exist or could not be contacted. Name: sales.example.com", 
+    #         trust_type: "Forest", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_trusts({
@@ -2303,7 +2753,12 @@ module Aws::DirectoryService
     end
 
     # Deactivates access to directory data via the Directory Service Data
-    # API for the specified directory.
+    # API for the specified directory. For more information, see [Directory
+    # Service Data API Reference][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html
     #
     # @option params [required, String] :directory_id
     #   The directory identifier.
@@ -2361,6 +2816,20 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To disable radius
+    #
+    #   # The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service
+    #   # (RADIUS) server for an AD Connector directory.
+    #
+    #   resp = client.disable_radius({
+    #     directory_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.disable_radius({
@@ -2399,6 +2868,21 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To disable SSO
+    #
+    #   # The following example disables single sign-on for a specified directory.
+    #
+    #   resp = client.disable_sso({
+    #     directory_id: "d-92654abfed", 
+    #     password: "Str0ngP@ssw0rd", 
+    #     user_name: "Admin", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.disable_sso({
@@ -2447,7 +2931,12 @@ module Aws::DirectoryService
     end
 
     # Enables access to directory data via the Directory Service Data API
-    # for the specified directory.
+    # for the specified directory. For more information, see [Directory
+    # Service Data API Reference][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html
     #
     # @option params [required, String] :directory_id
     #   The directory identifier.
@@ -2510,6 +2999,32 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To enable radius
+    #
+    #   # The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service
+    #   # (RADIUS) server for an AD Connector directory.
+    #
+    #   resp = client.enable_radius({
+    #     directory_id: "d-92654abfed", 
+    #     radius_settings: {
+    #       authentication_protocol: "PAP", 
+    #       display_label: "MyRadius", 
+    #       radius_port: 1200, 
+    #       radius_retries: 2, 
+    #       radius_servers: [
+    #         "172.168.111.12", 
+    #       ], 
+    #       radius_timeout: 1, 
+    #       shared_secret: "123456789", 
+    #       use_same_username: true, 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.enable_radius({
@@ -2561,6 +3076,21 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To enable SSO
+    #
+    #   # To enable single sign-on for a specified directory.
+    #
+    #   resp = client.enable_sso({
+    #     directory_id: "d-92654abfed", 
+    #     password: "Str0ngP@ssw0rd", 
+    #     user_name: "Admin", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.enable_sso({
@@ -2584,6 +3114,29 @@ module Aws::DirectoryService
     #
     #   * {Types::GetDirectoryLimitsResult#directory_limits #directory_limits} => Types::DirectoryLimits
     #
+    #
+    # @example Example: To get directory limits
+    #
+    #   # The following example obtains directory limit information for the current region.
+    #
+    #   resp = client.get_directory_limits({
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     directory_limits: {
+    #       cloud_only_directories_current_count: 2, 
+    #       cloud_only_directories_limit: 10, 
+    #       cloud_only_directories_limit_reached: false, 
+    #       cloud_only_microsoft_ad_current_count: 2, 
+    #       cloud_only_microsoft_ad_limit: 10, 
+    #       cloud_only_microsoft_ad_limit_reached: false, 
+    #       connected_directories_current_count: 1, 
+    #       connected_directories_limit: 10, 
+    #       connected_directories_limit_reached: false, 
+    #     }, 
+    #   }
+    #
     # @example Response structure
     #
     #   resp.directory_limits.cloud_only_directories_limit #=> Integer
@@ -2614,6 +3167,24 @@ module Aws::DirectoryService
     #
     #   * {Types::GetSnapshotLimitsResult#snapshot_limits #snapshot_limits} => Types::SnapshotLimits
     #
+    #
+    # @example Example: To get snapshot limits
+    #
+    #   # The following example obtains the manual snapshot limits for a specified directory.
+    #
+    #   resp = client.get_snapshot_limits({
+    #     directory_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     snapshot_limits: {
+    #       manual_snapshots_current_count: 1, 
+    #       manual_snapshots_limit: 5, 
+    #       manual_snapshots_limit_reached: false, 
+    #     }, 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_snapshot_limits({
@@ -2705,6 +3276,29 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list IP routes
+    #
+    #   # The following example lists the address blocks that have been added to a specified directory.
+    #
+    #   resp = client.list_ip_routes({
+    #     directory_id: "d-92654abfed", 
+    #     limit: 0, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     ip_routes_info: [
+    #       {
+    #         added_date_time: Time.parse(1481577631.63), 
+    #         cidr_ip: "12.12.12.12/32", 
+    #         description: "example", 
+    #         directory_id: "d-92654abfed", 
+    #         ip_route_status_msg: "Added", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_ip_routes({
@@ -2801,6 +3395,31 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list schema extensions
+    #
+    #   # The following example lists all schema extensions applied to a specified Microsoft AD Directory.
+    #
+    #   resp = client.list_schema_extensions({
+    #     directory_id: "d-92654abfed", 
+    #     limit: 0, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     schema_extensions_info: [
+    #       {
+    #         description: "example text", 
+    #         directory_id: "d-92654abfed", 
+    #         end_date_time: Time.parse(1481586088.301), 
+    #         schema_extension_id: "e-926731d2a0", 
+    #         schema_extension_status: "Cancelled", 
+    #         schema_extension_status_reason: "Cancellation is complete. No schema updates were applied to your directory.", 
+    #         start_date_time: Time.parse(1481584463.548), 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_schema_extensions({
@@ -2848,6 +3467,26 @@ module Aws::DirectoryService
     #
     # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
     #
+    #
+    # @example Example: To list tags for a directory
+    #
+    #   # The following example lists all tags associated with a specified directory.
+    #
+    #   resp = client.list_tags_for_resource({
+    #     limit: 0, 
+    #     resource_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     tags: [
+    #       {
+    #         key: "environment", 
+    #         value: "production", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tags_for_resource({
@@ -2936,6 +3575,20 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To register an event topic
+    #
+    #   # The following example associates a directory with an SNS topic.
+    #
+    #   resp = client.register_event_topic({
+    #     directory_id: "d-92654abfed", 
+    #     topic_name: "snstopicexample", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.register_event_topic({
@@ -2993,6 +3646,22 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To remove IP routes
+    #
+    #   # The following example removes IP address blocks from a specified directory.
+    #
+    #   resp = client.remove_ip_routes({
+    #     cidr_ips: [
+    #       "12.12.12.12/32", 
+    #     ], 
+    #     directory_id: "d-92654abfed", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.remove_ip_routes({
@@ -3044,6 +3713,22 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To remove tags from a directory
+    #
+    #   # The following example removes a tag from a specified directory.
+    #
+    #   resp = client.remove_tags_from_resource({
+    #     resource_id: "d-92654abfed", 
+    #     tag_keys: [
+    #       "environment", 
+    #     ], 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.remove_tags_from_resource({
@@ -3128,6 +3813,19 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To restore a snapshot
+    #
+    #   # The following example restores a directory using an existing directory snapshot.
+    #
+    #   resp = client.restore_from_snapshot({
+    #     snapshot_id: "s-9267f6da4e", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.restore_from_snapshot({
@@ -3236,6 +3934,23 @@ module Aws::DirectoryService
     #
     #   * {Types::StartSchemaExtensionResult#schema_extension_id #schema_extension_id} => String
     #
+    #
+    # @example Example: To start a schema extension
+    #
+    #   # The following example applies a schema extension to a specified Microsoft AD directory.
+    #
+    #   resp = client.start_schema_extension({
+    #     create_snapshot_before_schema_extension: true, 
+    #     description: "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file.", 
+    #     directory_id: "d-92654abfed", 
+    #     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-", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     schema_extension_id: "e-926731dc50", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.start_schema_extension({
@@ -3313,6 +4028,23 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To update a conditional forwarder
+    #
+    #   # The following example updates a conditional forwarder for a specified directory.
+    #
+    #   resp = client.update_conditional_forwarder({
+    #     directory_id: "d-92654abfed", 
+    #     dns_ip_addrs: [
+    #       "172.168.101.11", 
+    #     ], 
+    #     remote_domain_name: "sales.example.com", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_conditional_forwarder({
@@ -3415,6 +4147,32 @@ module Aws::DirectoryService
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
+    #
+    # @example Example: To update Radius
+    #
+    #   # The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD
+    #   # Connector directory.
+    #
+    #   resp = client.update_radius({
+    #     directory_id: "d-92654abfed", 
+    #     radius_settings: {
+    #       authentication_protocol: "PAP", 
+    #       display_label: "MyRadius", 
+    #       radius_port: 1027, 
+    #       radius_retries: 1, 
+    #       radius_servers: [
+    #         "172.168.101.113", 
+    #       ], 
+    #       radius_timeout: 1, 
+    #       shared_secret: "12345678", 
+    #       use_same_username: true, 
+    #     }, 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.update_radius({
@@ -3525,6 +4283,20 @@ module Aws::DirectoryService
     #
     #   * {Types::VerifyTrustResult#trust_id #trust_id} => String
     #
+    #
+    # @example Example: To verify a trust
+    #
+    #   # The following example verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.
+    #
+    #   resp = client.verify_trust({
+    #     trust_id: "t-9267353df0", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     trust_id: "t-9267353df0", 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.verify_trust({
@@ -3562,7 +4334,7 @@ module Aws::DirectoryService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-directoryservice'
-      context[:gem_version] = '1.83.0'
+      context[:gem_version] = '1.84.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-directoryservice/types.rb

@@ -1375,7 +1375,8 @@ module Aws::DirectoryService
     # Contains the results of the DescribeDirectories operation.
     #
     # @!attribute [rw] directory_descriptions
-    #   The list of DirectoryDescription objects that were retrieved.
+    #   The list of available DirectoryDescription objects that were
+    #   retrieved.
     #
     #   It is possible that this list contains less than the number of items
     #   specified in the `Limit` member of the request. This occurs if there

data/lib/aws-sdk-directoryservice.rb

@@ -54,7 +54,7 @@ module Aws::DirectoryService
   autoload :EndpointProvider, 'aws-sdk-directoryservice/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-directoryservice/endpoints'
 
-  GEM_VERSION = '1.83.0'
+  GEM_VERSION = '1.84.0'
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-directoryservice
 version: !ruby/object:Gem::Version
-  version: 1.83.0
+  version: 1.84.0
 platform: ruby
 authors:
 - Amazon Web Services