Skip to content

Commit b15810a

Browse files
author
awstools
committed
docs(client-directory-service): Doc only update - fixed typos.
1 parent 2591cbd commit b15810a

File tree

54 files changed

+1688
-295
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1688
-295
lines changed

‎clients/client-directory-service/src/commands/AddIpRoutesCommand.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,25 @@ export interface AddIpRoutesCommandOutput extends AddIpRoutesResult, __MetadataB
9090
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
9191
*
9292
*
93+
* @example To add a CIDR address block that routes traffic for Microsoft AD
94+
* ```javascript
95+
* // The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.
96+
* const input = {
97+
* DirectoryId: "d-92654abfed",
98+
* IpRoutes: [
99+
* {
100+
* CidrIp: "12.12.12.12/32",
101+
* Description: "my IpRoute"
102+
* }
103+
* ]
104+
* };
105+
* const command = new AddIpRoutesCommand(input);
106+
* const response = await client.send(command);
107+
* /* response is
108+
* { /* empty *\/ }
109+
* *\/
110+
* ```
111+
*
93112
* @public
94113
*/
95114
export class AddIpRoutesCommand extends $Command

‎clients/client-directory-service/src/commands/AddRegionCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ export interface AddRegionCommandOutput extends AddRegionResult, __MetadataBeare
6464
* <p>A client exception has occurred.</p>
6565
*
6666
* @throws {@link DirectoryAlreadyInRegionException} (client fault)
67-
* <p>The Region you specified is the same Region where the Managed Microsoft AD directory
68-
* was created. Specify a different Region and try again.</p>
67+
* <p>The Region you specified is the same Region where the Managed Microsoft AD directory was created.
68+
* Specify a different Region and try again.</p>
6969
*
7070
* @throws {@link DirectoryDoesNotExistException} (client fault)
7171
* <p>The specified directory does not exist in the system.</p>

‎clients/client-directory-service/src/commands/AddTagsToResourceCommand.ts

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,25 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
7777
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
7878
*
7979
*
80+
* @example To add tags to a directory
81+
* ```javascript
82+
* // The following example adds or overwrites one or more tags for the specified directory.
83+
* const input = {
84+
* ResourceId: "d-92654abfed",
85+
* Tags: [
86+
* {
87+
* Key: "environment",
88+
* Value: "production"
89+
* }
90+
* ]
91+
* };
92+
* const command = new AddTagsToResourceCommand(input);
93+
* const response = await client.send(command);
94+
* /* response is
95+
* { /* empty *\/ }
96+
* *\/
97+
* ```
98+
*
8099
* @public
81100
*/
82101
export class AddTagsToResourceCommand extends $Command

‎clients/client-directory-service/src/commands/CancelSchemaExtensionCommand.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,20 @@ export interface CancelSchemaExtensionCommandOutput extends CancelSchemaExtensio
6868
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
6969
*
7070
*
71+
* @example To cancel a Microsoft AD schema extension that is in progress
72+
* ```javascript
73+
* // The following example cancels an in-progress schema extension to a Microsoft AD directory.
74+
* const input = {
75+
* DirectoryId: "d-92654abfed",
76+
* SchemaExtensionId: "e-926731d2a0"
77+
* };
78+
* const command = new CancelSchemaExtensionCommand(input);
79+
* const response = await client.send(command);
80+
* /* response is
81+
* { /* empty *\/ }
82+
* *\/
83+
* ```
84+
*
7185
* @public
7286
*/
7387
export class CancelSchemaExtensionCommand extends $Command

‎clients/client-directory-service/src/commands/ConnectDirectoryCommand.ts

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ export interface ConnectDirectoryCommandOutput extends ConnectDirectoryResult, _
3535
* <p>Creates an AD Connector to connect to a self-managed directory.</p>
3636
* <p>Before you call <code>ConnectDirectory</code>, ensure that all of the required permissions
3737
* have been explicitly granted through a policy. For details about what permissions are required
38-
* 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
39-
* Reference</a>.</p>
38+
* 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>
4039
* @example
4140
* Use a bare-bones client and the command you need to make an API call.
4241
* ```javascript
@@ -98,6 +97,36 @@ export interface ConnectDirectoryCommandOutput extends ConnectDirectoryResult, _
9897
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
9998
*
10099
*
100+
* @example To connect to an on-premises directory
101+
* ```javascript
102+
* // The following example creates an AD Connector to connect to an on-premises directory.
103+
* const input = {
104+
* ConnectSettings: {
105+
* CustomerDnsIps: [
106+
* "172.30.21.228"
107+
* ],
108+
* CustomerUserName: "Administrator",
109+
* SubnetIds: [
110+
* "subnet-ba0146de",
111+
* "subnet-bef46bc8"
112+
* ],
113+
* VpcId: "vpc-45025421"
114+
* },
115+
* Description: "Connector to corp",
116+
* Name: "corp.example.com",
117+
* Password: "Str0ngP@ssw0rd",
118+
* ShortName: "corp",
119+
* Size: "Small"
120+
* };
121+
* const command = new ConnectDirectoryCommand(input);
122+
* const response = await client.send(command);
123+
* /* response is
124+
* {
125+
* DirectoryId: "d-92654abfed"
126+
* }
127+
* *\/
128+
* ```
129+
*
101130
* @public
102131
*/
103132
export class ConnectDirectoryCommand extends $Command

‎clients/client-directory-service/src/commands/CreateAliasCommand.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,23 @@ export interface CreateAliasCommandOutput extends CreateAliasResult, __MetadataB
7878
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
7979
*
8080
*
81+
* @example To create an alias for a directory
82+
* ```javascript
83+
* // The following example creates an alias for a directory.
84+
* const input = {
85+
* Alias: "salesorg",
86+
* DirectoryId: "d-92654abfed"
87+
* };
88+
* const command = new CreateAliasCommand(input);
89+
* const response = await client.send(command);
90+
* /* response is
91+
* {
92+
* Alias: "salesorg",
93+
* DirectoryId: "d-92654abfed"
94+
* }
95+
* *\/
96+
* ```
97+
*
8198
* @public
8299
*/
83100
export class CreateAliasCommand extends $Command

‎clients/client-directory-service/src/commands/CreateComputerCommand.ts

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,43 @@ export interface CreateComputerCommandOutput extends CreateComputerResult, __Met
102102
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
103103
*
104104
*
105+
* @example To create a computer account
106+
* ```javascript
107+
* // The following example creates a computer account in the specified directory, and joins the computer to the directory.
108+
* const input = {
109+
* ComputerAttributes: [
110+
* {
111+
* Name: "ip",
112+
* Value: "192.168.101.100"
113+
* }
114+
* ],
115+
* ComputerName: "labcomputer",
116+
* DirectoryId: "d-92654abfed",
117+
* OrganizationalUnitDistinguishedName: "OU=Computers,OU=example,DC=corp,DC=example,DC=com",
118+
* Password: "Str0ngP@ssw0rd"
119+
* };
120+
* const command = new CreateComputerCommand(input);
121+
* const response = await client.send(command);
122+
* /* response is
123+
* {
124+
* Computer: {
125+
* ComputerAttributes: [
126+
* {
127+
* Name: "DistinguishedName",
128+
* Value: "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com"
129+
* },
130+
* {
131+
* Name: "WindowsSamName",
132+
* Value: "labcomputer$"
133+
* }
134+
* ],
135+
* ComputerId: "S-1-5-21-1932691875-1648176379-1176097576-1124",
136+
* ComputerName: "labcomputer"
137+
* }
138+
* }
139+
* *\/
140+
* ```
141+
*
105142
* @public
106143
*/
107144
export class CreateComputerCommand extends $Command

‎clients/client-directory-service/src/commands/CreateConditionalForwarderCommand.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,23 @@ export interface CreateConditionalForwarderCommandOutput extends CreateCondition
8181
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
8282
*
8383
*
84+
* @example To create a conditional forwarder
85+
* ```javascript
86+
* // The following example creates a conditional forwarder associated with your AWS directory.
87+
* const input = {
88+
* DirectoryId: "d-92654abfed",
89+
* DnsIpAddrs: [
90+
* "172.30.21.228"
91+
* ],
92+
* RemoteDomainName: "sales.example.com"
93+
* };
94+
* const command = new CreateConditionalForwarderCommand(input);
95+
* const response = await client.send(command);
96+
* /* response is
97+
* { /* empty *\/ }
98+
* *\/
99+
* ```
100+
*
84101
* @public
85102
*/
86103
export class CreateConditionalForwarderCommand extends $Command

‎clients/client-directory-service/src/commands/CreateDirectoryCommand.ts

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,10 @@ export interface CreateDirectoryCommandInput extends CreateDirectoryRequest {}
3232
export interface CreateDirectoryCommandOutput extends CreateDirectoryResult, __MetadataBearer {}
3333

3434
/**
35-
* <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
36-
* Guide</i>.</p>
35+
* <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>
3736
* <p>Before you call <code>CreateDirectory</code>, ensure that all of the required permissions
3837
* have been explicitly granted through a policy. For details about what permissions are required
39-
* 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
40-
* Reference</a>.</p>
38+
* 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>
4139
* @example
4240
* Use a bare-bones client and the command you need to make an API call.
4341
* ```javascript
@@ -95,6 +93,32 @@ export interface CreateDirectoryCommandOutput extends CreateDirectoryResult, __M
9593
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
9694
*
9795
*
96+
* @example To create a Simple AD directory
97+
* ```javascript
98+
* // The following example creates a Simple AD directory.
99+
* const input = {
100+
* Description: "Regional directory for example.com",
101+
* Name: "seattle.example.com",
102+
* Password: "Str0ngP@ssw0rd",
103+
* ShortName: "seattle",
104+
* Size: "Small",
105+
* VpcSettings: {
106+
* SubnetIds: [
107+
* "subnet-ba0146de",
108+
* "subnet-bef46bc8"
109+
* ],
110+
* VpcId: "vpc-45025421"
111+
* }
112+
* };
113+
* const command = new CreateDirectoryCommand(input);
114+
* const response = await client.send(command);
115+
* /* response is
116+
* {
117+
* DirectoryId: "d-92654abfed"
118+
* }
119+
* *\/
120+
* ```
121+
*
98122
* @public
99123
*/
100124
export class CreateDirectoryCommand extends $Command

‎clients/client-directory-service/src/commands/CreateMicrosoftADCommand.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,31 @@ export interface CreateMicrosoftADCommandOutput extends CreateMicrosoftADResult,
9696
* <p>Base exception class for all service exceptions from DirectoryService service.</p>
9797
*
9898
*
99+
* @example To create a Microsoft AD directory
100+
* ```javascript
101+
* // The following example creates a Microsoft AD directory in the AWS cloud.
102+
* const input = {
103+
* Description: "Corporate AD directory",
104+
* Name: "ad.example.com",
105+
* Password: "Str0ngP@ssw0rd",
106+
* ShortName: "ad",
107+
* VpcSettings: {
108+
* SubnetIds: [
109+
* "subnet-ba0146de",
110+
* "subnet-bef46bc8"
111+
* ],
112+
* VpcId: "vpc-45025421"
113+
* }
114+
* };
115+
* const command = new CreateMicrosoftADCommand(input);
116+
* const response = await client.send(command);
117+
* /* response is
118+
* {
119+
* DirectoryId: "d-92654abfed"
120+
* }
121+
* *\/
122+
* ```
123+
*
99124
* @public
100125
*/
101126
export class CreateMicrosoftADCommand extends $Command

0 commit comments

Comments
 (0)