Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information\nabout Directory Service Data operations and object types.
\n With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from\nyour Managed Microsoft AD without additional costs and without deploying dedicated management\ninstances. You can also perform built-in object management tasks across directories without\ndirect network connectivity, which simplifies provisioning and access management to achieve\nfully automated deployments. Directory Service Data supports user and group write operations, such as\nCreateUser and CreateGroup, within the organizational unit (OU) of\nyour Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and\nListGroups, on all users, groups, and group memberships within your\nManaged Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in\nyour OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles\nand permissions. For more information, see Manage users and\ngroups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service\nAPI will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay\nbetween management changes, such as adding a new directory trust and calling the Directory Service Data API\nfor the newly created trusted realm.
\nDirectory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on\nunderlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain\ncontrollers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data\nuses an available domain controller. As a result, you might notice eventual consistency while\nobjects replicate from one domain controller to another domain controller. For more\ninformation, see What\ngets created in the Directory Service Administration Guide.\nDirectory limits vary by Managed Microsoft AD edition:
\n\nStandard edition – Supports 8 transactions per\nsecond (TPS) for read operations and 4 TPS for write operations per directory. There's a\nconcurrency limit of 10 concurrent requests.
\n\nEnterprise edition – Supports 16 transactions per\nsecond (TPS) for read operations and 8 TPS for write operations per directory. There's a\nconcurrency limit of 10 concurrent requests.
\n\nAmazon Web Services Account - Supports a total of 100 TPS for\nDirectory Service Data operations across all directories.
\nDirectory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary\nAmazon Web Services Region. For more information, see Managed Microsoft AD\nand Primary vs additional Regions in the Directory Service Administration\nGuide.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-directory-service-data`\n- `yarn add @aws-sdk/client-directory-service-data`\n- `pnpm add @aws-sdk/client-directory-service-data`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `DirectoryServiceDataClient` and\nthe commands you need, for example `ListGroupsCommand`:\n\n```js\n// ES5 example\nconst { DirectoryServiceDataClient, ListGroupsCommand } = require(\"@aws-sdk/client-directory-service-data\");\n```\n\n```ts\n// ES6+ example\nimport { DirectoryServiceDataClient, ListGroupsCommand } from \"@aws-sdk/client-directory-service-data\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new DirectoryServiceDataClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListGroupsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`DirectoryServiceData` extends `DirectoryServiceDataClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`DirectoryServiceDataClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { DirectoryServiceData } from \"@aws-sdk/client-directory-service-data\";\n\nconst client = new DirectoryServiceData({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listGroups(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listGroups(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.listGroups(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-directory-service-data` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n