Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information +about Directory Service Data operations and object types.
+ With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from
+your Managed Microsoft AD without additional costs and without deploying dedicated management
+instances. You can also perform built-in object management tasks across directories without
+direct network connectivity, which simplifies provisioning and access management to achieve
+fully automated deployments. Directory Service Data supports user and group write operations, such as
+CreateUser and CreateGroup, within the organizational unit (OU) of
+your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and
+ListGroups, on all users, groups, and group memberships within your
+Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in
+your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles
+and permissions. For more information, see Manage users and
+groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service +API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay +between management changes, such as adding a new directory trust and calling the Directory Service Data API +for the newly created trusted realm.
+Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on +underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain +controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data +uses an available domain controller. As a result, you might notice eventual consistency while +objects replicate from one domain controller to another domain controller. For more +information, see What +gets created in the Directory Service Administration Guide. +Directory limits vary by Managed Microsoft AD edition:
++Standard edition – Supports 8 transactions per +second (TPS) for read operations and 4 TPS for write operations per directory. There's a +concurrency limit of 10 concurrent requests.
++Enterprise edition – Supports 16 transactions per +second (TPS) for read operations and 8 TPS for write operations per directory. There's a +concurrency limit of 10 concurrent requests.
++Amazon Web Services Account - Supports a total of 100 TPS for +Directory Service Data operations across all directories.
+Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary +Amazon Web Services Region. For more information, see Managed Microsoft AD +and Primary vs additional Regions in the Directory Service Administration +Guide.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-directory-service-data +using your favorite package manager: + +- `npm install @aws-sdk/client-directory-service-data` +- `yarn add @aws-sdk/client-directory-service-data` +- `pnpm add @aws-sdk/client-directory-service-data` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `DirectoryServiceDataClient` and +the commands you need, for example `ListGroupsCommand`: + +```js +// ES5 example +const { DirectoryServiceDataClient, ListGroupsCommand } = require("@aws-sdk/client-directory-service-data"); +``` + +```ts +// ES6+ example +import { DirectoryServiceDataClient, ListGroupsCommand } from "@aws-sdk/client-directory-service-data"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new DirectoryServiceDataClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListGroupsCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-directory-service-data"; +const client = new AWS.DirectoryServiceData({ region: "REGION" }); + +// async/await. +try { + const data = await client.listGroups(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listGroups(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listGroups(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- 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). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-directory-service-data` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Amazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information + * about Directory Service Data operations and object types.
+ * With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from
+ * your Managed Microsoft AD without additional costs and without deploying dedicated management
+ * instances. You can also perform built-in object management tasks across directories without
+ * direct network connectivity, which simplifies provisioning and access management to achieve
+ * fully automated deployments. Directory Service Data supports user and group write operations, such as
+ * CreateUser and CreateGroup, within the organizational unit (OU) of
+ * your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and
+ * ListGroups, on all users, groups, and group memberships within your
+ * Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in
+ * your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles
+ * and permissions. For more information, see Manage users and
+ * groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service + * API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay + * between management changes, such as adding a new directory trust and calling the Directory Service Data API + * for the newly created trusted realm.
+ *Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on + * underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain + * controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data + * uses an available domain controller. As a result, you might notice eventual consistency while + * objects replicate from one domain controller to another domain controller. For more + * information, see What + * gets created in the Directory Service Administration Guide. + * Directory limits vary by Managed Microsoft AD edition:
+ *+ * Standard edition – Supports 8 transactions per + * second (TPS) for read operations and 4 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Enterprise edition – Supports 16 transactions per + * second (TPS) for read operations and 8 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Amazon Web Services Account - Supports a total of 100 TPS for + * Directory Service Data operations across all directories.
+ *Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary + * Amazon Web Services Region. For more information, see Managed Microsoft AD + * and Primary vs additional Regions in the Directory Service Administration + * Guide.
+ * @public + */ +export class DirectoryServiceData extends DirectoryServiceDataClient implements DirectoryServiceData {} +createAggregatedClient(commands, DirectoryServiceData); diff --git a/clients/client-directory-service-data/src/DirectoryServiceDataClient.ts b/clients/client-directory-service-data/src/DirectoryServiceDataClient.ts new file mode 100644 index 0000000000000..be745c5fe08e2 --- /dev/null +++ b/clients/client-directory-service-data/src/DirectoryServiceDataClient.ts @@ -0,0 +1,405 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { + defaultDirectoryServiceDataHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { AddGroupMemberCommandInput, AddGroupMemberCommandOutput } from "./commands/AddGroupMemberCommand"; +import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand"; +import { CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand"; +import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand"; +import { DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand"; +import { DescribeGroupCommandInput, DescribeGroupCommandOutput } from "./commands/DescribeGroupCommand"; +import { DescribeUserCommandInput, DescribeUserCommandOutput } from "./commands/DescribeUserCommand"; +import { DisableUserCommandInput, DisableUserCommandOutput } from "./commands/DisableUserCommand"; +import { ListGroupMembersCommandInput, ListGroupMembersCommandOutput } from "./commands/ListGroupMembersCommand"; +import { ListGroupsCommandInput, ListGroupsCommandOutput } from "./commands/ListGroupsCommand"; +import { + ListGroupsForMemberCommandInput, + ListGroupsForMemberCommandOutput, +} from "./commands/ListGroupsForMemberCommand"; +import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand"; +import { RemoveGroupMemberCommandInput, RemoveGroupMemberCommandOutput } from "./commands/RemoveGroupMemberCommand"; +import { SearchGroupsCommandInput, SearchGroupsCommandOutput } from "./commands/SearchGroupsCommand"; +import { SearchUsersCommandInput, SearchUsersCommandOutput } from "./commands/SearchUsersCommand"; +import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand"; +import { UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | AddGroupMemberCommandInput + | CreateGroupCommandInput + | CreateUserCommandInput + | DeleteGroupCommandInput + | DeleteUserCommandInput + | DescribeGroupCommandInput + | DescribeUserCommandInput + | DisableUserCommandInput + | ListGroupMembersCommandInput + | ListGroupsCommandInput + | ListGroupsForMemberCommandInput + | ListUsersCommandInput + | RemoveGroupMemberCommandInput + | SearchGroupsCommandInput + | SearchUsersCommandInput + | UpdateGroupCommandInput + | UpdateUserCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | AddGroupMemberCommandOutput + | CreateGroupCommandOutput + | CreateUserCommandOutput + | DeleteGroupCommandOutput + | DeleteUserCommandOutput + | DescribeGroupCommandOutput + | DescribeUserCommandOutput + | DisableUserCommandOutput + | ListGroupMembersCommandOutput + | ListGroupsCommandOutput + | ListGroupsForMemberCommandOutput + | ListUsersCommandOutput + | RemoveGroupMemberCommandOutput + | SearchGroupsCommandOutput + | SearchUsersCommandOutput + | UpdateGroupCommandOutput + | UpdateUserCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information + * about Directory Service Data operations and object types.
+ * With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from
+ * your Managed Microsoft AD without additional costs and without deploying dedicated management
+ * instances. You can also perform built-in object management tasks across directories without
+ * direct network connectivity, which simplifies provisioning and access management to achieve
+ * fully automated deployments. Directory Service Data supports user and group write operations, such as
+ * CreateUser and CreateGroup, within the organizational unit (OU) of
+ * your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and
+ * ListGroups, on all users, groups, and group memberships within your
+ * Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in
+ * your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles
+ * and permissions. For more information, see Manage users and
+ * groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service + * API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay + * between management changes, such as adding a new directory trust and calling the Directory Service Data API + * for the newly created trusted realm.
+ *Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on + * underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain + * controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data + * uses an available domain controller. As a result, you might notice eventual consistency while + * objects replicate from one domain controller to another domain controller. For more + * information, see What + * gets created in the Directory Service Administration Guide. + * Directory limits vary by Managed Microsoft AD edition:
+ *+ * Standard edition – Supports 8 transactions per + * second (TPS) for read operations and 4 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Enterprise edition – Supports 16 transactions per + * second (TPS) for read operations and 8 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Amazon Web Services Account - Supports a total of 100 TPS for + * Directory Service Data operations across all directories.
+ *Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary + * Amazon Web Services Region. For more information, see Managed Microsoft AD + * and Primary vs additional Regions in the Directory Service Administration + * Guide.
+ * @public + */ +export class DirectoryServiceDataClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + DirectoryServiceDataClientResolvedConfig +> { + /** + * The resolved configuration of DirectoryServiceDataClient class. This is resolved and normalized from the {@link DirectoryServiceDataClientConfig | constructor configuration interface}. + */ + readonly config: DirectoryServiceDataClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigAdds an existing user, group, or computer as a group member.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, AddGroupMemberCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, AddGroupMemberCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // AddGroupMemberRequest + * DirectoryId: "STRING_VALUE", // required + * GroupName: "STRING_VALUE", // required + * MemberName: "STRING_VALUE", // required + * MemberRealm: "STRING_VALUE", + * ClientToken: "STRING_VALUE", + * }; + * const command = new AddGroupMemberCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param AddGroupMemberCommandInput - {@link AddGroupMemberCommandInput} + * @returns {@link AddGroupMemberCommandOutput} + * @see {@link AddGroupMemberCommandInput} for command's `input` shape. + * @see {@link AddGroupMemberCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class AddGroupMemberCommand extends $Command + .classBuilder< + AddGroupMemberCommandInput, + AddGroupMemberCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "AddGroupMember", {}) + .n("DirectoryServiceDataClient", "AddGroupMemberCommand") + .f(void 0, void 0) + .ser(se_AddGroupMemberCommand) + .de(de_AddGroupMemberCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: AddGroupMemberRequest; + output: {}; + }; + sdk: { + input: AddGroupMemberCommandInput; + output: AddGroupMemberCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/CreateGroupCommand.ts b/clients/client-directory-service-data/src/commands/CreateGroupCommand.ts new file mode 100644 index 0000000000000..924d1c273702f --- /dev/null +++ b/clients/client-directory-service-data/src/commands/CreateGroupCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateGroupRequest, CreateGroupRequestFilterSensitiveLog, CreateGroupResult } from "../models/models_0"; +import { de_CreateGroupCommand, se_CreateGroupCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateGroupCommand}. + */ +export interface CreateGroupCommandInput extends CreateGroupRequest {} +/** + * @public + * + * The output of {@link CreateGroupCommand}. + */ +export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataBearer {} + +/** + *Creates a new group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, CreateGroupCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, CreateGroupCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // CreateGroupRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * GroupType: "Distribution" || "Security", + * GroupScope: "DomainLocal" || "Global" || "Universal" || "BuiltinLocal", + * OtherAttributes: { // Attributes + * " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class CreateGroupCommand extends $Command + .classBuilder< + CreateGroupCommandInput, + CreateGroupCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "CreateGroup", {}) + .n("DirectoryServiceDataClient", "CreateGroupCommand") + .f(CreateGroupRequestFilterSensitiveLog, void 0) + .ser(se_CreateGroupCommand) + .de(de_CreateGroupCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateGroupRequest; + output: CreateGroupResult; + }; + sdk: { + input: CreateGroupCommandInput; + output: CreateGroupCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/CreateUserCommand.ts b/clients/client-directory-service-data/src/commands/CreateUserCommand.ts new file mode 100644 index 0000000000000..5953b75c203d1 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/CreateUserCommand.ts @@ -0,0 +1,144 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { CreateUserRequest, CreateUserRequestFilterSensitiveLog, CreateUserResult } from "../models/models_0"; +import { de_CreateUserCommand, se_CreateUserCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateUserCommand}. + */ +export interface CreateUserCommandInput extends CreateUserRequest {} +/** + * @public + * + * The output of {@link CreateUserCommand}. + */ +export interface CreateUserCommandOutput extends CreateUserResult, __MetadataBearer {} + +/** + *Creates a new user.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, CreateUserCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, CreateUserCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // CreateUserRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * EmailAddress: "STRING_VALUE", + * GivenName: "STRING_VALUE", + * Surname: "STRING_VALUE", + * OtherAttributes: { // Attributes + * " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class CreateUserCommand extends $Command + .classBuilder< + CreateUserCommandInput, + CreateUserCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "CreateUser", {}) + .n("DirectoryServiceDataClient", "CreateUserCommand") + .f(CreateUserRequestFilterSensitiveLog, void 0) + .ser(se_CreateUserCommand) + .de(de_CreateUserCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateUserRequest; + output: CreateUserResult; + }; + sdk: { + input: CreateUserCommandInput; + output: CreateUserCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/DeleteGroupCommand.ts b/clients/client-directory-service-data/src/commands/DeleteGroupCommand.ts new file mode 100644 index 0000000000000..c329687be7698 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/DeleteGroupCommand.ts @@ -0,0 +1,130 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteGroupRequest, DeleteGroupResult } from "../models/models_0"; +import { de_DeleteGroupCommand, se_DeleteGroupCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteGroupCommand}. + */ +export interface DeleteGroupCommandInput extends DeleteGroupRequest {} +/** + * @public + * + * The output of {@link DeleteGroupCommand}. + */ +export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataBearer {} + +/** + *Deletes a group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, DeleteGroupCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, DeleteGroupCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // DeleteGroupRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * ClientToken: "STRING_VALUE", + * }; + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteGroupCommandInput - {@link DeleteGroupCommandInput} + * @returns {@link DeleteGroupCommandOutput} + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class DeleteGroupCommand extends $Command + .classBuilder< + DeleteGroupCommandInput, + DeleteGroupCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "DeleteGroup", {}) + .n("DirectoryServiceDataClient", "DeleteGroupCommand") + .f(void 0, void 0) + .ser(se_DeleteGroupCommand) + .de(de_DeleteGroupCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteGroupRequest; + output: {}; + }; + sdk: { + input: DeleteGroupCommandInput; + output: DeleteGroupCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/DeleteUserCommand.ts b/clients/client-directory-service-data/src/commands/DeleteUserCommand.ts new file mode 100644 index 0000000000000..ba4422f6bdc2f --- /dev/null +++ b/clients/client-directory-service-data/src/commands/DeleteUserCommand.ts @@ -0,0 +1,130 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteUserRequest, DeleteUserResult } from "../models/models_0"; +import { de_DeleteUserCommand, se_DeleteUserCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteUserCommand}. + */ +export interface DeleteUserCommandInput extends DeleteUserRequest {} +/** + * @public + * + * The output of {@link DeleteUserCommand}. + */ +export interface DeleteUserCommandOutput extends DeleteUserResult, __MetadataBearer {} + +/** + *Deletes a user.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, DeleteUserCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, DeleteUserCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // DeleteUserRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * ClientToken: "STRING_VALUE", + * }; + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteUserCommandInput - {@link DeleteUserCommandInput} + * @returns {@link DeleteUserCommandOutput} + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class DeleteUserCommand extends $Command + .classBuilder< + DeleteUserCommandInput, + DeleteUserCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "DeleteUser", {}) + .n("DirectoryServiceDataClient", "DeleteUserCommand") + .f(void 0, void 0) + .ser(se_DeleteUserCommand) + .de(de_DeleteUserCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteUserRequest; + output: {}; + }; + sdk: { + input: DeleteUserCommandInput; + output: DeleteUserCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/DescribeGroupCommand.ts b/clients/client-directory-service-data/src/commands/DescribeGroupCommand.ts new file mode 100644 index 0000000000000..10673d2357de5 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/DescribeGroupCommand.ts @@ -0,0 +1,142 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeGroupRequest, DescribeGroupResult, DescribeGroupResultFilterSensitiveLog } from "../models/models_0"; +import { de_DescribeGroupCommand, se_DescribeGroupCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeGroupCommand}. + */ +export interface DescribeGroupCommandInput extends DescribeGroupRequest {} +/** + * @public + * + * The output of {@link DescribeGroupCommand}. + */ +export interface DescribeGroupCommandOutput extends DescribeGroupResult, __MetadataBearer {} + +/** + *Returns information about a specific group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, DescribeGroupCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, DescribeGroupCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // DescribeGroupRequest + * DirectoryId: "STRING_VALUE", // required + * Realm: "STRING_VALUE", + * SAMAccountName: "STRING_VALUE", // required + * OtherAttributes: [ // LdapDisplayNameList + * "STRING_VALUE", + * ], + * }; + * const command = new DescribeGroupCommand(input); + * const response = await client.send(command); + * // { // DescribeGroupResult + * // DirectoryId: "STRING_VALUE", + * // Realm: "STRING_VALUE", + * // SID: "STRING_VALUE", + * // SAMAccountName: "STRING_VALUE", + * // DistinguishedName: "STRING_VALUE", + * // GroupType: "Distribution" || "Security", + * // GroupScope: "DomainLocal" || "Global" || "Universal" || "BuiltinLocal", + * // OtherAttributes: { // Attributes + * // " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class DescribeGroupCommand extends $Command + .classBuilder< + DescribeGroupCommandInput, + DescribeGroupCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "DescribeGroup", {}) + .n("DirectoryServiceDataClient", "DescribeGroupCommand") + .f(void 0, DescribeGroupResultFilterSensitiveLog) + .ser(se_DescribeGroupCommand) + .de(de_DescribeGroupCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeGroupRequest; + output: DescribeGroupResult; + }; + sdk: { + input: DescribeGroupCommandInput; + output: DescribeGroupCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/DescribeUserCommand.ts b/clients/client-directory-service-data/src/commands/DescribeUserCommand.ts new file mode 100644 index 0000000000000..22f08a2864b57 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/DescribeUserCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DescribeUserRequest, DescribeUserResult, DescribeUserResultFilterSensitiveLog } from "../models/models_0"; +import { de_DescribeUserCommand, se_DescribeUserCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DescribeUserCommand}. + */ +export interface DescribeUserCommandInput extends DescribeUserRequest {} +/** + * @public + * + * The output of {@link DescribeUserCommand}. + */ +export interface DescribeUserCommandOutput extends DescribeUserResult, __MetadataBearer {} + +/** + *Returns information about a specific user.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, DescribeUserCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, DescribeUserCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // DescribeUserRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * OtherAttributes: [ // LdapDisplayNameList + * "STRING_VALUE", + * ], + * Realm: "STRING_VALUE", + * }; + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * // { // DescribeUserResult + * // DirectoryId: "STRING_VALUE", + * // Realm: "STRING_VALUE", + * // SID: "STRING_VALUE", + * // SAMAccountName: "STRING_VALUE", + * // DistinguishedName: "STRING_VALUE", + * // UserPrincipalName: "STRING_VALUE", + * // EmailAddress: "STRING_VALUE", + * // GivenName: "STRING_VALUE", + * // Surname: "STRING_VALUE", + * // Enabled: true || false, + * // OtherAttributes: { // Attributes + * // " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class DescribeUserCommand extends $Command + .classBuilder< + DescribeUserCommandInput, + DescribeUserCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "DescribeUser", {}) + .n("DirectoryServiceDataClient", "DescribeUserCommand") + .f(void 0, DescribeUserResultFilterSensitiveLog) + .ser(se_DescribeUserCommand) + .de(de_DescribeUserCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DescribeUserRequest; + output: DescribeUserResult; + }; + sdk: { + input: DescribeUserCommandInput; + output: DescribeUserCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/DisableUserCommand.ts b/clients/client-directory-service-data/src/commands/DisableUserCommand.ts new file mode 100644 index 0000000000000..24e56f067ec69 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/DisableUserCommand.ts @@ -0,0 +1,132 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { DisableUserRequest, DisableUserResult } from "../models/models_0"; +import { de_DisableUserCommand, se_DisableUserCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DisableUserCommand}. + */ +export interface DisableUserCommandInput extends DisableUserRequest {} +/** + * @public + * + * The output of {@link DisableUserCommand}. + */ +export interface DisableUserCommandOutput extends DisableUserResult, __MetadataBearer {} + +/** + *Deactivates an active user account. For information about how to enable an inactive user + * account, see ResetUserPassword + * in the Directory Service API Reference.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, DisableUserCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, DisableUserCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // DisableUserRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * ClientToken: "STRING_VALUE", + * }; + * const command = new DisableUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DisableUserCommandInput - {@link DisableUserCommandInput} + * @returns {@link DisableUserCommandOutput} + * @see {@link DisableUserCommandInput} for command's `input` shape. + * @see {@link DisableUserCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class DisableUserCommand extends $Command + .classBuilder< + DisableUserCommandInput, + DisableUserCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "DisableUser", {}) + .n("DirectoryServiceDataClient", "DisableUserCommand") + .f(void 0, void 0) + .ser(se_DisableUserCommand) + .de(de_DisableUserCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DisableUserRequest; + output: {}; + }; + sdk: { + input: DisableUserCommandInput; + output: DisableUserCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/ListGroupMembersCommand.ts b/clients/client-directory-service-data/src/commands/ListGroupMembersCommand.ts new file mode 100644 index 0000000000000..9787bd9b873fd --- /dev/null +++ b/clients/client-directory-service-data/src/commands/ListGroupMembersCommand.ts @@ -0,0 +1,147 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListGroupMembersRequest, + ListGroupMembersRequestFilterSensitiveLog, + ListGroupMembersResult, + ListGroupMembersResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListGroupMembersCommand, se_ListGroupMembersCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListGroupMembersCommand}. + */ +export interface ListGroupMembersCommandInput extends ListGroupMembersRequest {} +/** + * @public + * + * The output of {@link ListGroupMembersCommand}. + */ +export interface ListGroupMembersCommandOutput extends ListGroupMembersResult, __MetadataBearer {} + +/** + *Returns member information for the specified group.
+ * This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the
+ * ListGroupMembers.NextToken member contains a token that you pass in the next
+ * call to ListGroupMembers. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class ListGroupMembersCommand extends $Command + .classBuilder< + ListGroupMembersCommandInput, + ListGroupMembersCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "ListGroupMembers", {}) + .n("DirectoryServiceDataClient", "ListGroupMembersCommand") + .f(ListGroupMembersRequestFilterSensitiveLog, ListGroupMembersResultFilterSensitiveLog) + .ser(se_ListGroupMembersCommand) + .de(de_ListGroupMembersCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListGroupMembersRequest; + output: ListGroupMembersResult; + }; + sdk: { + input: ListGroupMembersCommandInput; + output: ListGroupMembersCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/ListGroupsCommand.ts b/clients/client-directory-service-data/src/commands/ListGroupsCommand.ts new file mode 100644 index 0000000000000..3eef967f0af09 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/ListGroupsCommand.ts @@ -0,0 +1,142 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListGroupsRequest, + ListGroupsRequestFilterSensitiveLog, + ListGroupsResult, + ListGroupsResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListGroupsCommand, se_ListGroupsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListGroupsCommand}. + */ +export interface ListGroupsCommandInput extends ListGroupsRequest {} +/** + * @public + * + * The output of {@link ListGroupsCommand}. + */ +export interface ListGroupsCommandOutput extends ListGroupsResult, __MetadataBearer {} + +/** + *Returns group information for the specified directory.
+ * This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the ListGroups.NextToken
+ * member contains a token that you pass in the next call to ListGroups. This
+ * retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class ListGroupsCommand extends $Command + .classBuilder< + ListGroupsCommandInput, + ListGroupsCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "ListGroups", {}) + .n("DirectoryServiceDataClient", "ListGroupsCommand") + .f(ListGroupsRequestFilterSensitiveLog, ListGroupsResultFilterSensitiveLog) + .ser(se_ListGroupsCommand) + .de(de_ListGroupsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListGroupsRequest; + output: ListGroupsResult; + }; + sdk: { + input: ListGroupsCommandInput; + output: ListGroupsCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/ListGroupsForMemberCommand.ts b/clients/client-directory-service-data/src/commands/ListGroupsForMemberCommand.ts new file mode 100644 index 0000000000000..88eab3abb7068 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/ListGroupsForMemberCommand.ts @@ -0,0 +1,148 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListGroupsForMemberRequest, + ListGroupsForMemberRequestFilterSensitiveLog, + ListGroupsForMemberResult, + ListGroupsForMemberResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListGroupsForMemberCommand, se_ListGroupsForMemberCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListGroupsForMemberCommand}. + */ +export interface ListGroupsForMemberCommandInput extends ListGroupsForMemberRequest {} +/** + * @public + * + * The output of {@link ListGroupsForMemberCommand}. + */ +export interface ListGroupsForMemberCommandOutput extends ListGroupsForMemberResult, __MetadataBearer {} + +/** + *Returns group information for the specified member.
+ * This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the
+ * ListGroupsForMember.NextToken member contains a token that you pass in the next
+ * call to ListGroupsForMember. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class ListGroupsForMemberCommand extends $Command + .classBuilder< + ListGroupsForMemberCommandInput, + ListGroupsForMemberCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "ListGroupsForMember", {}) + .n("DirectoryServiceDataClient", "ListGroupsForMemberCommand") + .f(ListGroupsForMemberRequestFilterSensitiveLog, ListGroupsForMemberResultFilterSensitiveLog) + .ser(se_ListGroupsForMemberCommand) + .de(de_ListGroupsForMemberCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListGroupsForMemberRequest; + output: ListGroupsForMemberResult; + }; + sdk: { + input: ListGroupsForMemberCommandInput; + output: ListGroupsForMemberCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/ListUsersCommand.ts b/clients/client-directory-service-data/src/commands/ListUsersCommand.ts new file mode 100644 index 0000000000000..0b7a46cd6e677 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/ListUsersCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListUsersRequest, + ListUsersRequestFilterSensitiveLog, + ListUsersResult, + ListUsersResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListUsersCommand, se_ListUsersCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListUsersCommand}. + */ +export interface ListUsersCommandInput extends ListUsersRequest {} +/** + * @public + * + * The output of {@link ListUsersCommand}. + */ +export interface ListUsersCommandOutput extends ListUsersResult, __MetadataBearer {} + +/** + *Returns user information for the specified directory.
+ * This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the ListUsers.NextToken
+ * member contains a token that you pass in the next call to ListUsers. This
+ * retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class ListUsersCommand extends $Command + .classBuilder< + ListUsersCommandInput, + ListUsersCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "ListUsers", {}) + .n("DirectoryServiceDataClient", "ListUsersCommand") + .f(ListUsersRequestFilterSensitiveLog, ListUsersResultFilterSensitiveLog) + .ser(se_ListUsersCommand) + .de(de_ListUsersCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListUsersRequest; + output: ListUsersResult; + }; + sdk: { + input: ListUsersCommandInput; + output: ListUsersCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/RemoveGroupMemberCommand.ts b/clients/client-directory-service-data/src/commands/RemoveGroupMemberCommand.ts new file mode 100644 index 0000000000000..af89119414da5 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/RemoveGroupMemberCommand.ts @@ -0,0 +1,132 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { RemoveGroupMemberRequest, RemoveGroupMemberResult } from "../models/models_0"; +import { de_RemoveGroupMemberCommand, se_RemoveGroupMemberCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RemoveGroupMemberCommand}. + */ +export interface RemoveGroupMemberCommandInput extends RemoveGroupMemberRequest {} +/** + * @public + * + * The output of {@link RemoveGroupMemberCommand}. + */ +export interface RemoveGroupMemberCommandOutput extends RemoveGroupMemberResult, __MetadataBearer {} + +/** + *Removes a member from a group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, RemoveGroupMemberCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, RemoveGroupMemberCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // RemoveGroupMemberRequest + * DirectoryId: "STRING_VALUE", // required + * GroupName: "STRING_VALUE", // required + * MemberName: "STRING_VALUE", // required + * MemberRealm: "STRING_VALUE", + * ClientToken: "STRING_VALUE", + * }; + * const command = new RemoveGroupMemberCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param RemoveGroupMemberCommandInput - {@link RemoveGroupMemberCommandInput} + * @returns {@link RemoveGroupMemberCommandOutput} + * @see {@link RemoveGroupMemberCommandInput} for command's `input` shape. + * @see {@link RemoveGroupMemberCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class RemoveGroupMemberCommand extends $Command + .classBuilder< + RemoveGroupMemberCommandInput, + RemoveGroupMemberCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "RemoveGroupMember", {}) + .n("DirectoryServiceDataClient", "RemoveGroupMemberCommand") + .f(void 0, void 0) + .ser(se_RemoveGroupMemberCommand) + .de(de_RemoveGroupMemberCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: RemoveGroupMemberRequest; + output: {}; + }; + sdk: { + input: RemoveGroupMemberCommandInput; + output: RemoveGroupMemberCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/SearchGroupsCommand.ts b/clients/client-directory-service-data/src/commands/SearchGroupsCommand.ts new file mode 100644 index 0000000000000..cb481ef731241 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/SearchGroupsCommand.ts @@ -0,0 +1,159 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + SearchGroupsRequest, + SearchGroupsRequestFilterSensitiveLog, + SearchGroupsResult, + SearchGroupsResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_SearchGroupsCommand, se_SearchGroupsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link SearchGroupsCommand}. + */ +export interface SearchGroupsCommandInput extends SearchGroupsRequest {} +/** + * @public + * + * The output of {@link SearchGroupsCommand}. + */ +export interface SearchGroupsCommandOutput extends SearchGroupsResult, __MetadataBearer {} + +/** + * Searches the specified directory for a group. You can find groups that match the
+ * SearchString parameter with the value of their attributes included in the
+ * SearchString parameter.
This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the SearchGroups.NextToken
+ * member contains a token that you pass in the next call to SearchGroups. This
+ * retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class SearchGroupsCommand extends $Command + .classBuilder< + SearchGroupsCommandInput, + SearchGroupsCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "SearchGroups", {}) + .n("DirectoryServiceDataClient", "SearchGroupsCommand") + .f(SearchGroupsRequestFilterSensitiveLog, SearchGroupsResultFilterSensitiveLog) + .ser(se_SearchGroupsCommand) + .de(de_SearchGroupsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SearchGroupsRequest; + output: SearchGroupsResult; + }; + sdk: { + input: SearchGroupsCommandInput; + output: SearchGroupsCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/SearchUsersCommand.ts b/clients/client-directory-service-data/src/commands/SearchUsersCommand.ts new file mode 100644 index 0000000000000..dfa9829da1399 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/SearchUsersCommand.ts @@ -0,0 +1,162 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + SearchUsersRequest, + SearchUsersRequestFilterSensitiveLog, + SearchUsersResult, + SearchUsersResultFilterSensitiveLog, +} from "../models/models_0"; +import { de_SearchUsersCommand, se_SearchUsersCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link SearchUsersCommand}. + */ +export interface SearchUsersCommandInput extends SearchUsersRequest {} +/** + * @public + * + * The output of {@link SearchUsersCommand}. + */ +export interface SearchUsersCommandOutput extends SearchUsersResult, __MetadataBearer {} + +/** + * Searches the specified directory for a user. You can find users that match the
+ * SearchString parameter with the value of their attributes included in the
+ * SearchString parameter.
This operation supports pagination with the use of the NextToken request and
+ * response parameters. If more results are available, the SearchUsers.NextToken
+ * member contains a token that you pass in the next call to SearchUsers. This
+ * retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults
+ * parameter.
You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class SearchUsersCommand extends $Command + .classBuilder< + SearchUsersCommandInput, + SearchUsersCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "SearchUsers", {}) + .n("DirectoryServiceDataClient", "SearchUsersCommand") + .f(SearchUsersRequestFilterSensitiveLog, SearchUsersResultFilterSensitiveLog) + .ser(se_SearchUsersCommand) + .de(de_SearchUsersCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: SearchUsersRequest; + output: SearchUsersResult; + }; + sdk: { + input: SearchUsersCommandInput; + output: SearchUsersCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/UpdateGroupCommand.ts b/clients/client-directory-service-data/src/commands/UpdateGroupCommand.ts new file mode 100644 index 0000000000000..59105d58a08f8 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/UpdateGroupCommand.ts @@ -0,0 +1,143 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateGroupRequest, UpdateGroupRequestFilterSensitiveLog, UpdateGroupResult } from "../models/models_0"; +import { de_UpdateGroupCommand, se_UpdateGroupCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateGroupCommand}. + */ +export interface UpdateGroupCommandInput extends UpdateGroupRequest {} +/** + * @public + * + * The output of {@link UpdateGroupCommand}. + */ +export interface UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataBearer {} + +/** + *Updates group information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, UpdateGroupCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, UpdateGroupCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // UpdateGroupRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * GroupType: "Distribution" || "Security", + * GroupScope: "DomainLocal" || "Global" || "Universal" || "BuiltinLocal", + * OtherAttributes: { // Attributes + * " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class UpdateGroupCommand extends $Command + .classBuilder< + UpdateGroupCommandInput, + UpdateGroupCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "UpdateGroup", {}) + .n("DirectoryServiceDataClient", "UpdateGroupCommand") + .f(UpdateGroupRequestFilterSensitiveLog, void 0) + .ser(se_UpdateGroupCommand) + .de(de_UpdateGroupCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateGroupRequest; + output: {}; + }; + sdk: { + input: UpdateGroupCommandInput; + output: UpdateGroupCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/UpdateUserCommand.ts b/clients/client-directory-service-data/src/commands/UpdateUserCommand.ts new file mode 100644 index 0000000000000..e26885a697ebb --- /dev/null +++ b/clients/client-directory-service-data/src/commands/UpdateUserCommand.ts @@ -0,0 +1,144 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../DirectoryServiceDataClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateUserRequest, UpdateUserRequestFilterSensitiveLog, UpdateUserResult } from "../models/models_0"; +import { de_UpdateUserCommand, se_UpdateUserCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateUserCommand}. + */ +export interface UpdateUserCommandInput extends UpdateUserRequest {} +/** + * @public + * + * The output of {@link UpdateUserCommand}. + */ +export interface UpdateUserCommandOutput extends UpdateUserResult, __MetadataBearer {} + +/** + *Updates user information.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceDataClient, UpdateUserCommand } from "@aws-sdk/client-directory-service-data"; // ES Modules import + * // const { DirectoryServiceDataClient, UpdateUserCommand } = require("@aws-sdk/client-directory-service-data"); // CommonJS import + * const client = new DirectoryServiceDataClient(config); + * const input = { // UpdateUserRequest + * DirectoryId: "STRING_VALUE", // required + * SAMAccountName: "STRING_VALUE", // required + * EmailAddress: "STRING_VALUE", + * GivenName: "STRING_VALUE", + * Surname: "STRING_VALUE", + * OtherAttributes: { // Attributes + * " You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * + * @throws {@link ConflictException} (client fault) + *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * + * @throws {@link DirectoryUnavailableException} (client fault) + *The request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * + * @throws {@link InternalServerException} (server fault) + *The operation didn't succeed because an internal error occurred. Try again later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The limit on the number of requests per second has been exceeded.
+ * + * @throws {@link ValidationException} (client fault) + *The request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * + * @throws {@link DirectoryServiceDataServiceException} + *Base exception class for all service exceptions from DirectoryServiceData service.
+ * + * @public + */ +export class UpdateUserCommand extends $Command + .classBuilder< + UpdateUserCommandInput, + UpdateUserCommandOutput, + DirectoryServiceDataClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: DirectoryServiceDataClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("DirectoryServiceData", "UpdateUser", {}) + .n("DirectoryServiceDataClient", "UpdateUserCommand") + .f(UpdateUserRequestFilterSensitiveLog, void 0) + .ser(se_UpdateUserCommand) + .de(de_UpdateUserCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateUserRequest; + output: {}; + }; + sdk: { + input: UpdateUserCommandInput; + output: UpdateUserCommandOutput; + }; + }; +} diff --git a/clients/client-directory-service-data/src/commands/index.ts b/clients/client-directory-service-data/src/commands/index.ts new file mode 100644 index 0000000000000..47afdb5736307 --- /dev/null +++ b/clients/client-directory-service-data/src/commands/index.ts @@ -0,0 +1,18 @@ +// smithy-typescript generated code +export * from "./AddGroupMemberCommand"; +export * from "./CreateGroupCommand"; +export * from "./CreateUserCommand"; +export * from "./DeleteGroupCommand"; +export * from "./DeleteUserCommand"; +export * from "./DescribeGroupCommand"; +export * from "./DescribeUserCommand"; +export * from "./DisableUserCommand"; +export * from "./ListGroupMembersCommand"; +export * from "./ListGroupsCommand"; +export * from "./ListGroupsForMemberCommand"; +export * from "./ListUsersCommand"; +export * from "./RemoveGroupMemberCommand"; +export * from "./SearchGroupsCommand"; +export * from "./SearchUsersCommand"; +export * from "./UpdateGroupCommand"; +export * from "./UpdateUserCommand"; diff --git a/clients/client-directory-service-data/src/endpoint/EndpointParameters.ts b/clients/client-directory-service-data/src/endpoint/EndpointParameters.ts new file mode 100644 index 0000000000000..2767d13ee97ba --- /dev/null +++ b/clients/client-directory-service-data/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderAmazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information + * about Directory Service Data operations and object types.
+ * With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from
+ * your Managed Microsoft AD without additional costs and without deploying dedicated management
+ * instances. You can also perform built-in object management tasks across directories without
+ * direct network connectivity, which simplifies provisioning and access management to achieve
+ * fully automated deployments. Directory Service Data supports user and group write operations, such as
+ * CreateUser and CreateGroup, within the organizational unit (OU) of
+ * your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and
+ * ListGroups, on all users, groups, and group memberships within your
+ * Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in
+ * your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles
+ * and permissions. For more information, see Manage users and
+ * groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service + * API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay + * between management changes, such as adding a new directory trust and calling the Directory Service Data API + * for the newly created trusted realm.
+ *Directory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on + * underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain + * controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data + * uses an available domain controller. As a result, you might notice eventual consistency while + * objects replicate from one domain controller to another domain controller. For more + * information, see What + * gets created in the Directory Service Administration Guide. + * Directory limits vary by Managed Microsoft AD edition:
+ *+ * Standard edition – Supports 8 transactions per + * second (TPS) for read operations and 4 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Enterprise edition – Supports 16 transactions per + * second (TPS) for read operations and 8 TPS for write operations per directory. There's a + * concurrency limit of 10 concurrent requests.
+ *+ * Amazon Web Services Account - Supports a total of 100 TPS for + * Directory Service Data operations across all directories.
+ *Directory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary + * Amazon Web Services Region. For more information, see Managed Microsoft AD + * and Primary vs additional Regions in the Directory Service Administration + * Guide.
+ * + * @packageDocumentation + */ +export * from "./DirectoryServiceDataClient"; +export * from "./DirectoryServiceData"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export type { RuntimeExtension } from "./runtimeExtensions"; +export type { DirectoryServiceDataExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { DirectoryServiceDataServiceException } from "./models/DirectoryServiceDataServiceException"; diff --git a/clients/client-directory-service-data/src/models/DirectoryServiceDataServiceException.ts b/clients/client-directory-service-data/src/models/DirectoryServiceDataServiceException.ts new file mode 100644 index 0000000000000..3acfae7749b22 --- /dev/null +++ b/clients/client-directory-service-data/src/models/DirectoryServiceDataServiceException.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export type { __ServiceExceptionOptions }; + +export { __ServiceException }; + +/** + * @public + * + * Base exception class for all service exceptions from DirectoryServiceData service. + */ +export class DirectoryServiceDataServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, DirectoryServiceDataServiceException.prototype); + } +} diff --git a/clients/client-directory-service-data/src/models/index.ts b/clients/client-directory-service-data/src/models/index.ts new file mode 100644 index 0000000000000..9eaceb12865f8 --- /dev/null +++ b/clients/client-directory-service-data/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-directory-service-data/src/models/models_0.ts b/clients/client-directory-service-data/src/models/models_0.ts new file mode 100644 index 0000000000000..6915cef8fe5cf --- /dev/null +++ b/clients/client-directory-service-data/src/models/models_0.ts @@ -0,0 +1,2061 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { DirectoryServiceDataServiceException as __BaseException } from "./DirectoryServiceDataServiceException"; + +/** + * @public + * @enum + */ +export const AccessDeniedReason = { + DATA_DISABLED: "DATA_DISABLED", + DIRECTORY_AUTH: "DIRECTORY_AUTH", + IAM_AUTH: "IAM_AUTH", +} as const; + +/** + * @public + */ +export type AccessDeniedReason = (typeof AccessDeniedReason)[keyof typeof AccessDeniedReason]; + +/** + * You don't have permission to perform the request or access the directory. It can also
+ * occur when the DirectoryId doesn't exist or the user, member, or group might be
+ * outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action. + * Review the directory information in the request, and make sure that the object isn't outside + * of your OU.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + *Reason the request was unauthorized.
+ * @public + */ + Reason?: AccessDeniedReason; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the group.
+ * @public + */ + GroupName: string | undefined; + + /** + * The SAMAccountName of the user, group, or computer to add as a group member.
+ *
The domain name that's associated with the group member. This parameter is required only + * when adding a member outside of your Managed Microsoft AD domain to a group inside of your + * Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain.
+ *This parameter is case insensitive.
+ *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *This error will occur when you try to create a resource that conflicts with an existing + * object. It can also occur when adding a member to a group that the member is already + * in.
+ *This error can be caused by a request sent within the 8-hour idempotency window with the + * same client token but different input parameters. Client tokens should not be re-used across + * different requests. After 8 hours, any request with the same client token is treated as a new + * request.
+ * @public + */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request could not be completed due to a problem in the configuration or current state + * of the specified directory.
+ * @public + */ +export class DirectoryUnavailableException extends __BaseException { + readonly name: "DirectoryUnavailableException" = "DirectoryUnavailableException"; + readonly $fault: "client" = "client"; + $retryable = {}; + Message?: string; + /** + *Reason the request failed for the specified directory.
+ * @public + */ + Reason?: DirectoryUnavailableReason; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe operation didn't succeed because an internal error occurred. Try again later.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe resource couldn't be found.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe limit on the number of requests per second has been exceeded.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = { + throttling: true, + }; + Message: string | undefined; + /** + *The recommended amount of seconds to retry after a throttling exception.
+ * @public + */ + RetryAfterSeconds?: number; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request isn't valid. Review the details in the error message to update the invalid + * parameters or values in your request.
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + *Reason the request failed validation.
+ * @public + */ + Reason?: ValidationExceptionReason; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe data type for an attribute. Each attribute value is described as a name-value pair. + * The name is the AD schema name, and the value is the data itself. For a list of supported + * attributes, see Directory Service Data Attributes. + *
+ * @public + */ +export type AttributeValue = + | AttributeValue.BOOLMember + | AttributeValue.NMember + | AttributeValue.SMember + | AttributeValue.SSMember + | AttributeValue.$UnknownMember; + +/** + * @public + */ +export namespace AttributeValue { + /** + *Indicates that the attribute type value is a string. For example:
+ *
+ * "S": "S Group"
+ *
Indicates that the attribute type value is a number. For example:
+ *
+ * "N": "16"
+ *
Indicates that the attribute type value is a boolean. For example:
+ *
+ * "BOOL": true
+ *
Indicates that the attribute type value is a string set. For example:
+ *
+ * "SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1",
+ * "sample_service_class/host.sample.com:1234/sample_service_name_2"]
+ *
The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The AD group type. For details, see Active Directory security group type.
+ * @public + */ + GroupType?: GroupType; + + /** + *The scope of the AD group. For details, see Active Directory security group scope.
+ * @public + */ + GroupScope?: GroupScope; + + /** + *An expression that defines one or more attributes with the data type and value of each + * attribute.
+ * @public + */ + OtherAttributes?: RecordA unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId?: string; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName?: string; + + /** + *The unique security identifier (SID) of the group.
+ * @public + */ + SID?: string; +} + +/** + * @public + */ +export interface CreateUserRequest { + /** + *The identifier (ID) of the directory that’s associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The email address of the user.
+ * @public + */ + EmailAddress?: string; + + /** + *The first name of the user.
+ * @public + */ + GivenName?: string; + + /** + *The last name of the user.
+ * @public + */ + Surname?: string; + + /** + *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 Directory Service Data Attributes.
+ *Attribute names are case insensitive.
+ *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory where the address block is added.
+ * @public + */ + DirectoryId?: string; + + /** + *The unique security identifier (SID) of the user.
+ * @public + */ + SID?: string; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName?: string; +} + +/** + * @public + */ +export interface DeleteGroupRequest { + /** + *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The Identifier (ID) of the directory associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name that's associated with the group.
+ *This parameter is optional, so you can return groups outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD groups are returned.
+ *This value is case insensitive.
+ *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *One or more attributes to be returned for the group. For a list of supported attributes, + * see Directory Service Data Attributes. + *
+ * @public + */ + OtherAttributes?: string[]; +} + +/** + * @public + */ +export interface DescribeGroupResult { + /** + *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain name that's associated with the group.
+ * @public + */ + Realm?: string; + + /** + *The unique security identifier (SID) of the group.
+ * @public + */ + SID?: string; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName?: string; + + /** + *The distinguished name of the object.
+ * @public + */ + DistinguishedName?: string; + + /** + *The AD group type. For details, see Active Directory security group type.
+ * @public + */ + GroupType?: GroupType; + + /** + *The scope of the AD group. For details, see Active Directory security groups.
+ * @public + */ + GroupScope?: GroupScope; + + /** + *The attribute values that are returned for the attribute names that are included in the + * request.
+ * @public + */ + OtherAttributes?: RecordThe identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *One or more attribute names to be returned for the user. A key is an attribute name, and + * the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.
+ * @public + */ + OtherAttributes?: string[]; + + /** + *The domain name that's associated with the user.
+ *This parameter is optional, so you can return users outside your Managed Microsoft AD domain. + * When no value is defined, only your Managed Microsoft AD users are returned.
+ *This value is case insensitive.
+ *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain name that's associated with the user.
+ * @public + */ + Realm?: string; + + /** + *The unique security identifier (SID) of the user.
+ * @public + */ + SID?: string; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName?: string; + + /** + *The distinguished name of the object.
+ * @public + */ + DistinguishedName?: string; + + /** + *The UPN that is an Internet-style login name for a user and is based on the Internet + * standard RFC 822. The UPN is shorter + * than the distinguished name and easier to remember.
+ * @public + */ + UserPrincipalName?: string; + + /** + *The email address of the user.
+ * @public + */ + EmailAddress?: string; + + /** + *The first name of the user.
+ * @public + */ + GivenName?: string; + + /** + *The last name of the user.
+ * @public + */ + Surname?: string; + + /** + *Indicates whether the user account is active.
+ * @public + */ + Enabled?: boolean; + + /** + *The attribute values that are returned for the attribute names that are included in the + * request.
+ *Attribute names are case insensitive.
+ *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name that's associated with the group.
+ *This parameter is optional, so you can return members from a group outside of your + * Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are + * returned.
+ *This value is case insensitive.
+ *The domain name that's associated with the group member. This parameter defaults to the + * Managed Microsoft AD domain.
+ *This parameter is optional and case insensitive.
+ *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + * @public + * @enum + */ +export const MemberType = { + COMPUTER: "COMPUTER", + GROUP: "GROUP", + USER: "USER", +} as const; + +/** + * @public + */ +export type MemberType = (typeof MemberType)[keyof typeof MemberType]; + +/** + *A member object that contains identifying information for a specified member.
+ * @public + */ +export interface Member { + /** + *The unique security identifier (SID) of the group member.
+ * @public + */ + SID: string | undefined; + + /** + *The name of the group member.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The AD type of the member object.
+ * @public + */ + MemberType: MemberType | undefined; +} + +/** + * @public + */ +export interface ListGroupMembersResult { + /** + *Identifier (ID) of the directory associated with the group.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain name that's associated with the group.
+ * @public + */ + Realm?: string; + + /** + *The domain name that's associated with the member.
+ * @public + */ + MemberRealm?: string; + + /** + *The member information that the request returns.
+ * @public + */ + Members?: Member[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListGroupsRequest { + /** + *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name associated with the directory.
+ *This parameter is optional, so you can return groups outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD groups are returned.
+ *This value is case insensitive.
+ *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + *A structure containing a subset of fields of a group object from a directory.
+ * @public + */ +export interface GroupSummary { + /** + *The unique security identifier (SID) of the group.
+ * @public + */ + SID: string | undefined; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The AD group type. For details, see Active Directory security group type.
+ * @public + */ + GroupType: GroupType | undefined; + + /** + *The scope of the AD group. For details, see Active Directory security groups.
+ * @public + */ + GroupScope: GroupScope | undefined; +} + +/** + * @public + */ +export interface ListGroupsResult { + /** + *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain name associated with the group.
+ * @public + */ + Realm?: string; + + /** + *The group information that the request returns.
+ * @public + */ + Groups?: GroupSummary[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListGroupsForMemberRequest { + /** + *The identifier (ID) of the directory that's associated with the member.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name that's associated with the group.
+ *This parameter is optional, so you can return groups outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD groups are returned.
+ *This value is case insensitive and defaults to your Managed Microsoft AD domain.
+ *The domain name that's associated with the group member.
+ *This parameter is optional, so you can limit your results to the group members in a + * specific domain.
+ * This parameter is case insensitive and defaults to Realm
+ *
The SAMAccountName of the user, group, or computer that's a member of the
+ * group.
An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListGroupsForMemberResult { + /** + *The identifier (ID) of the directory that's associated with the member.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain that's associated with the group.
+ * @public + */ + Realm?: string; + + /** + *The domain that's associated with the member.
+ * @public + */ + MemberRealm?: string; + + /** + *The group information that the request returns.
+ * @public + */ + Groups?: GroupSummary[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListUsersRequest { + /** + *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name that's associated with the user.
+ *This parameter is optional, so you can return users outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD users are returned.
+ *This value is case insensitive.
+ *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + *A structure containing a subset of the fields of a user object from a directory.
+ * @public + */ +export interface UserSummary { + /** + *The unique security identifier (SID) of the user.
+ * @public + */ + SID: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The first name of the user.
+ * @public + */ + GivenName?: string; + + /** + *The last name of the user.
+ * @public + */ + Surname?: string; + + /** + *Indicates whether the user account is active.
+ * @public + */ + Enabled: boolean | undefined; +} + +/** + * @public + */ +export interface ListUsersResult { + /** + *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain that's associated with the user.
+ * @public + */ + Realm?: string; + + /** + *The user information that the request returns.
+ * @public + */ + Users?: UserSummary[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + */ +export interface RemoveGroupMemberRequest { + /** + *The identifier (ID) of the directory that's associated with the member.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the group.
+ * @public + */ + GroupName: string | undefined; + + /** + * The SAMAccountName of the user, group, or computer to remove from the group.
+ *
The domain name that's associated with the group member. This parameter defaults to the + * Managed Microsoft AD domain.
+ *This parameter is optional and case insensitive.
+ *A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The attribute value that you want to search for.
+ * Wildcard (*) searches aren't supported. For a list of supported
+ * attributes, see Directory Service Data
+ * Attributes.
One or more data attributes that are used to search for a group. For a list of supported + * attributes, see Directory Service Data Attributes. + *
+ * @public + */ + SearchAttributes: string[] | undefined; + + /** + *The domain name that's associated with the group.
+ *This parameter is optional, so you can return groups outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD groups are returned.
+ *This value is case insensitive.
+ *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + *A group object that contains identifying information and attributes for a specified + * group.
+ * @public + */ +export interface Group { + /** + *The unique security identifier (SID) of the group.
+ * @public + */ + SID?: string; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The distinguished name of the object.
+ * @public + */ + DistinguishedName?: string; + + /** + *The AD group type. For details, see Active Directory security group type.
+ * @public + */ + GroupType?: GroupType; + + /** + *The scope of the AD group. For details, see Active Directory security groups + *
+ * @public + */ + GroupScope?: GroupScope; + + /** + *An expression of one or more attributes, data types, and the values of a group.
+ * @public + */ + OtherAttributes?: RecordThe identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain that's associated with the group.
+ * @public + */ + Realm?: string; + + /** + *The group information that the request returns.
+ * @public + */ + Groups?: Group[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + */ +export interface SearchUsersRequest { + /** + *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The domain name that's associated with the user.
+ *This parameter is optional, so you can return users outside of your Managed Microsoft AD + * domain. When no value is defined, only your Managed Microsoft AD users are returned.
+ *This value is case insensitive.
+ *The attribute value that you want to search for.
+ * Wildcard (*) searches aren't supported. For a list of supported
+ * attributes, see Directory Service Data
+ * Attributes.
One or more data attributes that are used to search for a user. For a list of supported + * attributes, see Directory Service Data Attributes. + *
+ * @public + */ + SearchAttributes: string[] | undefined; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to be returned per request.
+ * @public + */ + MaxResults?: number; +} + +/** + *A user object that contains identifying information and attributes for a specified user. + *
+ * @public + */ +export interface User { + /** + *The unique security identifier (SID) of the user.
+ * @public + */ + SID?: string; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The distinguished name of the object.
+ * @public + */ + DistinguishedName?: string; + + /** + *The UPN that is an internet-style login name for a user and based on the internet + * standard RFC 822. The UPN is shorter + * than the distinguished name and easier to remember.
+ * @public + */ + UserPrincipalName?: string; + + /** + *The email address of the user.
+ * @public + */ + EmailAddress?: string; + + /** + *The first name of the user.
+ * @public + */ + GivenName?: string; + + /** + *The last name of the user.
+ * @public + */ + Surname?: string; + + /** + *Indicates whether the user account is active.
+ * @public + */ + Enabled?: boolean; + + /** + *An expression that includes one or more attributes, data types, and values of a + * user.
+ * @public + */ + OtherAttributes?: RecordThe identifier (ID) of the directory where the address block is added.
+ * @public + */ + DirectoryId?: string; + + /** + *The domain that's associated with the user.
+ * @public + */ + Realm?: string; + + /** + *The user information that the request returns.
+ * @public + */ + Users?: User[]; + + /** + *An encoded paging token for paginated calls that can be passed back to retrieve the next + * page.
+ * @public + */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const UpdateType = { + ADD: "ADD", + REMOVE: "REMOVE", + REPLACE: "REPLACE", +} as const; + +/** + * @public + */ +export type UpdateType = (typeof UpdateType)[keyof typeof UpdateType]; + +/** + * @public + */ +export interface UpdateGroupRequest { + /** + *The identifier (ID) of the directory that's associated with the group.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the group.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The AD group type. For details, see Active Directory security group type.
+ * @public + */ + GroupType?: GroupType; + + /** + *The scope of the AD group. For details, see Active Directory security groups.
+ * @public + */ + GroupScope?: GroupScope; + + /** + *An expression that defines one or more attributes with the data type and the value of + * each attribute.
+ * @public + */ + OtherAttributes?: Record The type of update to be performed. If no value exists for the attribute, use
+ * ADD. Otherwise, use REPLACE to change an attribute value or
+ * REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *The identifier (ID) of the directory that's associated with the user.
+ * @public + */ + DirectoryId: string | undefined; + + /** + *The name of the user.
+ * @public + */ + SAMAccountName: string | undefined; + + /** + *The email address of the user.
+ * @public + */ + EmailAddress?: string; + + /** + *The first name of the user.
+ * @public + */ + GivenName?: string; + + /** + *The last name of the user.
+ * @public + */ + Surname?: string; + + /** + *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 Directory Service Data Attributes.
+ *Attribute names are case insensitive.
+ * The type of update to be performed. If no value exists for the attribute, use
+ * ADD. Otherwise, use REPLACE to change an attribute value or
+ * REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of + * the request, so multiple identical calls have the same effect as one single call.
+ *A client token is valid for 8 hours after the first request that uses it completes. After + * 8 hours, any request with the same client token is treated as a new request. If the request + * succeeds, any future uses of that token will be idempotent for another 8 hours.
+ * If you submit a request with the same client token but change one of the other parameters
+ * within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
+ *Reason the request was unauthorized.
" + } + } + }, + "traits": { + "smithy.api#documentation": " You don't have permission to perform the request or access the directory. It can also\n occur when the DirectoryId doesn't exist or the user, member, or group might be\n outside of your organizational unit (OU).
Make sure that you have the authentication and authorization to perform the action.\n Review the directory information in the request, and make sure that the object isn't outside\n of your OU.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.directoryservicedata#AccessDeniedReason": { + "type": "enum", + "members": { + "IAM_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_AUTH" + } + }, + "DIRECTORY_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_AUTH" + } + }, + "DATA_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_DISABLED" + } + } + } + }, + "com.amazonaws.directoryservicedata#AddGroupMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#AddGroupMemberRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#AddGroupMemberResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds an existing user, group, or computer as a group member.
", + "smithy.api#http": { + "uri": "/GroupMemberships/AddGroupMember", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#AddGroupMemberRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "MemberName": { + "target": "com.amazonaws.directoryservicedata#MemberName", + "traits": { + "smithy.api#documentation": " The SAMAccountName of the user, group, or computer to add as a group member.\n
The domain name that's associated with the group member. This parameter is required only\n when adding a member outside of your Managed Microsoft AD domain to a group inside of your\n Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain.
\nThis parameter is case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nIndicates that the attribute type value is a string. For example:
\n\n \"S\": \"S Group\"\n
Indicates that the attribute type value is a number. For example:
\n\n \"N\": \"16\"\n
Indicates that the attribute type value is a boolean. For example:
\n\n \"BOOL\": true\n
Indicates that the attribute type value is a string set. For example:
\n\n \"SS\": [\"sample_service_class/host.sample.com:1234/sample_service_name_1\",\n \"sample_service_class/host.sample.com:1234/sample_service_name_2\"]\n
The data type for an attribute. Each attribute value is described as a name-value pair.\n The name is the AD schema name, and the value is the data itself. For a list of supported\n attributes, see Directory Service Data Attributes.\n
" + } + }, + "com.amazonaws.directoryservicedata#Attributes": { + "type": "map", + "key": { + "target": "com.amazonaws.directoryservicedata#LdapDisplayName" + }, + "value": { + "target": "com.amazonaws.directoryservicedata#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.directoryservicedata#BooleanAttributeValue": { + "type": "boolean", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\x00-\\x7F]+$" + } + }, + "com.amazonaws.directoryservicedata#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservicedata#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "This error will occur when you try to create a resource that conflicts with an existing\n object. It can also occur when adding a member to a group that the member is already\n in.
\nThis error can be caused by a request sent within the 8-hour idempotency window with the\n same client token but different input parameters. Client tokens should not be re-used across\n different requests. After 8 hours, any request with the same client token is treated as a new\n request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.directoryservicedata#CreateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#CreateGroupRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#CreateGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new group.
", + "smithy.api#http": { + "uri": "/Groups/CreateGroup", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#CreateGroupRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "GroupType": { + "target": "com.amazonaws.directoryservicedata#GroupType", + "traits": { + "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" + } + }, + "GroupScope": { + "target": "com.amazonaws.directoryservicedata#GroupScope", + "traits": { + "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security group scope.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression that defines one or more attributes with the data type and value of each\n attribute.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.directoryservicedata#ClientToken", + "traits": { + "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe identifier (ID) of the directory that's associated with the group.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
" + } + }, + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#CreateUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new user.
", + "smithy.api#http": { + "uri": "/Users/CreateUser", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#CreateUserRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that’s associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "EmailAddress": { + "target": "com.amazonaws.directoryservicedata#EmailAddress", + "traits": { + "smithy.api#documentation": "The email address of the user.
" + } + }, + "GivenName": { + "target": "com.amazonaws.directoryservicedata#GivenName", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "Surname": { + "target": "com.amazonaws.directoryservicedata#Surname", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.
\nAttribute names are case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe identifier (ID) of the directory where the address block is added.
" + } + }, + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the user.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#DeleteGroupRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#DeleteGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a group.
", + "smithy.api#http": { + "uri": "/Groups/DeleteGroup", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#DeleteGroupRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.directoryservicedata#ClientToken", + "traits": { + "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nDeletes a user.
", + "smithy.api#http": { + "uri": "/Users/DeleteUser", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#DeleteUserRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.directoryservicedata#ClientToken", + "traits": { + "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nReturns information about a specific group.
", + "smithy.api#http": { + "uri": "/Groups/DescribeGroup", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "DescribeGroupFailure", + "params": { + "DirectoryId": "d-1111111111", + "SAMAccountName": "test-group" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.directoryservicedata#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.directoryservicedata#DescribeGroupRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The Identifier (ID) of the directory associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nThe name of the group.
", + "smithy.api#required": {} + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#LdapDisplayNameList", + "traits": { + "smithy.api#documentation": "One or more attributes to be returned for the group. For a list of supported attributes,\n see Directory Service Data Attributes.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#DescribeGroupResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
" + } + }, + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the group.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
" + } + }, + "DistinguishedName": { + "target": "com.amazonaws.directoryservicedata#DistinguishedName", + "traits": { + "smithy.api#documentation": "The distinguished name of the object.
" + } + }, + "GroupType": { + "target": "com.amazonaws.directoryservicedata#GroupType", + "traits": { + "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" + } + }, + "GroupScope": { + "target": "com.amazonaws.directoryservicedata#GroupScope", + "traits": { + "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "The attribute values that are returned for the attribute names that are included in the\n request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#DescribeUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specific user.
", + "smithy.api#http": { + "uri": "/Users/DescribeUser", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "DescribeUserFailure", + "params": { + "DirectoryId": "d-1111111111", + "SAMAccountName": "test-user" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.directoryservicedata#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-west-2" + } + } + ] + } + }, + "com.amazonaws.directoryservicedata#DescribeUserRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#LdapDisplayNameList", + "traits": { + "smithy.api#documentation": "One or more attribute names to be returned for the user. A key is an attribute name, and\n the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside your Managed Microsoft AD domain.\n When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nThe identifier (ID) of the directory that's associated with the user.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the user.
" + } + }, + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the user.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
" + } + }, + "DistinguishedName": { + "target": "com.amazonaws.directoryservicedata#DistinguishedName", + "traits": { + "smithy.api#documentation": "The distinguished name of the object.
" + } + }, + "UserPrincipalName": { + "target": "com.amazonaws.directoryservicedata#UserPrincipalName", + "traits": { + "smithy.api#documentation": "The UPN that is an Internet-style login name for a user and is based on the Internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.
" + } + }, + "EmailAddress": { + "target": "com.amazonaws.directoryservicedata#EmailAddress", + "traits": { + "smithy.api#documentation": "The email address of the user.
" + } + }, + "GivenName": { + "target": "com.amazonaws.directoryservicedata#GivenName", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "Surname": { + "target": "com.amazonaws.directoryservicedata#Surname", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the user account is active.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "The attribute values that are returned for the attribute names that are included in the\n request.
\nAttribute names are case insensitive.
\nAmazon Web Services Directory Service Data is an extension of Directory Service. This API reference provides detailed information\n about Directory Service Data operations and object types.
\n With Directory Service Data, you can create, read, update, and delete users, groups, and memberships from\n your Managed Microsoft AD without additional costs and without deploying dedicated management\n instances. You can also perform built-in object management tasks across directories without\n direct network connectivity, which simplifies provisioning and access management to achieve\n fully automated deployments. Directory Service Data supports user and group write operations, such as\n CreateUser and CreateGroup, within the organizational unit (OU) of\n your Managed Microsoft AD. Directory Service Data supports read operations, such as ListUsers and\n ListGroups, on all users, groups, and group memberships within your\n Managed Microsoft AD and across trusted realms. Directory Service Data supports adding and removing group members in\n your OU and the Amazon Web Services Delegated Groups OU, so you can grant and deny access to specific roles\n and permissions. For more information, see Manage users and\n groups in the Directory Service Administration Guide.
Directory management operations and configuration changes made against the Directory Service\n API will also reflect in Directory Service Data API with eventual consistency. You can expect a short delay\n between management changes, such as adding a new directory trust and calling the Directory Service Data API\n for the newly created trusted realm.
\nDirectory Service Data connects to your Managed Microsoft AD domain controllers and performs operations on\n underlying directory objects. When you create your Managed Microsoft AD, you choose subnets for domain\n controllers that Directory Service creates on your behalf. If a domain controller is unavailable, Directory Service Data\n uses an available domain controller. As a result, you might notice eventual consistency while\n objects replicate from one domain controller to another domain controller. For more\n information, see What\n gets created in the Directory Service Administration Guide.\n Directory limits vary by Managed Microsoft AD edition:
\n\n Standard edition – Supports 8 transactions per\n second (TPS) for read operations and 4 TPS for write operations per directory. There's a\n concurrency limit of 10 concurrent requests.
\n\n Enterprise edition – Supports 16 transactions per\n second (TPS) for read operations and 8 TPS for write operations per directory. There's a\n concurrency limit of 10 concurrent requests.
\n\n Amazon Web Services Account - Supports a total of 100 TPS for\n Directory Service Data operations across all directories.
\nDirectory Service Data only supports the Managed Microsoft AD directory type and is only available in the primary\n Amazon Web Services Region. For more information, see Managed Microsoft AD\n and Primary vs additional Regions in the Directory Service Administration\n Guide.
", + "smithy.api#title": "AWS Directory Service Data", + "smithy.api#xmlNamespace": { + "uri": "http://directoryservicedata.amazonaws.com/doc/2023-05-31/" + }, + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ds-data-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ds-data-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ds-data.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ds-data.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ds-data.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.directoryservicedata#DirectoryUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservicedata#ExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableReason", + "traits": { + "smithy.api#documentation": "Reason the request failed for the specified directory.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be completed due to a problem in the configuration or current state\n of the specified directory.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.directoryservicedata#DirectoryUnavailableReason": { + "type": "enum", + "members": { + "INVALID_DIRECTORY_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DIRECTORY_STATE" + } + }, + "DIRECTORY_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_TIMEOUT" + } + }, + "DIRECTORY_RESOURCES_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_RESOURCES_EXCEEDED" + } + }, + "NO_DISK_SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_DISK_SPACE" + } + }, + "TRUST_AUTH_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRUST_AUTH_FAILURE" + } + } + } + }, + "com.amazonaws.directoryservicedata#DisableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#DisableUserRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#DisableUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deactivates an active user account. For information about how to enable an inactive user\n account, see ResetUserPassword\n in the Directory Service API Reference.
", + "smithy.api#http": { + "uri": "/Users/DisableUser", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#DisableUserRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.directoryservicedata#ClientToken", + "traits": { + "smithy.api#documentation": "A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe unique security identifier (SID) of the group.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "DistinguishedName": { + "target": "com.amazonaws.directoryservicedata#DistinguishedName", + "traits": { + "smithy.api#documentation": "The distinguished name of the object.
" + } + }, + "GroupType": { + "target": "com.amazonaws.directoryservicedata#GroupType", + "traits": { + "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" + } + }, + "GroupScope": { + "target": "com.amazonaws.directoryservicedata#GroupScope", + "traits": { + "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups\n
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression of one or more attributes, data types, and the values of a group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A group object that contains identifying information and attributes for a specified\n group.
" + } + }, + "com.amazonaws.directoryservicedata#GroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#Group" + } + }, + "com.amazonaws.directoryservicedata#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[^:;|=+\"*?<>/\\\\,\\[\\]@]+$" + } + }, + "com.amazonaws.directoryservicedata#GroupScope": { + "type": "enum", + "members": { + "DOMAIN_LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DomainLocal" + } + }, + "GLOBAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Global" + } + }, + "UNIVERSAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Universal" + } + }, + "BUILTIN_LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BuiltinLocal" + } + } + } + }, + "com.amazonaws.directoryservicedata#GroupSummary": { + "type": "structure", + "members": { + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the group.
", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "GroupType": { + "target": "com.amazonaws.directoryservicedata#GroupType", + "traits": { + "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
", + "smithy.api#required": {} + } + }, + "GroupScope": { + "target": "com.amazonaws.directoryservicedata#GroupScope", + "traits": { + "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing a subset of fields of a group object from a directory.
" + } + }, + "com.amazonaws.directoryservicedata#GroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#GroupSummary" + } + }, + "com.amazonaws.directoryservicedata#GroupType": { + "type": "enum", + "members": { + "DISTRIBUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Distribution" + } + }, + "SECURITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Security" + } + } + } + }, + "com.amazonaws.directoryservicedata#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservicedata#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "The operation didn't succeed because an internal error occurred. Try again later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.directoryservicedata#LdapDisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[A-Za-z*][A-Za-z-*]*$" + } + }, + "com.amazonaws.directoryservicedata#LdapDisplayNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#LdapDisplayName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.directoryservicedata#ListGroupMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#ListGroupMembersRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#ListGroupMembersResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns member information for the specified group.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupMembers.NextToken member contains a token that you pass in the next\n call to ListGroupMembers. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return members from a group outside of your\n Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are\n returned.
\nThis value is case insensitive.
\nThe domain name that's associated with the group member. This parameter defaults to the\n Managed Microsoft AD domain.
\nThis parameter is optional and case insensitive.
\nThe name of the group.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#ListGroupMembersResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "Identifier (ID) of the directory associated with the group.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
" + } + }, + "MemberRealm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the member.
" + } + }, + "Members": { + "target": "com.amazonaws.directoryservicedata#MemberList", + "traits": { + "smithy.api#documentation": "The member information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#ListGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns group information for the specified directory.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListGroups.NextToken\n member contains a token that you pass in the next call to ListGroups. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
Returns group information for the specified member.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n ListGroupsForMember.NextToken member contains a token that you pass in the next\n call to ListGroupsForMember. This retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the member.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive and defaults to your Managed Microsoft AD domain.
\nThe domain name that's associated with the group member.
\nThis parameter is optional, so you can limit your results to the group members in a\n specific domain.
\n This parameter is case insensitive and defaults to Realm\n
The SAMAccountName of the user, group, or computer that's a member of the\n group.
An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#ListGroupsForMemberResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the member.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain that's associated with the group.
" + } + }, + "MemberRealm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain that's associated with the member.
" + } + }, + "Groups": { + "target": "com.amazonaws.directoryservicedata#GroupSummaryList", + "traits": { + "smithy.api#documentation": "The group information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#ListGroupsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name associated with the directory.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#ListGroupsResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name associated with the group.
" + } + }, + "Groups": { + "target": "com.amazonaws.directoryservicedata#GroupSummaryList", + "traits": { + "smithy.api#documentation": "The group information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#ListUsersResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns user information for the specified directory.
\n This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the ListUsers.NextToken\n member contains a token that you pass in the next call to ListUsers. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#ListUsersResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain that's associated with the user.
" + } + }, + "Users": { + "target": "com.amazonaws.directoryservicedata#UserSummaryList", + "traits": { + "smithy.api#documentation": "The user information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 250 + } + } + }, + "com.amazonaws.directoryservicedata#Member": { + "type": "structure", + "members": { + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the group member.
", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#MemberName", + "traits": { + "smithy.api#documentation": "The name of the group member.
", + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.directoryservicedata#MemberType", + "traits": { + "smithy.api#documentation": "The AD type of the member object.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A member object that contains identifying information for a specified member.
" + } + }, + "com.amazonaws.directoryservicedata#MemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#Member" + } + }, + "com.amazonaws.directoryservicedata#MemberName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[^:;|=+\"*?<>/\\\\,\\[\\]@]+$" + } + }, + "com.amazonaws.directoryservicedata#MemberType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "COMPUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPUTER" + } + } + } + }, + "com.amazonaws.directoryservicedata#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6144 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#NumberAttributeValue": { + "type": "long", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#Realm": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+[.]?$" + } + }, + "com.amazonaws.directoryservicedata#RemoveGroupMember": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#RemoveGroupMemberRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#RemoveGroupMemberResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a member from a group.
", + "smithy.api#http": { + "uri": "/GroupMemberships/RemoveGroupMember", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#RemoveGroupMemberRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the member.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "MemberName": { + "target": "com.amazonaws.directoryservicedata#MemberName", + "traits": { + "smithy.api#documentation": " The SAMAccountName of the user, group, or computer to remove from the group.\n
The domain name that's associated with the group member. This parameter defaults to the\n Managed Microsoft AD domain.
\nThis parameter is optional and case insensitive.
\nA unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe resource couldn't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.directoryservicedata#SID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.directoryservicedata#SearchGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#SearchGroupsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#SearchGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Searches the specified directory for a group. You can find groups that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.
This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchGroups.NextToken\n member contains a token that you pass in the next call to SearchGroups. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SearchString": { + "target": "com.amazonaws.directoryservicedata#SearchString", + "traits": { + "smithy.api#documentation": "The attribute value that you want to search for.
\n Wildcard (*) searches aren't supported. For a list of supported\n attributes, see Directory Service Data\n Attributes.
One or more data attributes that are used to search for a group. For a list of supported\n attributes, see Directory Service Data Attributes.\n
", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the group.
\nThis parameter is optional, so you can return groups outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD groups are returned.
\nThis value is case insensitive.
\nAn encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#SearchGroupsResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain that's associated with the group.
" + } + }, + "Groups": { + "target": "com.amazonaws.directoryservicedata#GroupList", + "traits": { + "smithy.api#documentation": "The group information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#SearchString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#SearchUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#SearchUsersRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#SearchUsersResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": " Searches the specified directory for a user. You can find users that match the\n SearchString parameter with the value of their attributes included in the\n SearchString parameter.
This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the SearchUsers.NextToken\n member contains a token that you pass in the next call to SearchUsers. This\n retrieves the next set of items.
You can also specify a maximum number of return results with the MaxResults\n parameter.
The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain name that's associated with the user.
\nThis parameter is optional, so you can return users outside of your Managed Microsoft AD\n domain. When no value is defined, only your Managed Microsoft AD users are returned.
\nThis value is case insensitive.
\nThe attribute value that you want to search for.
\n Wildcard (*) searches aren't supported. For a list of supported\n attributes, see Directory Service Data\n Attributes.
One or more data attributes that are used to search for a user. For a list of supported\n attributes, see Directory Service Data Attributes.\n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.directoryservicedata#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.directoryservicedata#SearchUsersResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory where the address block is added.
" + } + }, + "Realm": { + "target": "com.amazonaws.directoryservicedata#Realm", + "traits": { + "smithy.api#documentation": "The domain that's associated with the user.
" + } + }, + "Users": { + "target": "com.amazonaws.directoryservicedata#UserList", + "traits": { + "smithy.api#documentation": "The user information that the request returns.
" + } + }, + "NextToken": { + "target": "com.amazonaws.directoryservicedata#NextToken", + "traits": { + "smithy.api#documentation": "An encoded paging token for paginated calls that can be passed back to retrieve the next\n page.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.directoryservicedata#StringAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#StringSetAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#StringAttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#Surname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservicedata#ExceptionMessage", + "traits": { + "smithy.api#required": {} + } + }, + "RetryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The recommended amount of seconds to retry after a throttling exception.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "The limit on the number of requests per second has been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.directoryservicedata#UpdateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservicedata#UpdateGroupRequest" + }, + "output": { + "target": "com.amazonaws.directoryservicedata#UpdateGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservicedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservicedata#ConflictException" + }, + { + "target": "com.amazonaws.directoryservicedata#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservicedata#InternalServerException" + }, + { + "target": "com.amazonaws.directoryservicedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.directoryservicedata#ThrottlingException" + }, + { + "target": "com.amazonaws.directoryservicedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates group information.
", + "smithy.api#http": { + "uri": "/Groups/UpdateGroup", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#UpdateGroupRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the group.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group.
", + "smithy.api#required": {} + } + }, + "GroupType": { + "target": "com.amazonaws.directoryservicedata#GroupType", + "traits": { + "smithy.api#documentation": "The AD group type. For details, see Active Directory security group type.
" + } + }, + "GroupScope": { + "target": "com.amazonaws.directoryservicedata#GroupScope", + "traits": { + "smithy.api#documentation": "The scope of the AD group. For details, see Active Directory security groups.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression that defines one or more attributes with the data type and the value of\n each attribute.
" + } + }, + "UpdateType": { + "target": "com.amazonaws.directoryservicedata#UpdateType", + "traits": { + "smithy.api#documentation": " The type of update to be performed. If no value exists for the attribute, use\n ADD. Otherwise, use REPLACE to change an attribute value or\n REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nUpdates user information.
", + "smithy.api#http": { + "uri": "/Users/UpdateUser", + "method": "POST" + } + } + }, + "com.amazonaws.directoryservicedata#UpdateUserRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservicedata#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the directory that's associated with the user.
", + "smithy.api#httpQuery": "DirectoryId", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "EmailAddress": { + "target": "com.amazonaws.directoryservicedata#EmailAddress", + "traits": { + "smithy.api#documentation": "The email address of the user.
" + } + }, + "GivenName": { + "target": "com.amazonaws.directoryservicedata#GivenName", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "Surname": { + "target": "com.amazonaws.directoryservicedata#Surname", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression that defines one or more attribute names with the data type and value of\n each attribute. A key is an attribute name, and the value is a list of maps. For a list of\n supported attributes, see Directory Service Data Attributes.
\nAttribute names are case insensitive.
\n The type of update to be performed. If no value exists for the attribute, use\n ADD. Otherwise, use REPLACE to change an attribute value or\n REMOVE to clear the attribute value.
A unique and case-sensitive identifier that you provide to make sure the idempotency of\n the request, so multiple identical calls have the same effect as one single call.
\nA client token is valid for 8 hours after the first request that uses it completes. After\n 8 hours, any request with the same client token is treated as a new request. If the request\n succeeds, any future uses of that token will be idempotent for another 8 hours.
\n If you submit a request with the same client token but change one of the other parameters\n within the 8-hour idempotency window, Directory Service Data returns an ConflictException.
This parameter is optional when using the CLI or SDK.
\nThe unique security identifier (SID) of the user.
" + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "DistinguishedName": { + "target": "com.amazonaws.directoryservicedata#DistinguishedName", + "traits": { + "smithy.api#documentation": "The distinguished name of the object.
" + } + }, + "UserPrincipalName": { + "target": "com.amazonaws.directoryservicedata#UserPrincipalName", + "traits": { + "smithy.api#documentation": "The UPN that is an internet-style login name for a user and based on the internet\n standard RFC 822. The UPN is shorter\n than the distinguished name and easier to remember.
" + } + }, + "EmailAddress": { + "target": "com.amazonaws.directoryservicedata#EmailAddress", + "traits": { + "smithy.api#documentation": "The email address of the user.
" + } + }, + "GivenName": { + "target": "com.amazonaws.directoryservicedata#GivenName", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "Surname": { + "target": "com.amazonaws.directoryservicedata#Surname", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the user account is active.
" + } + }, + "OtherAttributes": { + "target": "com.amazonaws.directoryservicedata#Attributes", + "traits": { + "smithy.api#documentation": "An expression that includes one or more attributes, data types, and values of a\n user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A user object that contains identifying information and attributes for a specified user.\n
" + } + }, + "com.amazonaws.directoryservicedata#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#User" + } + }, + "com.amazonaws.directoryservicedata#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[\\w\\-.]+$" + } + }, + "com.amazonaws.directoryservicedata#UserPrincipalName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.directoryservicedata#UserSummary": { + "type": "structure", + "members": { + "SID": { + "target": "com.amazonaws.directoryservicedata#SID", + "traits": { + "smithy.api#documentation": "The unique security identifier (SID) of the user.
", + "smithy.api#required": {} + } + }, + "SAMAccountName": { + "target": "com.amazonaws.directoryservicedata#UserName", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#required": {} + } + }, + "GivenName": { + "target": "com.amazonaws.directoryservicedata#GivenName", + "traits": { + "smithy.api#documentation": "The first name of the user.
" + } + }, + "Surname": { + "target": "com.amazonaws.directoryservicedata#Surname", + "traits": { + "smithy.api#documentation": "The last name of the user.
" + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the user account is active.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure containing a subset of the fields of a user object from a directory.
" + } + }, + "com.amazonaws.directoryservicedata#UserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservicedata#UserSummary" + } + }, + "com.amazonaws.directoryservicedata#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservicedata#ExceptionMessage" + }, + "Reason": { + "target": "com.amazonaws.directoryservicedata#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Reason the request failed validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request isn't valid. Review the details in the error message to update the invalid\n parameters or values in your request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.directoryservicedata#ValidationExceptionReason": { + "type": "enum", + "members": { + "INVALID_REALM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REALM" + } + }, + "INVALID_DIRECTORY_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DIRECTORY_TYPE" + } + }, + "INVALID_SECONDARY_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SECONDARY_REGION" + } + }, + "INVALID_NEXT_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_NEXT_TOKEN" + } + }, + "INVALID_ATTRIBUTE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_VALUE" + } + }, + "INVALID_ATTRIBUTE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_NAME" + } + }, + "INVALID_ATTRIBUTE_FOR_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_USER" + } + }, + "INVALID_ATTRIBUTE_FOR_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_GROUP" + } + }, + "INVALID_ATTRIBUTE_FOR_SEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_SEARCH" + } + }, + "INVALID_ATTRIBUTE_FOR_MODIFY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_ATTRIBUTE_FOR_MODIFY" + } + }, + "DUPLICATE_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_ATTRIBUTE" + } + }, + "MISSING_ATTRIBUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_ATTRIBUTE" + } + }, + "ATTRIBUTE_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTRIBUTE_EXISTS" + } + }, + "LDAP_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LDAP_SIZE_LIMIT_EXCEEDED" + } + }, + "LDAP_UNSUPPORTED_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LDAP_UNSUPPORTED_OPERATION" + } + } + } + } + } +}