Skip to content

Commit 18df102

Browse files
author
awstools
committed
docs(client-directory-service-data): Doc only update - fixed broken links.
1 parent b1500f0 commit 18df102

19 files changed

+938
-8
lines changed

‎clients/client-directory-service-data/src/commands/AddGroupMemberCommand.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,23 @@ export interface AddGroupMemberCommandOutput extends AddGroupMemberResult, __Met
9696
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
9797
*
9898
*
99+
* @example To add a member to the Marketing group
100+
* ```javascript
101+
* // The following command adds an existing user to the Marketing group in the europe.example.com domain.
102+
* const input = {
103+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
104+
* DirectoryId: "d-12233abcde",
105+
* GroupName: "Marketing",
106+
* MemberName: "Pat Candella",
107+
* MemberRealm: "europe.example.com"
108+
* };
109+
* const command = new AddGroupMemberCommand(input);
110+
* const response = await client.send(command);
111+
* /* response is
112+
* { /* empty *\/ }
113+
* *\/
114+
* ```
115+
*
99116
* @public
100117
*/
101118
export class AddGroupMemberCommand extends $Command

‎clients/client-directory-service-data/src/commands/CreateGroupCommand.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,35 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB
107107
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
108108
*
109109
*
110+
* @example To create a group
111+
* ```javascript
112+
* // The following command creates a distribution list group named AcctngMail.
113+
* const input = {
114+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
115+
* DirectoryId: "d-12233abcde",
116+
* GroupScope: "DomainLocal",
117+
* GroupType: "Distribution",
118+
* OtherAttributes: {
119+
* description: {
120+
* S: "Accounting dept mailing list"
121+
* },
122+
* displayName: {
123+
* S: "Acctng-mailing-list"
124+
* }
125+
* },
126+
* SAMAccountName: "AcctngMail"
127+
* };
128+
* const command = new CreateGroupCommand(input);
129+
* const response = await client.send(command);
130+
* /* response is
131+
* {
132+
* DirectoryId: "d-12233abcde",
133+
* SAMAccountName: "AcctngMail",
134+
* SID: "S-1-5-33-123"
135+
* }
136+
* *\/
137+
* ```
138+
*
110139
* @public
111140
*/
112141
export class CreateGroupCommand extends $Command

‎clients/client-directory-service-data/src/commands/CreateUserCommand.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,36 @@ export interface CreateUserCommandOutput extends CreateUserResult, __MetadataBea
108108
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
109109
*
110110
*
111+
* @example To create a new user in the directory
112+
* ```javascript
113+
* // The following command
114+
* const input = {
115+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
116+
* DirectoryId: "d-12233abcde",
117+
* EmailAddress: "pcandella@exampledomain.com",
118+
* GivenName: "Pat Candella",
119+
* OtherAttributes: {
120+
* department: {
121+
* S: "HR"
122+
* },
123+
* homePhone: {
124+
* S: "212-555-0100"
125+
* }
126+
* },
127+
* SAMAccountName: "pcandella",
128+
* Surname: "Candella"
129+
* };
130+
* const command = new CreateUserCommand(input);
131+
* const response = await client.send(command);
132+
* /* response is
133+
* {
134+
* DirectoryId: "d-12233abcde",
135+
* SAMAccountName: "pcandella",
136+
* SID: "S-1-5-99-789"
137+
* }
138+
* *\/
139+
* ```
140+
*
111141
* @public
112142
*/
113143
export class CreateUserCommand extends $Command

‎clients/client-directory-service-data/src/commands/DeleteGroupCommand.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,21 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB
9494
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
9595
*
9696
*
97+
* @example To delete a group
98+
* ```javascript
99+
* // The following command deletes the marketing group from the specified directory.
100+
* const input = {
101+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
102+
* DirectoryId: "d-12233abcde",
103+
* SAMAccountName: "marketing"
104+
* };
105+
* const command = new DeleteGroupCommand(input);
106+
* const response = await client.send(command);
107+
* /* response is
108+
* { /* empty *\/ }
109+
* *\/
110+
* ```
111+
*
97112
* @public
98113
*/
99114
export class DeleteGroupCommand extends $Command

‎clients/client-directory-service-data/src/commands/DeleteUserCommand.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,21 @@ export interface DeleteUserCommandOutput extends DeleteUserResult, __MetadataBea
9494
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
9595
*
9696
*
97+
* @example To delete a user
98+
* ```javascript
99+
* // The following command deletes a group from the directory.
100+
* const input = {
101+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
102+
* DirectoryId: "d-12233abcde",
103+
* SAMAccountName: "pcandella"
104+
* };
105+
* const command = new DeleteUserCommand(input);
106+
* const response = await client.send(command);
107+
* /* response is
108+
* { /* empty *\/ }
109+
* *\/
110+
* ```
111+
*
97112
* @public
98113
*/
99114
export class DeleteUserCommand extends $Command

‎clients/client-directory-service-data/src/commands/DescribeGroupCommand.ts

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,44 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResult, __Metad
106106
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
107107
*
108108
*
109+
* @example To return the attributes of a group
110+
* ```javascript
111+
* // The following command returns the mapped attributes for a group along with the display name, description, and GUID for the group.
112+
* const input = {
113+
* DirectoryId: "d-12233abcde",
114+
* OtherAttributes: [
115+
* "displayName",
116+
* "description",
117+
* "objectGUID"
118+
* ],
119+
* Realm: "example.domain.com",
120+
* SAMAccountName: "DevOpsMail"
121+
* };
122+
* const command = new DescribeGroupCommand(input);
123+
* const response = await client.send(command);
124+
* /* response is
125+
* {
126+
* DirectoryId: "d-12233abcde",
127+
* DistinguishedName: "DevOpsmail",
128+
* GroupScope: "Global",
129+
* GroupType: "Distribution",
130+
* OtherAttributes: {
131+
* description: {
132+
* S: "A group for DevOps email."
133+
* },
134+
* displayName: {
135+
* S: "DevOps mailing list"
136+
* },
137+
* objectGUID: {
138+
* S: "123456789"
139+
* }
140+
* },
141+
* SAMAccountName: "DevOpsMail",
142+
* SID: "S-1-5-55-678"
143+
* }
144+
* *\/
145+
* ```
146+
*
109147
* @public
110148
*/
111149
export class DescribeGroupCommand extends $Command

‎clients/client-directory-service-data/src/commands/DescribeUserCommand.ts

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,51 @@ export interface DescribeUserCommandOutput extends DescribeUserResult, __Metadat
109109
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
110110
*
111111
*
112+
* @example To return the attributes of a user
113+
* ```javascript
114+
* // The following command returns the mapped attributes for a user along with the department, manager, IP phone, and date the user last set a password.
115+
* const input = {
116+
* DirectoryId: "d-12233abcde",
117+
* OtherAttributes: [
118+
* "department",
119+
* "manager",
120+
* "ipPhone",
121+
* "pwdLastSet"
122+
* ],
123+
* Realm: "examplecorp.com",
124+
* SAMAccountName: "twhitlock"
125+
* };
126+
* const command = new DescribeUserCommand(input);
127+
* const response = await client.send(command);
128+
* /* response is
129+
* {
130+
* DirectoryId: "d-12233abcde",
131+
* DistinguishedName: "Terry Whitlock",
132+
* EmailAddress: "terry.whitlock@examplecorp.com",
133+
* Enabled: true,
134+
* GivenName: "Terry Whitlock",
135+
* OtherAttributes: {
136+
* department: {
137+
* S: "communications"
138+
* },
139+
* ipPhone: {
140+
* S: "111.111.111.111"
141+
* },
142+
* manager: {
143+
* S: "OU=Users,DC=mmajors"
144+
* },
145+
* pwdLastSet: {
146+
* N: 0
147+
* }
148+
* },
149+
* SAMAccountName: "twhitlock",
150+
* SID: "123-456-7890",
151+
* Surname: "Whitlock",
152+
* UserPrincipalName: "terry.whitlock"
153+
* }
154+
* *\/
155+
* ```
156+
*
112157
* @public
113158
*/
114159
export class DescribeUserCommand extends $Command

‎clients/client-directory-service-data/src/commands/DisableUserCommand.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,21 @@ export interface DisableUserCommandOutput extends DisableUserResult, __MetadataB
9696
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
9797
*
9898
*
99+
* @example To disable a user account
100+
* ```javascript
101+
* // The following command disables the account for twhitlock.
102+
* const input = {
103+
* ClientToken: "550e8400-e29b-41d4-a716-446655440000",
104+
* DirectoryId: "d-12233abcde",
105+
* SAMAccountName: "twhitlock"
106+
* };
107+
* const command = new DisableUserCommand(input);
108+
* const response = await client.send(command);
109+
* /* response is
110+
* { /* empty *\/ }
111+
* *\/
112+
* ```
113+
*
99114
* @public
100115
*/
101116
export class DisableUserCommand extends $Command

‎clients/client-directory-service-data/src/commands/ListGroupMembersCommand.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,41 @@ export interface ListGroupMembersCommandOutput extends ListGroupMembersResult, _
111111
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
112112
*
113113
*
114+
* @example To list members of a group
115+
* ```javascript
116+
* // The following command lists Marketing users in the trusted domain example.local.
117+
* const input = {
118+
* DirectoryId: "d-12233abcde",
119+
* MemberRealm: "example.local",
120+
* Realm: "examplecorp.com",
121+
* SAMAccountName: "marketing"
122+
* };
123+
* const command = new ListGroupMembersCommand(input);
124+
* const response = await client.send(command);
125+
* /* response is
126+
* {
127+
* DirectoryId: "d-12233abcde",
128+
* Members: [
129+
* {
130+
* MemberType: "USER",
131+
* SAMAccountName: "twhitlock",
132+
* SID: "S-1-5-11-111"
133+
* },
134+
* {
135+
* MemberType: "USER",
136+
* SAMAccountName: "pcandella",
137+
* SID: "S-1-5-11-112"
138+
* },
139+
* {
140+
* MemberType: "USER",
141+
* SAMAccountName: "jstiles",
142+
* SID: "S-1-5-11-113"
143+
* }
144+
* ]
145+
* }
146+
* *\/
147+
* ```
148+
*
114149
* @public
115150
*/
116151
export class ListGroupMembersCommand extends $Command

‎clients/client-directory-service-data/src/commands/ListGroupsCommand.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,39 @@ export interface ListGroupsCommandOutput extends ListGroupsResult, __MetadataBea
106106
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
107107
*
108108
*
109+
* @example To list domain groups
110+
* ```javascript
111+
* // The following command lists the name and default attributes for groups on the examplecorp.com domain.
112+
* const input = {
113+
* DirectoryId: "d-12233abcde",
114+
* MaxResults: 123,
115+
* NextToken: "123456",
116+
* Realm: "examplecorp.com"
117+
* };
118+
* const command = new ListGroupsCommand(input);
119+
* const response = await client.send(command);
120+
* /* response is
121+
* {
122+
* DirectoryId: "d-12233abcde",
123+
* Groups: [
124+
* {
125+
* GroupScope: "BuiltinLocal",
126+
* GroupType: "Security",
127+
* SAMAccountName: "Administrators",
128+
* SID: "S-1-5-32-544"
129+
* },
130+
* {
131+
* GroupScope: "BuiltinLocal",
132+
* GroupType: "Security",
133+
* SAMAccountName: "Users",
134+
* SID: "S-1-5-32-545"
135+
* }
136+
* ],
137+
* NextToken: "223456"
138+
* }
139+
* *\/
140+
* ```
141+
*
109142
* @public
110143
*/
111144
export class ListGroupsCommand extends $Command

‎clients/client-directory-service-data/src/commands/ListGroupsForMemberCommand.ts

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,38 @@ export interface ListGroupsForMemberCommandOutput extends ListGroupsForMemberRes
112112
* <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
113113
*
114114
*
115+
* @example To list groups for a member
116+
* ```javascript
117+
* // The following command
118+
* const input = {
119+
* DirectoryId: "d-12233abcde",
120+
* MemberRealm: "example.local",
121+
* Realm: "examplecorp.com",
122+
* SAMAccountName: "twhitlock"
123+
* };
124+
* const command = new ListGroupsForMemberCommand(input);
125+
* const response = await client.send(command);
126+
* /* response is
127+
* {
128+
* DirectoryId: "d-12233abcde",
129+
* Groups: [
130+
* {
131+
* GroupScope: "BuiltinLocal",
132+
* GroupType: "Security",
133+
* SAMAccountName: "Administrators",
134+
* SID: "S-1-5-32-544"
135+
* },
136+
* {
137+
* GroupScope: "BuiltinLocal",
138+
* GroupType: "Security",
139+
* SAMAccountName: "Users",
140+
* SID: "S-1-5-32-545"
141+
* }
142+
* ]
143+
* }
144+
* *\/
145+
* ```
146+
*
115147
* @public
116148
*/
117149
export class ListGroupsForMemberCommand extends $Command

0 commit comments

Comments
 (0)