@aws-sdk/client-directory-service-data 3.654.0

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

@@ -0,0 +1,118 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceDataClient";
+import { UpdateGroupRequest, UpdateGroupResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const UpdateGroupCommand_base: {
+    new (input: UpdateGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateGroupCommandInput, UpdateGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateGroupCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateGroupCommandInput, UpdateGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p> Updates group information. </p>
+ * @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
+ *     "<keys>": { // AttributeValue Union: only one key present
+ *       S: "STRING_VALUE",
+ *       N: Number("long"),
+ *       BOOL: true || false,
+ *       SS: [ // StringSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   UpdateType: "ADD" || "REPLACE" || "REMOVE",
+ *   ClientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateGroupCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateGroupCommandInput - {@link UpdateGroupCommandInput}
+ * @returns {@link UpdateGroupCommandOutput}
+ * @see {@link UpdateGroupCommandInput} for command's `input` shape.
+ * @see {@link UpdateGroupCommandOutput} for command's `response` shape.
+ * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have permission to perform the request or access the directory. It can also
+ *       occur when the <code>DirectoryId</code> doesn't exist or the user, member, or group might be
+ *       outside of your organizational unit (OU). </p>
+ *          <p> 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. </p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p> 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.</p>
+ *          <p> 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. </p>
+ *
+ * @throws {@link DirectoryUnavailableException} (client fault)
+ *  <p> The request could not be completed due to a problem in the configuration or current state
+ *       of the specified directory. </p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p> The operation didn't succeed because an internal error occurred. Try again later. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> The resource couldn't be found. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p> The limit on the number of requests per second has been exceeded. </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p> The request isn't valid. Review the details in the error message to update the invalid
+ *       parameters or values in your request. </p>
+ *
+ * @throws {@link DirectoryServiceDataServiceException}
+ * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
+ *
+ * @public
+ */
+export declare class UpdateGroupCommand extends UpdateGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateGroupRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateGroupCommandInput;
+            output: UpdateGroupCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,119 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceDataClient";
+import { UpdateUserRequest, UpdateUserResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const UpdateUserCommand_base: {
+    new (input: UpdateUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateUserCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserCommandInput, UpdateUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p> Updates user information. </p>
+ * @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
+ *     "<keys>": { // AttributeValue Union: only one key present
+ *       S: "STRING_VALUE",
+ *       N: Number("long"),
+ *       BOOL: true || false,
+ *       SS: [ // StringSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   UpdateType: "ADD" || "REPLACE" || "REMOVE",
+ *   ClientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateUserCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateUserCommandInput - {@link UpdateUserCommandInput}
+ * @returns {@link UpdateUserCommandOutput}
+ * @see {@link UpdateUserCommandInput} for command's `input` shape.
+ * @see {@link UpdateUserCommandOutput} for command's `response` shape.
+ * @see {@link DirectoryServiceDataClientResolvedConfig | config} for DirectoryServiceDataClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have permission to perform the request or access the directory. It can also
+ *       occur when the <code>DirectoryId</code> doesn't exist or the user, member, or group might be
+ *       outside of your organizational unit (OU). </p>
+ *          <p> 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. </p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p> 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.</p>
+ *          <p> 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. </p>
+ *
+ * @throws {@link DirectoryUnavailableException} (client fault)
+ *  <p> The request could not be completed due to a problem in the configuration or current state
+ *       of the specified directory. </p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p> The operation didn't succeed because an internal error occurred. Try again later. </p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p> The resource couldn't be found. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p> The limit on the number of requests per second has been exceeded. </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p> The request isn't valid. Review the details in the error message to update the invalid
+ *       parameters or values in your request. </p>
+ *
+ * @throws {@link DirectoryServiceDataServiceException}
+ * <p>Base exception class for all service exceptions from DirectoryServiceData service.</p>
+ *
+ * @public
+ */
+export declare class UpdateUserCommand extends UpdateUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateUserRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateUserCommandInput;
+            output: UpdateUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,17 @@
+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";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,40 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    region?: string | Provider<string>;
+    useDualstackEndpoint?: boolean | Provider<boolean>;
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+    readonly UseDualStack: {
+        readonly type: "builtInParams";
+        readonly name: "useDualstackEndpoint";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    Region?: string;
+    UseDualStack?: boolean;
+    UseFIPS?: boolean;
+    Endpoint?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface DirectoryServiceDataExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * <p> 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. </p>
+ *          <p> 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
+ *         <code>CreateUser</code> and <code>CreateGroup</code>, within the organizational unit (OU) of
+ *       your Managed Microsoft AD. Directory Service Data supports read operations, such as <code>ListUsers</code> and
+ *         <code>ListGroups</code>, 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 <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_manage_users_groups.html">Manage users and
+ *         groups</a> in the <i>Directory Service Administration Guide</i>. </p>
+ *          <note>
+ *             <p> 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. </p>
+ *          </note>
+ *          <p> 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 <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html">What
+ *         gets created</a> in the <i>Directory Service Administration Guide</i>.
+ *       Directory limits vary by Managed Microsoft AD edition: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <b>Standard edition</b> – 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. </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Enterprise edition</b> – 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.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <b>Amazon Web Services Account</b> - Supports a total of 100 TPS for
+ *           Directory Service Data operations across all directories.</p>
+ *             </li>
+ *          </ul>
+ *          <p> 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 <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html">Managed Microsoft AD</a>
+ *       and <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/multi-region-global-primary-additional.html">Primary vs additional Regions</a> in the <i>Directory Service Administration
+ *         Guide</i>. </p>
+ *
+ * @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";

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

@@ -0,0 +1,14 @@
+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 declare class DirectoryServiceDataServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";