@aws-sdk/client-directory-service 3.798.0 → 3.802.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.
Files changed (58) hide show
  1. package/dist-cjs/runtimeConfig.js +1 -0
  2. package/dist-es/runtimeConfig.js +2 -1
  3. package/dist-types/commands/AddIpRoutesCommand.d.ts +19 -0
  4. package/dist-types/commands/AddRegionCommand.d.ts +2 -2
  5. package/dist-types/commands/AddTagsToResourceCommand.d.ts +19 -0
  6. package/dist-types/commands/CancelSchemaExtensionCommand.d.ts +14 -0
  7. package/dist-types/commands/ConnectDirectoryCommand.d.ts +31 -2
  8. package/dist-types/commands/CreateAliasCommand.d.ts +17 -0
  9. package/dist-types/commands/CreateComputerCommand.d.ts +37 -0
  10. package/dist-types/commands/CreateConditionalForwarderCommand.d.ts +17 -0
  11. package/dist-types/commands/CreateDirectoryCommand.d.ts +28 -4
  12. package/dist-types/commands/CreateMicrosoftADCommand.d.ts +25 -0
  13. package/dist-types/commands/CreateSnapshotCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateTrustCommand.d.ts +22 -0
  15. package/dist-types/commands/DeleteConditionalForwarderCommand.d.ts +14 -0
  16. package/dist-types/commands/DeleteDirectoryCommand.d.ts +16 -2
  17. package/dist-types/commands/DeleteSnapshotCommand.d.ts +15 -0
  18. package/dist-types/commands/DeleteTrustCommand.d.ts +16 -0
  19. package/dist-types/commands/DeregisterCertificateCommand.d.ts +2 -2
  20. package/dist-types/commands/DeregisterEventTopicCommand.d.ts +14 -0
  21. package/dist-types/commands/DescribeCertificateCommand.d.ts +2 -1
  22. package/dist-types/commands/DescribeClientAuthenticationSettingsCommand.d.ts +4 -2
  23. package/dist-types/commands/DescribeConditionalForwardersCommand.d.ts +18 -0
  24. package/dist-types/commands/DescribeDirectoriesCommand.d.ts +46 -0
  25. package/dist-types/commands/DescribeDirectoryDataAccessCommand.d.ts +2 -1
  26. package/dist-types/commands/DescribeEventTopicsCommand.d.ts +25 -0
  27. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +27 -0
  28. package/dist-types/commands/DescribeTrustsCommand.d.ts +32 -0
  29. package/dist-types/commands/DescribeUpdateDirectoryCommand.d.ts +1 -3
  30. package/dist-types/commands/DisableDirectoryDataAccessCommand.d.ts +4 -4
  31. package/dist-types/commands/DisableRadiusCommand.d.ts +13 -0
  32. package/dist-types/commands/DisableSsoCommand.d.ts +15 -0
  33. package/dist-types/commands/EnableClientAuthenticationCommand.d.ts +2 -2
  34. package/dist-types/commands/EnableDirectoryDataAccessCommand.d.ts +3 -4
  35. package/dist-types/commands/EnableLDAPSCommand.d.ts +2 -2
  36. package/dist-types/commands/EnableRadiusCommand.d.ts +25 -0
  37. package/dist-types/commands/EnableSsoCommand.d.ts +15 -0
  38. package/dist-types/commands/GetDirectoryLimitsCommand.d.ts +23 -0
  39. package/dist-types/commands/GetSnapshotLimitsCommand.d.ts +19 -0
  40. package/dist-types/commands/ListCertificatesCommand.d.ts +2 -1
  41. package/dist-types/commands/ListIpRoutesCommand.d.ts +24 -0
  42. package/dist-types/commands/ListSchemaExtensionsCommand.d.ts +26 -0
  43. package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
  44. package/dist-types/commands/RegisterEventTopicCommand.d.ts +14 -0
  45. package/dist-types/commands/RemoveIpRoutesCommand.d.ts +16 -0
  46. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
  47. package/dist-types/commands/ResetUserPasswordCommand.d.ts +8 -7
  48. package/dist-types/commands/RestoreFromSnapshotCommand.d.ts +13 -0
  49. package/dist-types/commands/ShareDirectoryCommand.d.ts +7 -7
  50. package/dist-types/commands/StartSchemaExtensionCommand.d.ts +28 -0
  51. package/dist-types/commands/UpdateConditionalForwarderCommand.d.ts +17 -0
  52. package/dist-types/commands/UpdateDirectorySetupCommand.d.ts +2 -6
  53. package/dist-types/commands/UpdateRadiusCommand.d.ts +25 -0
  54. package/dist-types/commands/VerifyTrustCommand.d.ts +15 -0
  55. package/dist-types/models/models_0.d.ts +123 -135
  56. package/dist-types/runtimeConfig.d.ts +1 -1
  57. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -4
  58. package/package.json +5 -5
@@ -81,6 +81,31 @@ declare const DescribeEventTopicsCommand_base: {
81
81
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
82
82
  *
83
83
  *
84
+ * @example To describe event topics
85
+ * ```javascript
86
+ * // The following example obtains information about which SNS topics receive status messages from the specified directory.
87
+ * const input = {
88
+ * DirectoryId: "d-92654abfed",
89
+ * TopicNames: [
90
+ * "snstopicexample"
91
+ * ]
92
+ * };
93
+ * const command = new DescribeEventTopicsCommand(input);
94
+ * const response = await client.send(command);
95
+ * /* response is
96
+ * {
97
+ * EventTopics: [
98
+ * {
99
+ * DirectoryId: "d-92654abfed",
100
+ * Status: "Registered",
101
+ * TopicArn: "arn:aws:sns:us-east-2:123456789012:snstopicexample",
102
+ * TopicName: "snstopicexample"
103
+ * }
104
+ * ]
105
+ * }
106
+ * *\/
107
+ * ```
108
+ *
84
109
  * @public
85
110
  */
86
111
  export declare class DescribeEventTopicsCommand extends DescribeEventTopicsCommand_base {
@@ -91,6 +91,33 @@ declare const DescribeSnapshotsCommand_base: {
91
91
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
92
92
  *
93
93
  *
94
+ * @example To describe snapshots
95
+ * ```javascript
96
+ * // The following example obtains information about a specified directory snapshot.
97
+ * const input = {
98
+ * DirectoryId: "d-92654abfed",
99
+ * Limit: 0,
100
+ * SnapshotIds: [
101
+ * "s-9267f6da4e"
102
+ * ]
103
+ * };
104
+ * const command = new DescribeSnapshotsCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response is
107
+ * {
108
+ * Snapshots: [
109
+ * {
110
+ * DirectoryId: "d-92673c8a8f",
111
+ * SnapshotId: "s-9267f6da4e",
112
+ * StartTime: 1.481289211615E9,
113
+ * Status: "Completed",
114
+ * Type: "Auto"
115
+ * }
116
+ * ]
117
+ * }
118
+ * *\/
119
+ * ```
120
+ *
94
121
  * @public
95
122
  */
96
123
  export declare class DescribeSnapshotsCommand extends DescribeSnapshotsCommand_base {
@@ -95,6 +95,38 @@ declare const DescribeTrustsCommand_base: {
95
95
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
96
96
  *
97
97
  *
98
+ * @example To describe a trust
99
+ * ```javascript
100
+ * // The following example obtains information about the trust relationship for a specified directory.
101
+ * const input = {
102
+ * DirectoryId: "d-92654abfed",
103
+ * Limit: 0,
104
+ * TrustIds: [
105
+ * "t-9267353df0"
106
+ * ]
107
+ * };
108
+ * const command = new DescribeTrustsCommand(input);
109
+ * const response = await client.send(command);
110
+ * /* response is
111
+ * {
112
+ * Trusts: [
113
+ * {
114
+ * CreatedDateTime: 1.481749250657E9,
115
+ * DirectoryId: "d-92654abfed",
116
+ * LastUpdatedDateTime: 1.481749260156E9,
117
+ * RemoteDomainName: "sales.example.com",
118
+ * StateLastUpdatedDateTime: 1.481749260156E9,
119
+ * TrustDirection: "One-Way: Outgoing",
120
+ * TrustId: "t-9267353df0",
121
+ * TrustState: "Failed",
122
+ * TrustStateReason: "The specified domain either does not exist or could not be contacted. Name: sales.example.com",
123
+ * TrustType: "Forest"
124
+ * }
125
+ * ]
126
+ * }
127
+ * *\/
128
+ * ```
129
+ *
98
130
  * @public
99
131
  */
100
132
  export declare class DescribeTrustsCommand extends DescribeTrustsCommand_base {
@@ -27,9 +27,7 @@ declare const DescribeUpdateDirectoryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Describes the updates of a directory for a particular update type.
32
- * </p>
30
+ * <p> Describes the updates of a directory for a particular update type. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,7 +27,9 @@ declare const DisableDirectoryDataAccessCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deactivates access to directory data via the Directory Service Data API for the specified directory.</p>
30
+ * <p>Deactivates access to directory data via the Directory Service Data API for the specified
31
+ * directory. For
32
+ * more information, see <a href="https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html">Directory Service Data API Reference</a>.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -59,9 +61,7 @@ declare const DisableDirectoryDataAccessCommand_base: {
59
61
  * <p>The specified directory does not exist in the system.</p>
60
62
  *
61
63
  * @throws {@link DirectoryInDesiredStateException} (client fault)
62
- * <p>
63
- * The directory is already updated to desired update type settings.
64
- * </p>
64
+ * <p> The directory is already updated to desired update type settings. </p>
65
65
  *
66
66
  * @throws {@link DirectoryUnavailableException} (client fault)
67
67
  * <p>The specified directory is unavailable.</p>
@@ -63,6 +63,19 @@ declare const DisableRadiusCommand_base: {
63
63
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
64
64
  *
65
65
  *
66
+ * @example To disable radius
67
+ * ```javascript
68
+ * // The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
69
+ * const input = {
70
+ * DirectoryId: "d-92654abfed"
71
+ * };
72
+ * const command = new DisableRadiusCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response is
75
+ * { /* empty *\/ }
76
+ * *\/
77
+ * ```
78
+ *
66
79
  * @public
67
80
  */
68
81
  export declare class DisableRadiusCommand extends DisableRadiusCommand_base {
@@ -70,6 +70,21 @@ declare const DisableSsoCommand_base: {
70
70
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
71
71
  *
72
72
  *
73
+ * @example To disable SSO
74
+ * ```javascript
75
+ * // The following example disables single sign-on for a specified directory.
76
+ * const input = {
77
+ * DirectoryId: "d-92654abfed",
78
+ * Password: "Str0ngP@ssw0rd",
79
+ * UserName: "Admin"
80
+ * };
81
+ * const command = new DisableSsoCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response is
84
+ * { /* empty *\/ }
85
+ * *\/
86
+ * ```
87
+ *
73
88
  * @public
74
89
  */
75
90
  export declare class DisableSsoCommand extends DisableSsoCommand_base {
@@ -63,8 +63,8 @@ declare const EnableClientAuthenticationCommand_base: {
63
63
  * <p>Client authentication is already enabled.</p>
64
64
  *
65
65
  * @throws {@link NoAvailableCertificateException} (client fault)
66
- * <p>Client authentication setup could not be completed because at least one valid certificate must be
67
- * registered in the system.</p>
66
+ * <p>Client authentication setup could not be completed because at least one valid certificate
67
+ * must be registered in the system.</p>
68
68
  *
69
69
  * @throws {@link ServiceException} (server fault)
70
70
  * <p>An exception has occurred in Directory Service.</p>
@@ -27,7 +27,8 @@ declare const EnableDirectoryDataAccessCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Enables access to directory data via the Directory Service Data API for the specified directory.</p>
30
+ * <p>Enables access to directory data via the Directory Service Data API for the specified directory. For
31
+ * more information, see <a href="https://docs.aws.amazon.com/directoryservicedata/latest/DirectoryServiceDataAPIReference/Welcome.html">Directory Service Data API Reference</a>.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -59,9 +60,7 @@ declare const EnableDirectoryDataAccessCommand_base: {
59
60
  * <p>The specified directory does not exist in the system.</p>
60
61
  *
61
62
  * @throws {@link DirectoryInDesiredStateException} (client fault)
62
- * <p>
63
- * The directory is already updated to desired update type settings.
64
- * </p>
63
+ * <p> The directory is already updated to desired update type settings. </p>
65
64
  *
66
65
  * @throws {@link DirectoryUnavailableException} (client fault)
67
66
  * <p>The specified directory is unavailable.</p>
@@ -67,8 +67,8 @@ declare const EnableLDAPSCommand_base: {
67
67
  * <p>One or more parameters are not valid.</p>
68
68
  *
69
69
  * @throws {@link NoAvailableCertificateException} (client fault)
70
- * <p>Client authentication setup could not be completed because at least one valid certificate must be
71
- * registered in the system.</p>
70
+ * <p>Client authentication setup could not be completed because at least one valid certificate
71
+ * must be registered in the system.</p>
72
72
  *
73
73
  * @throws {@link ServiceException} (server fault)
74
74
  * <p>An exception has occurred in Directory Service.</p>
@@ -81,6 +81,31 @@ declare const EnableRadiusCommand_base: {
81
81
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
82
82
  *
83
83
  *
84
+ * @example To enable radius
85
+ * ```javascript
86
+ * // The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.
87
+ * const input = {
88
+ * DirectoryId: "d-92654abfed",
89
+ * RadiusSettings: {
90
+ * AuthenticationProtocol: "PAP",
91
+ * DisplayLabel: "MyRadius",
92
+ * RadiusPort: 1200,
93
+ * RadiusRetries: 2,
94
+ * RadiusServers: [
95
+ * "172.168.111.12"
96
+ * ],
97
+ * RadiusTimeout: 1,
98
+ * SharedSecret: "123456789",
99
+ * UseSameUsername: true
100
+ * }
101
+ * };
102
+ * const command = new EnableRadiusCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response is
105
+ * { /* empty *\/ }
106
+ * *\/
107
+ * ```
108
+ *
84
109
  * @public
85
110
  */
86
111
  export declare class EnableRadiusCommand extends EnableRadiusCommand_base {
@@ -72,6 +72,21 @@ declare const EnableSsoCommand_base: {
72
72
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
73
73
  *
74
74
  *
75
+ * @example To enable SSO
76
+ * ```javascript
77
+ * // To enable single sign-on for a specified directory.
78
+ * const input = {
79
+ * DirectoryId: "d-92654abfed",
80
+ * Password: "Str0ngP@ssw0rd",
81
+ * UserName: "Admin"
82
+ * };
83
+ * const command = new EnableSsoCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response is
86
+ * { /* empty *\/ }
87
+ * *\/
88
+ * ```
89
+ *
75
90
  * @public
76
91
  */
77
92
  export declare class EnableSsoCommand extends EnableSsoCommand_base {
@@ -72,6 +72,29 @@ declare const GetDirectoryLimitsCommand_base: {
72
72
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
73
73
  *
74
74
  *
75
+ * @example To get directory limits
76
+ * ```javascript
77
+ * // The following example obtains directory limit information for the current region.
78
+ * const input = { /* empty *\/ };
79
+ * const command = new GetDirectoryLimitsCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response is
82
+ * {
83
+ * DirectoryLimits: {
84
+ * CloudOnlyDirectoriesCurrentCount: 2,
85
+ * CloudOnlyDirectoriesLimit: 10,
86
+ * CloudOnlyDirectoriesLimitReached: false,
87
+ * CloudOnlyMicrosoftADCurrentCount: 2,
88
+ * CloudOnlyMicrosoftADLimit: 10,
89
+ * CloudOnlyMicrosoftADLimitReached: false,
90
+ * ConnectedDirectoriesCurrentCount: 1,
91
+ * ConnectedDirectoriesLimit: 10,
92
+ * ConnectedDirectoriesLimitReached: false
93
+ * }
94
+ * }
95
+ * *\/
96
+ * ```
97
+ *
75
98
  * @public
76
99
  */
77
100
  export declare class GetDirectoryLimitsCommand extends GetDirectoryLimitsCommand_base {
@@ -68,6 +68,25 @@ declare const GetSnapshotLimitsCommand_base: {
68
68
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
69
69
  *
70
70
  *
71
+ * @example To get snapshot limits
72
+ * ```javascript
73
+ * // The following example obtains the manual snapshot limits for a specified directory.
74
+ * const input = {
75
+ * DirectoryId: "d-92654abfed"
76
+ * };
77
+ * const command = new GetSnapshotLimitsCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response is
80
+ * {
81
+ * SnapshotLimits: {
82
+ * ManualSnapshotsCurrentCount: 1,
83
+ * ManualSnapshotsLimit: 5,
84
+ * ManualSnapshotsLimitReached: false
85
+ * }
86
+ * }
87
+ * *\/
88
+ * ```
89
+ *
71
90
  * @public
72
91
  */
73
92
  export declare class GetSnapshotLimitsCommand extends GetSnapshotLimitsCommand_base {
@@ -27,7 +27,8 @@ declare const ListCertificatesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.</p>
30
+ * <p>For the specified directory, lists all the certificates registered for a secure LDAP or
31
+ * client certificate authentication.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -82,6 +82,30 @@ declare const ListIpRoutesCommand_base: {
82
82
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
83
83
  *
84
84
  *
85
+ * @example To list IP routes
86
+ * ```javascript
87
+ * // The following example lists the address blocks that have been added to a specified directory.
88
+ * const input = {
89
+ * DirectoryId: "d-92654abfed",
90
+ * Limit: 0
91
+ * };
92
+ * const command = new ListIpRoutesCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response is
95
+ * {
96
+ * IpRoutesInfo: [
97
+ * {
98
+ * AddedDateTime: 1.48157763163E9,
99
+ * CidrIp: "12.12.12.12/32",
100
+ * Description: "example",
101
+ * DirectoryId: "d-92654abfed",
102
+ * IpRouteStatusMsg: "Added"
103
+ * }
104
+ * ]
105
+ * }
106
+ * *\/
107
+ * ```
108
+ *
85
109
  * @public
86
110
  */
87
111
  export declare class ListIpRoutesCommand extends ListIpRoutesCommand_base {
@@ -80,6 +80,32 @@ declare const ListSchemaExtensionsCommand_base: {
80
80
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
81
81
  *
82
82
  *
83
+ * @example To list schema extensions
84
+ * ```javascript
85
+ * // The following example lists all schema extensions applied to a specified Microsoft AD Directory.
86
+ * const input = {
87
+ * DirectoryId: "d-92654abfed",
88
+ * Limit: 0
89
+ * };
90
+ * const command = new ListSchemaExtensionsCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response is
93
+ * {
94
+ * SchemaExtensionsInfo: [
95
+ * {
96
+ * Description: "example text",
97
+ * DirectoryId: "d-92654abfed",
98
+ * EndDateTime: 1.481586088301E9,
99
+ * SchemaExtensionId: "e-926731d2a0",
100
+ * SchemaExtensionStatus: "Cancelled",
101
+ * SchemaExtensionStatusReason: "Cancellation is complete. No schema updates were applied to your directory.",
102
+ * StartDateTime: 1.481584463548E9
103
+ * }
104
+ * ]
105
+ * }
106
+ * *\/
107
+ * ```
108
+ *
83
109
  * @public
84
110
  */
85
111
  export declare class ListSchemaExtensionsCommand extends ListSchemaExtensionsCommand_base {
@@ -78,6 +78,27 @@ declare const ListTagsForResourceCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
79
79
  *
80
80
  *
81
+ * @example To list tags for a directory
82
+ * ```javascript
83
+ * // The following example lists all tags associated with a specified directory.
84
+ * const input = {
85
+ * Limit: 0,
86
+ * ResourceId: "d-92654abfed"
87
+ * };
88
+ * const command = new ListTagsForResourceCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response is
91
+ * {
92
+ * Tags: [
93
+ * {
94
+ * Key: "environment",
95
+ * Value: "production"
96
+ * }
97
+ * ]
98
+ * }
99
+ * *\/
100
+ * ```
101
+ *
81
102
  * @public
82
103
  */
83
104
  export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
@@ -70,6 +70,20 @@ declare const RegisterEventTopicCommand_base: {
70
70
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
71
71
  *
72
72
  *
73
+ * @example To register an event topic
74
+ * ```javascript
75
+ * // The following example associates a directory with an SNS topic.
76
+ * const input = {
77
+ * DirectoryId: "d-92654abfed",
78
+ * TopicName: "snstopicexample"
79
+ * };
80
+ * const command = new RegisterEventTopicCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response is
83
+ * { /* empty *\/ }
84
+ * *\/
85
+ * ```
86
+ *
73
87
  * @public
74
88
  */
75
89
  export declare class RegisterEventTopicCommand extends RegisterEventTopicCommand_base {
@@ -71,6 +71,22 @@ declare const RemoveIpRoutesCommand_base: {
71
71
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
72
72
  *
73
73
  *
74
+ * @example To remove IP routes
75
+ * ```javascript
76
+ * // The following example removes IP address blocks from a specified directory.
77
+ * const input = {
78
+ * CidrIps: [
79
+ * "12.12.12.12/32"
80
+ * ],
81
+ * DirectoryId: "d-92654abfed"
82
+ * };
83
+ * const command = new RemoveIpRoutesCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response is
86
+ * { /* empty *\/ }
87
+ * *\/
88
+ * ```
89
+ *
74
90
  * @public
75
91
  */
76
92
  export declare class RemoveIpRoutesCommand extends RemoveIpRoutesCommand_base {
@@ -68,6 +68,22 @@ declare const RemoveTagsFromResourceCommand_base: {
68
68
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
69
69
  *
70
70
  *
71
+ * @example To remove tags from a directory
72
+ * ```javascript
73
+ * // The following example removes a tag from a specified directory.
74
+ * const input = {
75
+ * ResourceId: "d-92654abfed",
76
+ * TagKeys: [
77
+ * "environment"
78
+ * ]
79
+ * };
80
+ * const command = new RemoveTagsFromResourceCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response is
83
+ * { /* empty *\/ }
84
+ * *\/
85
+ * ```
86
+ *
71
87
  * @public
72
88
  */
73
89
  export declare class RemoveTagsFromResourceCommand extends RemoveTagsFromResourceCommand_base {
@@ -27,8 +27,8 @@ declare const ResetUserPasswordCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Resets the password for any user in your Managed Microsoft AD or Simple AD
31
- * directory. Disabled users will become enabled and can be authenticated following the API call.</p>
30
+ * <p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled
31
+ * users will become enabled and can be authenticated following the API call.</p>
32
32
  * <p>You can reset the password for any user in your directory with the following
33
33
  * exceptions:</p>
34
34
  * <ul>
@@ -38,11 +38,12 @@ declare const ResetUserPasswordCommand_base: {
38
38
  * Admins</b> group except for the administrator user.</p>
39
39
  * </li>
40
40
  * <li>
41
- * <p>For Managed Microsoft AD, you can only reset the password for a user that is in an
42
- * OU based off of the NetBIOS name that you typed when you created your directory. For
43
- * example, you cannot reset the password for a user in the <b>Amazon Web Services
44
- * 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
45
- * Guide</i>.</p>
41
+ * <p>For Managed Microsoft AD, you can only reset the password for a user that is in an OU based
42
+ * off of the NetBIOS name that you typed when you created your directory. For example, you
43
+ * cannot reset the password for a user in the <b>Amazon Web Services
44
+ * Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD
45
+ * 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
46
+ * Guide</i>.</p>
46
47
  * </li>
47
48
  * </ul>
48
49
  * @example
@@ -70,6 +70,19 @@ declare const RestoreFromSnapshotCommand_base: {
70
70
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
71
71
  *
72
72
  *
73
+ * @example To restore a snapshot
74
+ * ```javascript
75
+ * // The following example restores a directory using an existing directory snapshot.
76
+ * const input = {
77
+ * SnapshotId: "s-9267f6da4e"
78
+ * };
79
+ * const command = new RestoreFromSnapshotCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response is
82
+ * { /* empty *\/ }
83
+ * *\/
84
+ * ```
85
+ *
73
86
  * @public
74
87
  */
75
88
  export declare class RestoreFromSnapshotCommand extends RestoreFromSnapshotCommand_base {
@@ -30,14 +30,14 @@ declare const ShareDirectoryCommand_base: {
30
30
  * <p>Shares a specified directory (<code>DirectoryId</code>) in your Amazon Web Services account (directory
31
31
  * owner) with another Amazon Web Services account (directory consumer). With this operation you can use your
32
32
  * directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.</p>
33
- * <p>When you share your Managed Microsoft AD directory, Directory Service creates a
34
- * shared directory in the directory consumer account. This shared directory contains the
35
- * metadata to provide access to the directory within the directory owner account. The shared
36
- * directory is visible in all VPCs in the directory consumer account.</p>
33
+ * <p>When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the
34
+ * directory consumer account. This shared directory contains the metadata to provide access to
35
+ * the directory within the directory owner account. The shared directory is visible in all VPCs
36
+ * in the directory consumer account.</p>
37
37
  * <p>The <code>ShareMethod</code> parameter determines whether the specified directory can be
38
- * shared between Amazon Web Services accounts inside the same Amazon Web Services organization (<code>ORGANIZATIONS</code>). It
39
- * also determines whether you can share the directory with any other Amazon Web Services account either inside
40
- * or outside of the organization (<code>HANDSHAKE</code>).</p>
38
+ * shared between Amazon Web Services accounts inside the same Amazon Web Services organization (<code>ORGANIZATIONS</code>).
39
+ * It also determines whether you can share the directory with any other Amazon Web Services account either
40
+ * inside or outside of the organization (<code>HANDSHAKE</code>).</p>
41
41
  * <p>The <code>ShareNotes</code> parameter is only used when <code>HANDSHAKE</code> is called,
42
42
  * which sends a directory sharing request to the directory consumer. </p>
43
43
  * @example
@@ -78,6 +78,34 @@ declare const StartSchemaExtensionCommand_base: {
78
78
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
79
79
  *
80
80
  *
81
+ * @example To start a schema extension
82
+ * ```javascript
83
+ * // The following example applies a schema extension to a specified Microsoft AD directory.
84
+ * const input = {
85
+ * CreateSnapshotBeforeSchemaExtension: true,
86
+ * Description: "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file.",
87
+ * DirectoryId: "d-92654abfed",
88
+ * LdifContent: "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com
89
+ * changetype: modify
90
+ * add: mayContain
91
+ * mayContain: drink
92
+ * -
93
+ *
94
+ * DN:
95
+ * changetype: modify
96
+ * replace: schemaupdatenow
97
+ * schemaupdatenow: 1
98
+ * -"
99
+ * };
100
+ * const command = new StartSchemaExtensionCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response is
103
+ * {
104
+ * SchemaExtensionId: "e-926731dc50"
105
+ * }
106
+ * *\/
107
+ * ```
108
+ *
81
109
  * @public
82
110
  */
83
111
  export declare class StartSchemaExtensionCommand extends StartSchemaExtensionCommand_base {
@@ -76,6 +76,23 @@ declare const UpdateConditionalForwarderCommand_base: {
76
76
  * <p>Base exception class for all service exceptions from DirectoryService service.</p>
77
77
  *
78
78
  *
79
+ * @example To update a conditional forwarder
80
+ * ```javascript
81
+ * // The following example updates a conditional forwarder for a specified directory.
82
+ * const input = {
83
+ * DirectoryId: "d-92654abfed",
84
+ * DnsIpAddrs: [
85
+ * "172.168.101.11"
86
+ * ],
87
+ * RemoteDomainName: "sales.example.com"
88
+ * };
89
+ * const command = new UpdateConditionalForwarderCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response is
92
+ * { /* empty *\/ }
93
+ * *\/
94
+ * ```
95
+ *
79
96
  * @public
80
97
  */
81
98
  export declare class UpdateConditionalForwarderCommand extends UpdateConditionalForwarderCommand_base {