@aws-sdk/client-directory-service 3.799.0 → 3.803.0

package/dist-types/commands/DescribeSnapshotsCommand.d.ts

@@ -91,6 +91,33 @@ declare const DescribeSnapshotsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To describe snapshots
+ * ```javascript
+ * // The following example obtains information about a specified directory snapshot.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Limit: 0,
+ *   SnapshotIds: [
+ *     "s-9267f6da4e"
+ *   ]
+ * };
+ * const command = new DescribeSnapshotsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Snapshots: [
+ *     {
+ *       DirectoryId: "d-92673c8a8f",
+ *       SnapshotId: "s-9267f6da4e",
+ *       StartTime: 1.481289211615E9,
+ *       Status: "Completed",
+ *       Type: "Auto"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeSnapshotsCommand extends DescribeSnapshotsCommand_base {

package/dist-types/commands/DescribeTrustsCommand.d.ts

@@ -95,6 +95,38 @@ declare const DescribeTrustsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To describe a trust
+ * ```javascript
+ * // The following example obtains information about the trust relationship for a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Limit: 0,
+ *   TrustIds: [
+ *     "t-9267353df0"
+ *   ]
+ * };
+ * const command = new DescribeTrustsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Trusts: [
+ *     {
+ *       CreatedDateTime: 1.481749250657E9,
+ *       DirectoryId: "d-92654abfed",
+ *       LastUpdatedDateTime: 1.481749260156E9,
+ *       RemoteDomainName: "sales.example.com",
+ *       StateLastUpdatedDateTime: 1.481749260156E9,
+ *       TrustDirection: "One-Way: Outgoing",
+ *       TrustId: "t-9267353df0",
+ *       TrustState: "Failed",
+ *       TrustStateReason: "The specified domain either does not exist or could not be contacted. Name: sales.example.com",
+ *       TrustType: "Forest"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeTrustsCommand extends DescribeTrustsCommand_base {

package/dist-types/commands/DescribeUpdateDirectoryCommand.d.ts

@@ -27,9 +27,7 @@ declare const DescribeUpdateDirectoryCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>
- *       Describes the updates of a directory for a particular update type.
- *     </p>
+ * <p> Describes the updates of a directory for a particular update type. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DisableDirectoryDataAccessCommand.d.ts

@@ -27,7 +27,9 @@ declare const DisableDirectoryDataAccessCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deactivates access to directory data via the Directory Service Data API for the specified directory.</p>
+ * <p>Deactivates access to directory data via the Directory Service Data API for the specified
+ *       directory. For
+ *       more information, see <a href="https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html">Directory Service Data API Reference</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,9 +61,7 @@ declare const DisableDirectoryDataAccessCommand_base: {
  *  <p>The specified directory does not exist in the system.</p>
  *
  * @throws {@link DirectoryInDesiredStateException} (client fault)
- *  <p>
- *       The directory is already updated to desired update type settings.
- *     </p>
+ *  <p> The directory is already updated to desired update type settings. </p>
  *
  * @throws {@link DirectoryUnavailableException} (client fault)
  *  <p>The specified directory is unavailable.</p>

package/dist-types/commands/DisableRadiusCommand.d.ts

@@ -63,6 +63,19 @@ declare const DisableRadiusCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To disable radius
+ * ```javascript
+ * // The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed"
+ * };
+ * const command = new DisableRadiusCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DisableRadiusCommand extends DisableRadiusCommand_base {

package/dist-types/commands/DisableSsoCommand.d.ts

@@ -70,6 +70,21 @@ declare const DisableSsoCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To disable SSO
+ * ```javascript
+ * // The following example disables single sign-on for a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Password: "Str0ngP@ssw0rd",
+ *   UserName: "Admin"
+ * };
+ * const command = new DisableSsoCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DisableSsoCommand extends DisableSsoCommand_base {

package/dist-types/commands/EnableClientAuthenticationCommand.d.ts

@@ -63,8 +63,8 @@ declare const EnableClientAuthenticationCommand_base: {
  *  <p>Client authentication is already enabled.</p>
  *
  * @throws {@link NoAvailableCertificateException} (client fault)
- *  <p>Client authentication setup could not be completed because at least one valid certificate must be
- *       registered in the system.</p>
+ *  <p>Client authentication setup could not be completed because at least one valid certificate
+ *       must be registered in the system.</p>
  *
  * @throws {@link ServiceException} (server fault)
  *  <p>An exception has occurred in Directory Service.</p>

package/dist-types/commands/EnableDirectoryDataAccessCommand.d.ts

@@ -27,7 +27,8 @@ declare const EnableDirectoryDataAccessCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Enables access to directory data via the Directory Service Data API for the specified directory.</p>
+ * <p>Enables access to directory data via the Directory Service Data API for the specified directory. For
+ *       more information, see <a href="https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html">Directory Service Data API Reference</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,9 +60,7 @@ declare const EnableDirectoryDataAccessCommand_base: {
  *  <p>The specified directory does not exist in the system.</p>
  *
  * @throws {@link DirectoryInDesiredStateException} (client fault)
- *  <p>
- *       The directory is already updated to desired update type settings.
- *     </p>
+ *  <p> The directory is already updated to desired update type settings. </p>
  *
  * @throws {@link DirectoryUnavailableException} (client fault)
  *  <p>The specified directory is unavailable.</p>

package/dist-types/commands/EnableLDAPSCommand.d.ts

@@ -67,8 +67,8 @@ declare const EnableLDAPSCommand_base: {
  *  <p>One or more parameters are not valid.</p>
  *
  * @throws {@link NoAvailableCertificateException} (client fault)
- *  <p>Client authentication setup could not be completed because at least one valid certificate must be
- *       registered in the system.</p>
+ *  <p>Client authentication setup could not be completed because at least one valid certificate
+ *       must be registered in the system.</p>
  *
  * @throws {@link ServiceException} (server fault)
  *  <p>An exception has occurred in Directory Service.</p>

package/dist-types/commands/EnableRadiusCommand.d.ts

@@ -81,6 +81,31 @@ declare const EnableRadiusCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To enable radius
+ * ```javascript
+ * // The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   RadiusSettings: {
+ *     AuthenticationProtocol: "PAP",
+ *     DisplayLabel: "MyRadius",
+ *     RadiusPort: 1200,
+ *     RadiusRetries: 2,
+ *     RadiusServers: [
+ *       "172.168.111.12"
+ *     ],
+ *     RadiusTimeout: 1,
+ *     SharedSecret: "123456789",
+ *     UseSameUsername: true
+ *   }
+ * };
+ * const command = new EnableRadiusCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class EnableRadiusCommand extends EnableRadiusCommand_base {

package/dist-types/commands/EnableSsoCommand.d.ts

@@ -72,6 +72,21 @@ declare const EnableSsoCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To enable SSO
+ * ```javascript
+ * // To enable single sign-on for a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Password: "Str0ngP@ssw0rd",
+ *   UserName: "Admin"
+ * };
+ * const command = new EnableSsoCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class EnableSsoCommand extends EnableSsoCommand_base {

package/dist-types/commands/GetDirectoryLimitsCommand.d.ts

@@ -72,6 +72,29 @@ declare const GetDirectoryLimitsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To get directory limits
+ * ```javascript
+ * // The following example obtains directory limit information for the current region.
+ * const input = { /* empty *\/ };
+ * const command = new GetDirectoryLimitsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryLimits: {
+ *     CloudOnlyDirectoriesCurrentCount: 2,
+ *     CloudOnlyDirectoriesLimit: 10,
+ *     CloudOnlyDirectoriesLimitReached: false,
+ *     CloudOnlyMicrosoftADCurrentCount: 2,
+ *     CloudOnlyMicrosoftADLimit: 10,
+ *     CloudOnlyMicrosoftADLimitReached: false,
+ *     ConnectedDirectoriesCurrentCount: 1,
+ *     ConnectedDirectoriesLimit: 10,
+ *     ConnectedDirectoriesLimitReached: false
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetDirectoryLimitsCommand extends GetDirectoryLimitsCommand_base {

package/dist-types/commands/GetSnapshotLimitsCommand.d.ts

@@ -68,6 +68,25 @@ declare const GetSnapshotLimitsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To get snapshot limits
+ * ```javascript
+ * // The following example obtains the manual snapshot limits for a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed"
+ * };
+ * const command = new GetSnapshotLimitsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   SnapshotLimits: {
+ *     ManualSnapshotsCurrentCount: 1,
+ *     ManualSnapshotsLimit: 5,
+ *     ManualSnapshotsLimitReached: false
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetSnapshotLimitsCommand extends GetSnapshotLimitsCommand_base {

package/dist-types/commands/ListCertificatesCommand.d.ts

@@ -27,7 +27,8 @@ declare const ListCertificatesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.</p>
+ * <p>For the specified directory, lists all the certificates registered for a secure LDAP or
+ *       client certificate authentication.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListIpRoutesCommand.d.ts

@@ -82,6 +82,30 @@ declare const ListIpRoutesCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To list IP routes
+ * ```javascript
+ * // The following example lists the address blocks that have been added to a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Limit: 0
+ * };
+ * const command = new ListIpRoutesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   IpRoutesInfo: [
+ *     {
+ *       AddedDateTime: 1.48157763163E9,
+ *       CidrIp: "12.12.12.12/32",
+ *       Description: "example",
+ *       DirectoryId: "d-92654abfed",
+ *       IpRouteStatusMsg: "Added"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListIpRoutesCommand extends ListIpRoutesCommand_base {

package/dist-types/commands/ListSchemaExtensionsCommand.d.ts

@@ -80,6 +80,32 @@ declare const ListSchemaExtensionsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To list schema extensions
+ * ```javascript
+ * // The following example lists all schema extensions applied to a specified Microsoft AD Directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   Limit: 0
+ * };
+ * const command = new ListSchemaExtensionsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   SchemaExtensionsInfo: [
+ *     {
+ *       Description: "example text",
+ *       DirectoryId: "d-92654abfed",
+ *       EndDateTime: 1.481586088301E9,
+ *       SchemaExtensionId: "e-926731d2a0",
+ *       SchemaExtensionStatus: "Cancelled",
+ *       SchemaExtensionStatusReason: "Cancellation is complete. No schema updates were applied to your directory.",
+ *       StartDateTime: 1.481584463548E9
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListSchemaExtensionsCommand extends ListSchemaExtensionsCommand_base {

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -78,6 +78,27 @@ declare const ListTagsForResourceCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To list tags for a directory
+ * ```javascript
+ * // The following example lists all tags associated with a specified directory.
+ * const input = {
+ *   Limit: 0,
+ *   ResourceId: "d-92654abfed"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Tags: [
+ *     {
+ *       Key: "environment",
+ *       Value: "production"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

package/dist-types/commands/RegisterEventTopicCommand.d.ts

@@ -70,6 +70,20 @@ declare const RegisterEventTopicCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To register an event topic
+ * ```javascript
+ * // The following example associates a directory with an SNS topic.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   TopicName: "snstopicexample"
+ * };
+ * const command = new RegisterEventTopicCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class RegisterEventTopicCommand extends RegisterEventTopicCommand_base {

package/dist-types/commands/RemoveIpRoutesCommand.d.ts

@@ -71,6 +71,22 @@ declare const RemoveIpRoutesCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To remove IP routes
+ * ```javascript
+ * // The following example removes IP address blocks from a specified directory.
+ * const input = {
+ *   CidrIps: [
+ *     "12.12.12.12/32"
+ *   ],
+ *   DirectoryId: "d-92654abfed"
+ * };
+ * const command = new RemoveIpRoutesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class RemoveIpRoutesCommand extends RemoveIpRoutesCommand_base {

package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts

@@ -68,6 +68,22 @@ declare const RemoveTagsFromResourceCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To remove tags from a directory
+ * ```javascript
+ * // The following example removes a tag from a specified directory.
+ * const input = {
+ *   ResourceId: "d-92654abfed",
+ *   TagKeys: [
+ *     "environment"
+ *   ]
+ * };
+ * const command = new RemoveTagsFromResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class RemoveTagsFromResourceCommand extends RemoveTagsFromResourceCommand_base {

package/dist-types/commands/ResetUserPasswordCommand.d.ts

@@ -27,8 +27,8 @@ declare const ResetUserPasswordCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Resets the password for any user in your Managed Microsoft AD or Simple AD
- *       directory. Disabled users will become enabled and can be authenticated following the API call.</p>
+ * <p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled
+ *       users will become enabled and can be authenticated following the API call.</p>
  *          <p>You can reset the password for any user in your directory with the following
  *       exceptions:</p>
  *          <ul>
@@ -38,11 +38,12 @@ declare const ResetUserPasswordCommand_base: {
  *             Admins</b> group except for the administrator user.</p>
  *             </li>
  *             <li>
- *                <p>For Managed Microsoft AD, you can only reset the password for a user that is in an
- *           OU based off of the NetBIOS name that you typed when you created your directory. For
- *           example, you cannot reset the password for a user in the <b>Amazon Web Services
- *             Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD directory, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html">What Gets Created</a> in the <i>Directory Service Administration
- *             Guide</i>.</p>
+ *                <p>For Managed Microsoft AD, you can only reset the password for a user that is in an OU based
+ *           off of the NetBIOS name that you typed when you created your directory. For example, you
+ *           cannot reset the password for a user in the <b>Amazon Web Services
+ *             Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD
+ *           directory, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html">What Gets Created</a> in the <i>Directory Service Administration
+ *           Guide</i>.</p>
  *             </li>
  *          </ul>
  * @example

package/dist-types/commands/RestoreFromSnapshotCommand.d.ts

@@ -70,6 +70,19 @@ declare const RestoreFromSnapshotCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To restore a snapshot
+ * ```javascript
+ * // The following example restores a directory using an existing directory snapshot.
+ * const input = {
+ *   SnapshotId: "s-9267f6da4e"
+ * };
+ * const command = new RestoreFromSnapshotCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class RestoreFromSnapshotCommand extends RestoreFromSnapshotCommand_base {

package/dist-types/commands/ShareDirectoryCommand.d.ts

@@ -30,14 +30,14 @@ declare const ShareDirectoryCommand_base: {
  * <p>Shares a specified directory (<code>DirectoryId</code>) in your Amazon Web Services account (directory
  *       owner) with another Amazon Web Services account (directory consumer). With this operation you can use your
  *       directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.</p>
- *          <p>When you share your Managed Microsoft AD directory, Directory Service creates a
- *       shared directory in the directory consumer account. This shared directory contains the
- *       metadata to provide access to the directory within the directory owner account. The shared
- *       directory is visible in all VPCs in the directory consumer account.</p>
+ *          <p>When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the
+ *       directory consumer account. This shared directory contains the metadata to provide access to
+ *       the directory within the directory owner account. The shared directory is visible in all VPCs
+ *       in the directory consumer account.</p>
  *          <p>The <code>ShareMethod</code> parameter determines whether the specified directory can be
- *       shared between Amazon Web Services accounts inside the same Amazon Web Services organization (<code>ORGANIZATIONS</code>). It
- *       also determines whether you can share the directory with any other Amazon Web Services account either inside
- *       or outside of the organization (<code>HANDSHAKE</code>).</p>
+ *       shared between Amazon Web Services accounts inside the same Amazon Web Services organization (<code>ORGANIZATIONS</code>).
+ *       It also determines whether you can share the directory with any other Amazon Web Services account either
+ *       inside or outside of the organization (<code>HANDSHAKE</code>).</p>
  *          <p>The <code>ShareNotes</code> parameter is only used when <code>HANDSHAKE</code> is called,
  *       which sends a directory sharing request to the directory consumer. </p>
  * @example

package/dist-types/commands/StartSchemaExtensionCommand.d.ts

@@ -78,6 +78,34 @@ declare const StartSchemaExtensionCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To start a schema extension
+ * ```javascript
+ * // The following example applies a schema extension to a specified Microsoft AD directory.
+ * const input = {
+ *   CreateSnapshotBeforeSchemaExtension: true,
+ *   Description: "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file.",
+ *   DirectoryId: "d-92654abfed",
+ *   LdifContent: "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com
+ * changetype: modify
+ * add: mayContain
+ * mayContain: drink
+ * -
+ *
+ * DN:
+ * changetype: modify
+ * replace: schemaupdatenow
+ * schemaupdatenow: 1
+ * -"
+ * };
+ * const command = new StartSchemaExtensionCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   SchemaExtensionId: "e-926731dc50"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class StartSchemaExtensionCommand extends StartSchemaExtensionCommand_base {

package/dist-types/commands/UpdateConditionalForwarderCommand.d.ts

@@ -76,6 +76,23 @@ declare const UpdateConditionalForwarderCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
  *
  *
+ * @example To update a conditional forwarder
+ * ```javascript
+ * // The following example updates a conditional forwarder for a specified directory.
+ * const input = {
+ *   DirectoryId: "d-92654abfed",
+ *   DnsIpAddrs: [
+ *     "172.168.101.11"
+ *   ],
+ *   RemoteDomainName: "sales.example.com"
+ * };
+ * const command = new UpdateConditionalForwarderCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateConditionalForwarderCommand extends UpdateConditionalForwarderCommand_base {

package/dist-types/commands/UpdateDirectorySetupCommand.d.ts

@@ -27,9 +27,7 @@ declare const UpdateDirectorySetupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>
- *       Updates the directory for a particular update type.
- *     </p>
+ * <p> Updates the directory for a particular update type. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,9 +64,7 @@ declare const UpdateDirectorySetupCommand_base: {
  *  <p>The specified directory does not exist in the system.</p>
  *
  * @throws {@link DirectoryInDesiredStateException} (client fault)
- *  <p>
- *       The directory is already updated to desired update type settings.
- *     </p>
+ *  <p> The directory is already updated to desired update type settings. </p>
  *
  * @throws {@link DirectoryUnavailableException} (client fault)
  *  <p>The specified directory is unavailable.</p>