@aws-sdk/client-directory-service 3.799.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.
- package/dist-types/commands/AddIpRoutesCommand.d.ts +19 -0
- package/dist-types/commands/AddRegionCommand.d.ts +2 -2
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +19 -0
- package/dist-types/commands/CancelSchemaExtensionCommand.d.ts +14 -0
- package/dist-types/commands/ConnectDirectoryCommand.d.ts +31 -2
- package/dist-types/commands/CreateAliasCommand.d.ts +17 -0
- package/dist-types/commands/CreateComputerCommand.d.ts +37 -0
- package/dist-types/commands/CreateConditionalForwarderCommand.d.ts +17 -0
- package/dist-types/commands/CreateDirectoryCommand.d.ts +28 -4
- package/dist-types/commands/CreateMicrosoftADCommand.d.ts +25 -0
- package/dist-types/commands/CreateSnapshotCommand.d.ts +16 -0
- package/dist-types/commands/CreateTrustCommand.d.ts +22 -0
- package/dist-types/commands/DeleteConditionalForwarderCommand.d.ts +14 -0
- package/dist-types/commands/DeleteDirectoryCommand.d.ts +16 -2
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +15 -0
- package/dist-types/commands/DeleteTrustCommand.d.ts +16 -0
- package/dist-types/commands/DeregisterCertificateCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterEventTopicCommand.d.ts +14 -0
- package/dist-types/commands/DescribeCertificateCommand.d.ts +2 -1
- package/dist-types/commands/DescribeClientAuthenticationSettingsCommand.d.ts +4 -2
- package/dist-types/commands/DescribeConditionalForwardersCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDirectoriesCommand.d.ts +46 -0
- package/dist-types/commands/DescribeDirectoryDataAccessCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEventTopicsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +27 -0
- package/dist-types/commands/DescribeTrustsCommand.d.ts +32 -0
- package/dist-types/commands/DescribeUpdateDirectoryCommand.d.ts +1 -3
- package/dist-types/commands/DisableDirectoryDataAccessCommand.d.ts +4 -4
- package/dist-types/commands/DisableRadiusCommand.d.ts +13 -0
- package/dist-types/commands/DisableSsoCommand.d.ts +15 -0
- package/dist-types/commands/EnableClientAuthenticationCommand.d.ts +2 -2
- package/dist-types/commands/EnableDirectoryDataAccessCommand.d.ts +3 -4
- package/dist-types/commands/EnableLDAPSCommand.d.ts +2 -2
- package/dist-types/commands/EnableRadiusCommand.d.ts +25 -0
- package/dist-types/commands/EnableSsoCommand.d.ts +15 -0
- package/dist-types/commands/GetDirectoryLimitsCommand.d.ts +23 -0
- package/dist-types/commands/GetSnapshotLimitsCommand.d.ts +19 -0
- package/dist-types/commands/ListCertificatesCommand.d.ts +2 -1
- package/dist-types/commands/ListIpRoutesCommand.d.ts +24 -0
- package/dist-types/commands/ListSchemaExtensionsCommand.d.ts +26 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
- package/dist-types/commands/RegisterEventTopicCommand.d.ts +14 -0
- package/dist-types/commands/RemoveIpRoutesCommand.d.ts +16 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +16 -0
- package/dist-types/commands/ResetUserPasswordCommand.d.ts +8 -7
- package/dist-types/commands/RestoreFromSnapshotCommand.d.ts +13 -0
- package/dist-types/commands/ShareDirectoryCommand.d.ts +7 -7
- package/dist-types/commands/StartSchemaExtensionCommand.d.ts +28 -0
- package/dist-types/commands/UpdateConditionalForwarderCommand.d.ts +17 -0
- package/dist-types/commands/UpdateDirectorySetupCommand.d.ts +2 -6
- package/dist-types/commands/UpdateRadiusCommand.d.ts +25 -0
- package/dist-types/commands/VerifyTrustCommand.d.ts +15 -0
- package/dist-types/models/models_0.d.ts +123 -135
- package/package.json +1 -1
|
@@ -89,6 +89,25 @@ declare const AddIpRoutesCommand_base: {
|
|
|
89
89
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
90
90
|
*
|
|
91
91
|
*
|
|
92
|
+
* @example To add a CIDR address block that routes traffic for Microsoft AD
|
|
93
|
+
* ```javascript
|
|
94
|
+
* // The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.
|
|
95
|
+
* const input = {
|
|
96
|
+
* DirectoryId: "d-92654abfed",
|
|
97
|
+
* IpRoutes: [
|
|
98
|
+
* {
|
|
99
|
+
* CidrIp: "12.12.12.12/32",
|
|
100
|
+
* Description: "my IpRoute"
|
|
101
|
+
* }
|
|
102
|
+
* ]
|
|
103
|
+
* };
|
|
104
|
+
* const command = new AddIpRoutesCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response is
|
|
107
|
+
* { /* empty *\/ }
|
|
108
|
+
* *\/
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
92
111
|
* @public
|
|
93
112
|
*/
|
|
94
113
|
export declare class AddIpRoutesCommand extends AddIpRoutesCommand_base {
|
|
@@ -63,8 +63,8 @@ declare const AddRegionCommand_base: {
|
|
|
63
63
|
* <p>A client exception has occurred.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link DirectoryAlreadyInRegionException} (client fault)
|
|
66
|
-
* <p>The Region you specified is the same Region where the Managed Microsoft AD directory
|
|
67
|
-
*
|
|
66
|
+
* <p>The Region you specified is the same Region where the Managed Microsoft AD directory was created.
|
|
67
|
+
* Specify a different Region and try again.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link DirectoryDoesNotExistException} (client fault)
|
|
70
70
|
* <p>The specified directory does not exist in the system.</p>
|
|
@@ -76,6 +76,25 @@ declare const AddTagsToResourceCommand_base: {
|
|
|
76
76
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
77
77
|
*
|
|
78
78
|
*
|
|
79
|
+
* @example To add tags to a directory
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // The following example adds or overwrites one or more tags for the specified directory.
|
|
82
|
+
* const input = {
|
|
83
|
+
* ResourceId: "d-92654abfed",
|
|
84
|
+
* Tags: [
|
|
85
|
+
* {
|
|
86
|
+
* Key: "environment",
|
|
87
|
+
* Value: "production"
|
|
88
|
+
* }
|
|
89
|
+
* ]
|
|
90
|
+
* };
|
|
91
|
+
* const command = new AddTagsToResourceCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response is
|
|
94
|
+
* { /* empty *\/ }
|
|
95
|
+
* *\/
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
79
98
|
* @public
|
|
80
99
|
*/
|
|
81
100
|
export declare class AddTagsToResourceCommand extends AddTagsToResourceCommand_base {
|
|
@@ -67,6 +67,20 @@ declare const CancelSchemaExtensionCommand_base: {
|
|
|
67
67
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
68
68
|
*
|
|
69
69
|
*
|
|
70
|
+
* @example To cancel a Microsoft AD schema extension that is in progress
|
|
71
|
+
* ```javascript
|
|
72
|
+
* // The following example cancels an in-progress schema extension to a Microsoft AD directory.
|
|
73
|
+
* const input = {
|
|
74
|
+
* DirectoryId: "d-92654abfed",
|
|
75
|
+
* SchemaExtensionId: "e-926731d2a0"
|
|
76
|
+
* };
|
|
77
|
+
* const command = new CancelSchemaExtensionCommand(input);
|
|
78
|
+
* const response = await client.send(command);
|
|
79
|
+
* /* response is
|
|
80
|
+
* { /* empty *\/ }
|
|
81
|
+
* *\/
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
70
84
|
* @public
|
|
71
85
|
*/
|
|
72
86
|
export declare class CancelSchemaExtensionCommand extends CancelSchemaExtensionCommand_base {
|
|
@@ -30,8 +30,7 @@ declare const ConnectDirectoryCommand_base: {
|
|
|
30
30
|
* <p>Creates an AD Connector to connect to a self-managed directory.</p>
|
|
31
31
|
* <p>Before you call <code>ConnectDirectory</code>, ensure that all of the required permissions
|
|
32
32
|
* have been explicitly granted through a policy. For details about what permissions are required
|
|
33
|
-
* to run the <code>ConnectDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions
|
|
34
|
-
* Reference</a>.</p>
|
|
33
|
+
* to run the <code>ConnectDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
36
|
* ```javascript
|
|
@@ -93,6 +92,36 @@ declare const ConnectDirectoryCommand_base: {
|
|
|
93
92
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
94
93
|
*
|
|
95
94
|
*
|
|
95
|
+
* @example To connect to an on-premises directory
|
|
96
|
+
* ```javascript
|
|
97
|
+
* // The following example creates an AD Connector to connect to an on-premises directory.
|
|
98
|
+
* const input = {
|
|
99
|
+
* ConnectSettings: {
|
|
100
|
+
* CustomerDnsIps: [
|
|
101
|
+
* "172.30.21.228"
|
|
102
|
+
* ],
|
|
103
|
+
* CustomerUserName: "Administrator",
|
|
104
|
+
* SubnetIds: [
|
|
105
|
+
* "subnet-ba0146de",
|
|
106
|
+
* "subnet-bef46bc8"
|
|
107
|
+
* ],
|
|
108
|
+
* VpcId: "vpc-45025421"
|
|
109
|
+
* },
|
|
110
|
+
* Description: "Connector to corp",
|
|
111
|
+
* Name: "corp.example.com",
|
|
112
|
+
* Password: "Str0ngP@ssw0rd",
|
|
113
|
+
* ShortName: "corp",
|
|
114
|
+
* Size: "Small"
|
|
115
|
+
* };
|
|
116
|
+
* const command = new ConnectDirectoryCommand(input);
|
|
117
|
+
* const response = await client.send(command);
|
|
118
|
+
* /* response is
|
|
119
|
+
* {
|
|
120
|
+
* DirectoryId: "d-92654abfed"
|
|
121
|
+
* }
|
|
122
|
+
* *\/
|
|
123
|
+
* ```
|
|
124
|
+
*
|
|
96
125
|
* @public
|
|
97
126
|
*/
|
|
98
127
|
export declare class ConnectDirectoryCommand extends ConnectDirectoryCommand_base {
|
|
@@ -77,6 +77,23 @@ declare const CreateAliasCommand_base: {
|
|
|
77
77
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
78
78
|
*
|
|
79
79
|
*
|
|
80
|
+
* @example To create an alias for a directory
|
|
81
|
+
* ```javascript
|
|
82
|
+
* // The following example creates an alias for a directory.
|
|
83
|
+
* const input = {
|
|
84
|
+
* Alias: "salesorg",
|
|
85
|
+
* DirectoryId: "d-92654abfed"
|
|
86
|
+
* };
|
|
87
|
+
* const command = new CreateAliasCommand(input);
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response is
|
|
90
|
+
* {
|
|
91
|
+
* Alias: "salesorg",
|
|
92
|
+
* DirectoryId: "d-92654abfed"
|
|
93
|
+
* }
|
|
94
|
+
* *\/
|
|
95
|
+
* ```
|
|
96
|
+
*
|
|
80
97
|
* @public
|
|
81
98
|
*/
|
|
82
99
|
export declare class CreateAliasCommand extends CreateAliasCommand_base {
|
|
@@ -97,6 +97,43 @@ declare const CreateComputerCommand_base: {
|
|
|
97
97
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
98
98
|
*
|
|
99
99
|
*
|
|
100
|
+
* @example To create a computer account
|
|
101
|
+
* ```javascript
|
|
102
|
+
* // The following example creates a computer account in the specified directory, and joins the computer to the directory.
|
|
103
|
+
* const input = {
|
|
104
|
+
* ComputerAttributes: [
|
|
105
|
+
* {
|
|
106
|
+
* Name: "ip",
|
|
107
|
+
* Value: "192.168.101.100"
|
|
108
|
+
* }
|
|
109
|
+
* ],
|
|
110
|
+
* ComputerName: "labcomputer",
|
|
111
|
+
* DirectoryId: "d-92654abfed",
|
|
112
|
+
* OrganizationalUnitDistinguishedName: "OU=Computers,OU=example,DC=corp,DC=example,DC=com",
|
|
113
|
+
* Password: "Str0ngP@ssw0rd"
|
|
114
|
+
* };
|
|
115
|
+
* const command = new CreateComputerCommand(input);
|
|
116
|
+
* const response = await client.send(command);
|
|
117
|
+
* /* response is
|
|
118
|
+
* {
|
|
119
|
+
* Computer: {
|
|
120
|
+
* ComputerAttributes: [
|
|
121
|
+
* {
|
|
122
|
+
* Name: "DistinguishedName",
|
|
123
|
+
* Value: "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com"
|
|
124
|
+
* },
|
|
125
|
+
* {
|
|
126
|
+
* Name: "WindowsSamName",
|
|
127
|
+
* Value: "labcomputer$"
|
|
128
|
+
* }
|
|
129
|
+
* ],
|
|
130
|
+
* ComputerId: "S-1-5-21-1932691875-1648176379-1176097576-1124",
|
|
131
|
+
* ComputerName: "labcomputer"
|
|
132
|
+
* }
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
100
137
|
* @public
|
|
101
138
|
*/
|
|
102
139
|
export declare class CreateComputerCommand extends CreateComputerCommand_base {
|
|
@@ -80,6 +80,23 @@ declare const CreateConditionalForwarderCommand_base: {
|
|
|
80
80
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
81
81
|
*
|
|
82
82
|
*
|
|
83
|
+
* @example To create a conditional forwarder
|
|
84
|
+
* ```javascript
|
|
85
|
+
* // The following example creates a conditional forwarder associated with your AWS directory.
|
|
86
|
+
* const input = {
|
|
87
|
+
* DirectoryId: "d-92654abfed",
|
|
88
|
+
* DnsIpAddrs: [
|
|
89
|
+
* "172.30.21.228"
|
|
90
|
+
* ],
|
|
91
|
+
* RemoteDomainName: "sales.example.com"
|
|
92
|
+
* };
|
|
93
|
+
* const command = new CreateConditionalForwarderCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* { /* empty *\/ }
|
|
97
|
+
* *\/
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
83
100
|
* @public
|
|
84
101
|
*/
|
|
85
102
|
export declare class CreateConditionalForwarderCommand extends CreateConditionalForwarderCommand_base {
|
|
@@ -27,12 +27,10 @@ declare const CreateDirectoryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a Simple AD directory. For more information, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html">Simple Active Directory</a> in the <i>Directory Service Admin
|
|
31
|
-
* Guide</i>.</p>
|
|
30
|
+
* <p>Creates a Simple AD directory. For more information, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html">Simple Active Directory</a> in the <i>Directory Service Admin Guide</i>.</p>
|
|
32
31
|
* <p>Before you call <code>CreateDirectory</code>, ensure that all of the required permissions
|
|
33
32
|
* have been explicitly granted through a policy. For details about what permissions are required
|
|
34
|
-
* to run the <code>CreateDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions
|
|
35
|
-
* Reference</a>.</p>
|
|
33
|
+
* to run the <code>CreateDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>
|
|
36
34
|
* @example
|
|
37
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
36
|
* ```javascript
|
|
@@ -90,6 +88,32 @@ declare const CreateDirectoryCommand_base: {
|
|
|
90
88
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
91
89
|
*
|
|
92
90
|
*
|
|
91
|
+
* @example To create a Simple AD directory
|
|
92
|
+
* ```javascript
|
|
93
|
+
* // The following example creates a Simple AD directory.
|
|
94
|
+
* const input = {
|
|
95
|
+
* Description: "Regional directory for example.com",
|
|
96
|
+
* Name: "seattle.example.com",
|
|
97
|
+
* Password: "Str0ngP@ssw0rd",
|
|
98
|
+
* ShortName: "seattle",
|
|
99
|
+
* Size: "Small",
|
|
100
|
+
* VpcSettings: {
|
|
101
|
+
* SubnetIds: [
|
|
102
|
+
* "subnet-ba0146de",
|
|
103
|
+
* "subnet-bef46bc8"
|
|
104
|
+
* ],
|
|
105
|
+
* VpcId: "vpc-45025421"
|
|
106
|
+
* }
|
|
107
|
+
* };
|
|
108
|
+
* const command = new CreateDirectoryCommand(input);
|
|
109
|
+
* const response = await client.send(command);
|
|
110
|
+
* /* response is
|
|
111
|
+
* {
|
|
112
|
+
* DirectoryId: "d-92654abfed"
|
|
113
|
+
* }
|
|
114
|
+
* *\/
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
93
117
|
* @public
|
|
94
118
|
*/
|
|
95
119
|
export declare class CreateDirectoryCommand extends CreateDirectoryCommand_base {
|
|
@@ -91,6 +91,31 @@ declare const CreateMicrosoftADCommand_base: {
|
|
|
91
91
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
92
92
|
*
|
|
93
93
|
*
|
|
94
|
+
* @example To create a Microsoft AD directory
|
|
95
|
+
* ```javascript
|
|
96
|
+
* // The following example creates a Microsoft AD directory in the AWS cloud.
|
|
97
|
+
* const input = {
|
|
98
|
+
* Description: "Corporate AD directory",
|
|
99
|
+
* Name: "ad.example.com",
|
|
100
|
+
* Password: "Str0ngP@ssw0rd",
|
|
101
|
+
* ShortName: "ad",
|
|
102
|
+
* VpcSettings: {
|
|
103
|
+
* SubnetIds: [
|
|
104
|
+
* "subnet-ba0146de",
|
|
105
|
+
* "subnet-bef46bc8"
|
|
106
|
+
* ],
|
|
107
|
+
* VpcId: "vpc-45025421"
|
|
108
|
+
* }
|
|
109
|
+
* };
|
|
110
|
+
* const command = new CreateMicrosoftADCommand(input);
|
|
111
|
+
* const response = await client.send(command);
|
|
112
|
+
* /* response is
|
|
113
|
+
* {
|
|
114
|
+
* DirectoryId: "d-92654abfed"
|
|
115
|
+
* }
|
|
116
|
+
* *\/
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
94
119
|
* @public
|
|
95
120
|
*/
|
|
96
121
|
export declare class CreateMicrosoftADCommand extends CreateMicrosoftADCommand_base {
|
|
@@ -76,6 +76,22 @@ declare const CreateSnapshotCommand_base: {
|
|
|
76
76
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
77
77
|
*
|
|
78
78
|
*
|
|
79
|
+
* @example To create a snapshot of a directory
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
|
|
82
|
+
* const input = {
|
|
83
|
+
* DirectoryId: "d-92654abfed",
|
|
84
|
+
* Name: "ad.example.com"
|
|
85
|
+
* };
|
|
86
|
+
* const command = new CreateSnapshotCommand(input);
|
|
87
|
+
* const response = await client.send(command);
|
|
88
|
+
* /* response is
|
|
89
|
+
* {
|
|
90
|
+
* SnapshotId: "s-9267f8d3f0"
|
|
91
|
+
* }
|
|
92
|
+
* *\/
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
79
95
|
* @public
|
|
80
96
|
*/
|
|
81
97
|
export declare class CreateSnapshotCommand extends CreateSnapshotCommand_base {
|
|
@@ -87,6 +87,28 @@ declare const CreateTrustCommand_base: {
|
|
|
87
87
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
88
88
|
*
|
|
89
89
|
*
|
|
90
|
+
* @example To create a trust
|
|
91
|
+
* ```javascript
|
|
92
|
+
* // The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.
|
|
93
|
+
* const input = {
|
|
94
|
+
* ConditionalForwarderIpAddrs: [
|
|
95
|
+
* "172.30.21.228"
|
|
96
|
+
* ],
|
|
97
|
+
* DirectoryId: "d-92654abfed",
|
|
98
|
+
* RemoteDomainName: "europe.example.com",
|
|
99
|
+
* TrustDirection: "One-Way: Outgoing",
|
|
100
|
+
* TrustPassword: "Str0ngP@ssw0rd",
|
|
101
|
+
* TrustType: "Forest"
|
|
102
|
+
* };
|
|
103
|
+
* const command = new CreateTrustCommand(input);
|
|
104
|
+
* const response = await client.send(command);
|
|
105
|
+
* /* response is
|
|
106
|
+
* {
|
|
107
|
+
* TrustId: "t-9267353743"
|
|
108
|
+
* }
|
|
109
|
+
* *\/
|
|
110
|
+
* ```
|
|
111
|
+
*
|
|
90
112
|
* @public
|
|
91
113
|
*/
|
|
92
114
|
export declare class CreateTrustCommand extends CreateTrustCommand_base {
|
|
@@ -73,6 +73,20 @@ declare const DeleteConditionalForwarderCommand_base: {
|
|
|
73
73
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
74
74
|
*
|
|
75
75
|
*
|
|
76
|
+
* @example To delete a conditional forwarder
|
|
77
|
+
* ```javascript
|
|
78
|
+
* // The following example deletes a conditional forwarder.
|
|
79
|
+
* const input = {
|
|
80
|
+
* DirectoryId: "d-92654abfed",
|
|
81
|
+
* RemoteDomainName: "sales.example.com"
|
|
82
|
+
* };
|
|
83
|
+
* const command = new DeleteConditionalForwarderCommand(input);
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* /* response is
|
|
86
|
+
* { /* empty *\/ }
|
|
87
|
+
* *\/
|
|
88
|
+
* ```
|
|
89
|
+
*
|
|
76
90
|
* @public
|
|
77
91
|
*/
|
|
78
92
|
export declare class DeleteConditionalForwarderCommand extends DeleteConditionalForwarderCommand_base {
|
|
@@ -30,8 +30,7 @@ declare const DeleteDirectoryCommand_base: {
|
|
|
30
30
|
* <p>Deletes an Directory Service directory.</p>
|
|
31
31
|
* <p>Before you call <code>DeleteDirectory</code>, ensure that all of the required permissions
|
|
32
32
|
* have been explicitly granted through a policy. For details about what permissions are required
|
|
33
|
-
* to run the <code>DeleteDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions
|
|
34
|
-
* Reference</a>.</p>
|
|
33
|
+
* to run the <code>DeleteDirectory</code> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>
|
|
35
34
|
* @example
|
|
36
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
36
|
* ```javascript
|
|
@@ -68,6 +67,21 @@ declare const DeleteDirectoryCommand_base: {
|
|
|
68
67
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
69
68
|
*
|
|
70
69
|
*
|
|
70
|
+
* @example To delete a directory
|
|
71
|
+
* ```javascript
|
|
72
|
+
* // The following example deletes a directory from your AWS account.
|
|
73
|
+
* const input = {
|
|
74
|
+
* DirectoryId: "d-92654abfed"
|
|
75
|
+
* };
|
|
76
|
+
* const command = new DeleteDirectoryCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* /* response is
|
|
79
|
+
* {
|
|
80
|
+
* DirectoryId: "d-92654abfed"
|
|
81
|
+
* }
|
|
82
|
+
* *\/
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
71
85
|
* @public
|
|
72
86
|
*/
|
|
73
87
|
export declare class DeleteDirectoryCommand extends DeleteDirectoryCommand_base {
|
|
@@ -67,6 +67,21 @@ declare const DeleteSnapshotCommand_base: {
|
|
|
67
67
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
68
68
|
*
|
|
69
69
|
*
|
|
70
|
+
* @example To delete a snapshot
|
|
71
|
+
* ```javascript
|
|
72
|
+
* // The following example deletes a directory snapshot.
|
|
73
|
+
* const input = {
|
|
74
|
+
* SnapshotId: "s-9267f8d3f0"
|
|
75
|
+
* };
|
|
76
|
+
* const command = new DeleteSnapshotCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* /* response is
|
|
79
|
+
* {
|
|
80
|
+
* SnapshotId: "s-9267f8d3f0"
|
|
81
|
+
* }
|
|
82
|
+
* *\/
|
|
83
|
+
* ```
|
|
84
|
+
*
|
|
70
85
|
* @public
|
|
71
86
|
*/
|
|
72
87
|
export declare class DeleteSnapshotCommand extends DeleteSnapshotCommand_base {
|
|
@@ -72,6 +72,22 @@ declare const DeleteTrustCommand_base: {
|
|
|
72
72
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
73
73
|
*
|
|
74
74
|
*
|
|
75
|
+
* @example To delete a trust
|
|
76
|
+
* ```javascript
|
|
77
|
+
* // The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.
|
|
78
|
+
* const input = {
|
|
79
|
+
* DeleteAssociatedConditionalForwarder: true,
|
|
80
|
+
* TrustId: "t-9267353743"
|
|
81
|
+
* };
|
|
82
|
+
* const command = new DeleteTrustCommand(input);
|
|
83
|
+
* const response = await client.send(command);
|
|
84
|
+
* /* response is
|
|
85
|
+
* {
|
|
86
|
+
* TrustId: "t-9267353743"
|
|
87
|
+
* }
|
|
88
|
+
* *\/
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
75
91
|
* @public
|
|
76
92
|
*/
|
|
77
93
|
export declare class DeleteTrustCommand extends DeleteTrustCommand_base {
|
|
@@ -24,11 +24,11 @@ export interface DeregisterCertificateCommandOutput extends DeregisterCertificat
|
|
|
24
24
|
declare const DeregisterCertificateCommand_base: {
|
|
25
25
|
new (input: DeregisterCertificateCommandInput): import("@smithy/smithy-client").CommandImpl<DeregisterCertificateCommandInput, DeregisterCertificateCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
26
|
new (__0_0: DeregisterCertificateCommandInput): import("@smithy/smithy-client").CommandImpl<DeregisterCertificateCommandInput, DeregisterCertificateCommandOutput, DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
/** @internal type navigation helper, not in runtime. */
|
|
28
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
28
|
};
|
|
30
29
|
/**
|
|
31
|
-
* <p>Deletes from the system the certificate that was registered for secure LDAP or client
|
|
30
|
+
* <p>Deletes from the system the certificate that was registered for secure LDAP or client
|
|
31
|
+
* certificate authentication.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -66,6 +66,20 @@ declare const DeregisterEventTopicCommand_base: {
|
|
|
66
66
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
67
67
|
*
|
|
68
68
|
*
|
|
69
|
+
* @example To remove an event topic
|
|
70
|
+
* ```javascript
|
|
71
|
+
* // The following example removes the specified directory as a publisher to the specified SNS topic.
|
|
72
|
+
* const input = {
|
|
73
|
+
* DirectoryId: "d-92654abfed",
|
|
74
|
+
* TopicName: "snstopicexample"
|
|
75
|
+
* };
|
|
76
|
+
* const command = new DeregisterEventTopicCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* /* response is
|
|
79
|
+
* { /* empty *\/ }
|
|
80
|
+
* *\/
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
69
83
|
* @public
|
|
70
84
|
*/
|
|
71
85
|
export declare class DeregisterEventTopicCommand extends DeregisterEventTopicCommand_base {
|
|
@@ -27,7 +27,8 @@ declare const DescribeCertificateCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Displays information about the certificate registered for secure LDAP or client
|
|
30
|
+
* <p>Displays information about the certificate registered for secure LDAP or client
|
|
31
|
+
* 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
|
|
@@ -27,8 +27,10 @@ declare const DescribeClientAuthenticationSettingsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves information about the type of client authentication for the specified directory,
|
|
31
|
-
*
|
|
30
|
+
* <p>Retrieves information about the type of client authentication for the specified directory,
|
|
31
|
+
* if the type is specified. If no type is specified, information about all client authentication
|
|
32
|
+
* types that are supported for the specified directory is retrieved. Currently, only
|
|
33
|
+
* <code>SmartCard</code> is supported. </p>
|
|
32
34
|
* @example
|
|
33
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
36
|
* ```javascript
|
|
@@ -86,6 +86,24 @@ declare const DescribeConditionalForwardersCommand_base: {
|
|
|
86
86
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
87
87
|
*
|
|
88
88
|
*
|
|
89
|
+
* @example To describe conditional forwarders
|
|
90
|
+
* ```javascript
|
|
91
|
+
* // The following example obtains information about the conditional forwarders for a specified directory.
|
|
92
|
+
* const input = {
|
|
93
|
+
* DirectoryId: "d-92654abfed",
|
|
94
|
+
* RemoteDomainNames: [
|
|
95
|
+
* "sales.example.com"
|
|
96
|
+
* ]
|
|
97
|
+
* };
|
|
98
|
+
* const command = new DescribeConditionalForwardersCommand(input);
|
|
99
|
+
* const response = await client.send(command);
|
|
100
|
+
* /* response is
|
|
101
|
+
* {
|
|
102
|
+
* ConditionalForwarders: []
|
|
103
|
+
* }
|
|
104
|
+
* *\/
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
89
107
|
* @public
|
|
90
108
|
*/
|
|
91
109
|
export declare class DescribeConditionalForwardersCommand extends DescribeConditionalForwardersCommand_base {
|
|
@@ -183,6 +183,52 @@ declare const DescribeDirectoriesCommand_base: {
|
|
|
183
183
|
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
|
|
184
184
|
*
|
|
185
185
|
*
|
|
186
|
+
* @example To describe one or more directories
|
|
187
|
+
* ```javascript
|
|
188
|
+
* // The following example obtains information about a specified directory.
|
|
189
|
+
* const input = {
|
|
190
|
+
* DirectoryIds: [
|
|
191
|
+
* "d-92654abfed"
|
|
192
|
+
* ],
|
|
193
|
+
* Limit: 0
|
|
194
|
+
* };
|
|
195
|
+
* const command = new DescribeDirectoriesCommand(input);
|
|
196
|
+
* const response = await client.send(command);
|
|
197
|
+
* /* response is
|
|
198
|
+
* {
|
|
199
|
+
* DirectoryDescriptions: [
|
|
200
|
+
* {
|
|
201
|
+
* AccessUrl: "myaccess.awsapps.com",
|
|
202
|
+
* Alias: "myaccess",
|
|
203
|
+
* DirectoryId: "d-92654abfed",
|
|
204
|
+
* DnsIpAddrs: [
|
|
205
|
+
* "172.30.21.228",
|
|
206
|
+
* "172.30.9.82"
|
|
207
|
+
* ],
|
|
208
|
+
* LaunchTime: 1.469737584772E9,
|
|
209
|
+
* Name: "corp.example.com",
|
|
210
|
+
* ShortName: "example",
|
|
211
|
+
* SsoEnabled: true,
|
|
212
|
+
* Stage: "Active",
|
|
213
|
+
* StageLastUpdatedDateTime: 1.46973913171E9,
|
|
214
|
+
* Type: "MicrosoftAD",
|
|
215
|
+
* VpcSettings: {
|
|
216
|
+
* AvailabilityZones: [
|
|
217
|
+
* "us-west-2a",
|
|
218
|
+
* "us-west-2b"
|
|
219
|
+
* ],
|
|
220
|
+
* SubnetIds: [
|
|
221
|
+
* "subnet-ba0146de",
|
|
222
|
+
* "subnet-bef46bc8"
|
|
223
|
+
* ],
|
|
224
|
+
* VpcId: "vpc-45025421"
|
|
225
|
+
* }
|
|
226
|
+
* }
|
|
227
|
+
* ]
|
|
228
|
+
* }
|
|
229
|
+
* *\/
|
|
230
|
+
* ```
|
|
231
|
+
*
|
|
186
232
|
* @public
|
|
187
233
|
*/
|
|
188
234
|
export declare class DescribeDirectoriesCommand extends DescribeDirectoriesCommand_base {
|
|
@@ -27,7 +27,8 @@ declare const DescribeDirectoryDataAccessCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Obtains status of directory data access enablement through the Directory Service Data API for the
|
|
30
|
+
* <p>Obtains status of directory data access enablement through the Directory Service Data API for the
|
|
31
|
+
* specified directory.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -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 {
|