@aws-sdk/client-directory-service-data 3.782.0 → 3.783.0

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

@@ -91,6 +91,23 @@ declare const AddGroupMemberCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To add a member to the Marketing group
+ * ```javascript
+ * // The following command adds an existing user to the Marketing group in the europe.example.com domain.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   GroupName: "Marketing",
+ *   MemberName: "Pat Candella",
+ *   MemberRealm: "europe.example.com"
+ * };
+ * const command = new AddGroupMemberCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class AddGroupMemberCommand extends AddGroupMemberCommand_base {

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

@@ -102,6 +102,35 @@ declare const CreateGroupCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To create a group
+ * ```javascript
+ * // The following command creates a distribution list group named AcctngMail.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   GroupScope: "DomainLocal",
+ *   GroupType: "Distribution",
+ *   OtherAttributes: {
+ *     description: {
+ *       S: "Accounting dept mailing list"
+ *     },
+ *     displayName: {
+ *       S: "Acctng-mailing-list"
+ *     }
+ *   },
+ *   SAMAccountName: "AcctngMail"
+ * };
+ * const command = new CreateGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   SAMAccountName: "AcctngMail",
+ *   SID: "S-1-5-33-123"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CreateGroupCommand extends CreateGroupCommand_base {

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

@@ -103,6 +103,36 @@ declare const CreateUserCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To create a new user in the directory
+ * ```javascript
+ * // The following command
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   EmailAddress: "pcandella@exampledomain.com",
+ *   GivenName: "Pat Candella",
+ *   OtherAttributes: {
+ *     department: {
+ *       S: "HR"
+ *     },
+ *     homePhone: {
+ *       S: "212-555-0100"
+ *     }
+ *   },
+ *   SAMAccountName: "pcandella",
+ *   Surname: "Candella"
+ * };
+ * const command = new CreateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   SAMAccountName: "pcandella",
+ *   SID: "S-1-5-99-789"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CreateUserCommand extends CreateUserCommand_base {

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

@@ -89,6 +89,21 @@ declare const DeleteGroupCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To delete a group
+ * ```javascript
+ * // The following command deletes the marketing group from the specified directory.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   SAMAccountName: "marketing"
+ * };
+ * const command = new DeleteGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DeleteGroupCommand extends DeleteGroupCommand_base {

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

@@ -89,6 +89,21 @@ declare const DeleteUserCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To delete a user
+ * ```javascript
+ * // The following command deletes a group from the directory.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   SAMAccountName: "pcandella"
+ * };
+ * const command = new DeleteUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DeleteUserCommand extends DeleteUserCommand_base {

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

@@ -101,6 +101,44 @@ declare const DescribeGroupCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To return the attributes of a group
+ * ```javascript
+ * // The following command returns the mapped attributes for a group along with the display name, description, and GUID for the group.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   OtherAttributes: [
+ *     "displayName",
+ *     "description",
+ *     "objectGUID"
+ *   ],
+ *   Realm: "example.domain.com",
+ *   SAMAccountName: "DevOpsMail"
+ * };
+ * const command = new DescribeGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   DistinguishedName: "DevOpsmail",
+ *   GroupScope: "Global",
+ *   GroupType: "Distribution",
+ *   OtherAttributes: {
+ *     description: {
+ *       S: "A group for DevOps email."
+ *     },
+ *     displayName: {
+ *       S: "DevOps mailing list"
+ *     },
+ *     objectGUID: {
+ *       S: "123456789"
+ *     }
+ *   },
+ *   SAMAccountName: "DevOpsMail",
+ *   SID: "S-1-5-55-678"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeGroupCommand extends DescribeGroupCommand_base {

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

@@ -104,6 +104,51 @@ declare const DescribeUserCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To return the attributes of a user
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   OtherAttributes: [
+ *     "department",
+ *     "manager",
+ *     "ipPhone",
+ *     "pwdLastSet"
+ *   ],
+ *   Realm: "examplecorp.com",
+ *   SAMAccountName: "twhitlock"
+ * };
+ * const command = new DescribeUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   DistinguishedName: "Terry Whitlock",
+ *   EmailAddress: "terry.whitlock@examplecorp.com",
+ *   Enabled: true,
+ *   GivenName: "Terry Whitlock",
+ *   OtherAttributes: {
+ *     department: {
+ *       S: "communications"
+ *     },
+ *     ipPhone: {
+ *       S: "111.111.111.111"
+ *     },
+ *     manager: {
+ *       S: "OU=Users,DC=mmajors"
+ *     },
+ *     pwdLastSet: {
+ *       N: 0
+ *     }
+ *   },
+ *   SAMAccountName: "twhitlock",
+ *   SID: "123-456-7890",
+ *   Surname: "Whitlock",
+ *   UserPrincipalName: "terry.whitlock"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeUserCommand extends DescribeUserCommand_base {

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

@@ -91,6 +91,21 @@ declare const DisableUserCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To disable a user account
+ * ```javascript
+ * // The following command disables the account for twhitlock.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   SAMAccountName: "twhitlock"
+ * };
+ * const command = new DisableUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DisableUserCommand extends DisableUserCommand_base {

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

@@ -101,6 +101,41 @@ declare const ListGroupMembersCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To list members of a group
+ * ```javascript
+ * // The following command lists Marketing users in the trusted domain example.local.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   MemberRealm: "example.local",
+ *   Realm: "examplecorp.com",
+ *   SAMAccountName: "marketing"
+ * };
+ * const command = new ListGroupMembersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   Members: [
+ *     {
+ *       MemberType: "USER",
+ *       SAMAccountName: "twhitlock",
+ *       SID: "S-1-5-11-111"
+ *     },
+ *     {
+ *       MemberType: "USER",
+ *       SAMAccountName: "pcandella",
+ *       SID: "S-1-5-11-112"
+ *     },
+ *     {
+ *       MemberType: "USER",
+ *       SAMAccountName: "jstiles",
+ *       SID: "S-1-5-11-113"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListGroupMembersCommand extends ListGroupMembersCommand_base {

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

@@ -96,6 +96,39 @@ declare const ListGroupsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To list domain groups
+ * ```javascript
+ * // The following command lists the name and default attributes for groups on the examplecorp.com domain.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   MaxResults: 123,
+ *   NextToken: "123456",
+ *   Realm: "examplecorp.com"
+ * };
+ * const command = new ListGroupsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   Groups: [
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Administrators",
+ *       SID: "S-1-5-32-544"
+ *     },
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Users",
+ *       SID: "S-1-5-32-545"
+ *     }
+ *   ],
+ *   NextToken: "223456"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListGroupsCommand extends ListGroupsCommand_base {

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

@@ -102,6 +102,38 @@ declare const ListGroupsForMemberCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To list groups for a member
+ * ```javascript
+ * // The following command
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   MemberRealm: "example.local",
+ *   Realm: "examplecorp.com",
+ *   SAMAccountName: "twhitlock"
+ * };
+ * const command = new ListGroupsForMemberCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   Groups: [
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Administrators",
+ *       SID: "S-1-5-32-544"
+ *     },
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Users",
+ *       SID: "S-1-5-32-545"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListGroupsForMemberCommand extends ListGroupsForMemberCommand_base {

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

@@ -97,6 +97,39 @@ declare const ListUsersCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To list users in a realm
+ * ```javascript
+ * // The following command lists users on the examplecorp.com domain.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   Realm: "examplecorp.com"
+ * };
+ * const command = new ListUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   Users: [
+ *     {
+ *       Enabled: true,
+ *       SAMAccountName: "twhitlock",
+ *       SID: "S-1-5-11-111"
+ *     },
+ *     {
+ *       Enabled: true,
+ *       SAMAccountName: "pcandella",
+ *       SID: "S-1-5-11-112"
+ *     },
+ *     {
+ *       Enabled: true,
+ *       SAMAccountName: "jstiles",
+ *       SID: "S-1-5-11-113"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListUsersCommand extends ListUsersCommand_base {

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

@@ -91,6 +91,23 @@ declare const RemoveGroupMemberCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To remove a member from a group
+ * ```javascript
+ * // The following command removes the specified member from the example.local domain.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   GroupName: "DevOps",
+ *   MemberName: "Pat Candella",
+ *   MemberRealm: "example.local"
+ * };
+ * const command = new RemoveGroupMemberCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class RemoveGroupMemberCommand extends RemoveGroupMemberCommand_base {

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

@@ -113,6 +113,43 @@ declare const SearchGroupsCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To search for groups
+ * ```javascript
+ * // The following command searches the examplecorp.com domain for groups with the GroupType security.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   MaxResults: 123,
+ *   NextToken: "123456",
+ *   Realm: "examplecorp.com",
+ *   SearchAttributes: [
+ *     "GroupScope"
+ *   ],
+ *   SearchString: "Security"
+ * };
+ * const command = new SearchGroupsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   Groups: [
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Administrators",
+ *       SID: "S-1-5-32-544"
+ *     },
+ *     {
+ *       GroupScope: "BuiltinLocal",
+ *       GroupType: "Security",
+ *       SAMAccountName: "Users",
+ *       SID: "S-1-5-32-545"
+ *     }
+ *   ],
+ *   NextToken: "223456"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class SearchGroupsCommand extends SearchGroupsCommand_base {

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

@@ -116,6 +116,44 @@ declare const SearchUsersCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To search for users
+ * ```javascript
+ * // The following command searches for users in the domain based on the SearchAttributes.
+ * const input = {
+ *   DirectoryId: "d-12233abcde",
+ *   Realm: "examplecorp.com",
+ *   SearchAttributes: [
+ *     "department"
+ *   ],
+ *   SearchString: "DevOps"
+ * };
+ * const command = new SearchUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   DirectoryId: "d-12233abcde",
+ *   NextToken: "223456",
+ *   Users: [
+ *     {
+ *       EmailAddress: "twhitlock@examplecorp.com",
+ *       SAMAccountName: "twhitlock",
+ *       SID: "S-1-5-11-111"
+ *     },
+ *     {
+ *       EmailAddress: "pcandella@examplecorp.com",
+ *       SAMAccountName: "pcandella",
+ *       SID: "S-1-5-11-112"
+ *     },
+ *     {
+ *       EmailAddress: "jstiles@examplecorp.com",
+ *       SAMAccountName: "jstiles",
+ *       SID: "S-1-5-11-113"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class SearchUsersCommand extends SearchUsersCommand_base {

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

@@ -102,6 +102,32 @@ declare const UpdateGroupCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To update a group
+ * ```javascript
+ * // The following command updates the preferred language and country attributes for the GuestsLocal group.
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   GroupScope: "Global",
+ *   GroupType: "Security",
+ *   OtherAttributes: {
+ *     co: {
+ *       S: "US"
+ *     },
+ *     preferredLanguage: {
+ *       S: "English"
+ *     }
+ *   },
+ *   SAMAccountName: "GuestsLocal",
+ *   UpdateType: "REPLACE"
+ * };
+ * const command = new UpdateGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateGroupCommand extends UpdateGroupCommand_base {

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

@@ -103,6 +103,48 @@ declare const UpdateUserCommand_base: {
  * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
  *
  *
+ * @example To update user attributes
+ * ```javascript
+ * // The following command
+ * const input = {
+ *   ClientToken: "550e8400-e29b-41d4-a716-446655440000",
+ *   DirectoryId: "d-12233abcde",
+ *   EmailAddress: "twhitlock@examplecorp.com",
+ *   GivenName: "Terry",
+ *   OtherAttributes: {
+ *     co: {
+ *       S: "US"
+ *     },
+ *     homePhone: {
+ *       S: "333-333-3333"
+ *     },
+ *     physicalDeliveryOfficeName: {
+ *       S: "Example Company"
+ *     },
+ *     postalCode: {
+ *       S: "54321"
+ *     },
+ *     st: {
+ *       S: "WA"
+ *     },
+ *     streetAddress: {
+ *       S: "123 Any Street"
+ *     },
+ *     telephoneNumber: {
+ *       S: "212-555-1111"
+ *     }
+ *   },
+ *   SAMAccountName: "twhitlock",
+ *   Surname: "Whitlock",
+ *   UpdateType: "ADD"
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateUserCommand extends UpdateUserCommand_base {

package/dist-types/models/models_0.d.ts

@@ -579,7 +579,7 @@ export interface DescribeGroupRequest {
     SAMAccountName: string | undefined;
     /**
      * <p> One or more attributes to be returned for the group. For a list of supported attributes,
-     *       see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data-attributes.html">Directory Service Data Attributes</a>.
+     *       see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>.
      *     </p>
      * @public
      */
@@ -693,7 +693,7 @@ export interface DescribeUserResult {
     DistinguishedName?: string | undefined;
     /**
      * <p> The UPN that is an Internet-style login name for a user and is based on the Internet
-     *       standard <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a>. The UPN is shorter
+     *       standard <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a>. The UPN is shorter
      *       than the distinguished name and easier to remember. </p>
      * @public
      */
@@ -1355,7 +1355,7 @@ export interface User {
     DistinguishedName?: string | undefined;
     /**
      * <p> The UPN that is an internet-style login name for a user and based on the internet
-     *       standard <a href="https://www.ietf.org/rfc/rfc0822.txt">RFC 822</a>. The UPN is shorter
+     *       standard <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a>. The UPN is shorter
      *       than the distinguished name and easier to remember. </p>
      * @public
      */
@@ -1515,7 +1515,7 @@ export interface UpdateUserRequest {
     /**
      * <p> An expression that defines one or more attribute names with the data type and value of
      *       each attribute. A key is an attribute name, and the value is a list of maps. For a list of
-     *       supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data-attributes.html">Directory Service Data Attributes</a>. </p>
+     *       supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </p>
      *          <note>
      *             <p> Attribute names are case insensitive. </p>
      *          </note>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-directory-service-data",
   "description": "AWS SDK for JavaScript Directory Service Data Client for Node.js, Browser and React Native",
-  "version": "3.782.0",
+  "version": "3.783.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",