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

package/dist-types/auth/httpAuthSchemeProvider.d.ts

@@ -0,0 +1,61 @@
+import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
+import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig } from "../DirectoryServiceDataClient";
+/**
+ * @internal
+ */
+export interface DirectoryServiceDataHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
+    region?: string;
+}
+/**
+ * @internal
+ */
+export interface DirectoryServiceDataHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<DirectoryServiceDataClientResolvedConfig, HandlerExecutionContext, DirectoryServiceDataHttpAuthSchemeParameters, object> {
+}
+/**
+ * @internal
+ */
+export declare const defaultDirectoryServiceDataHttpAuthSchemeParametersProvider: (config: DirectoryServiceDataClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<DirectoryServiceDataHttpAuthSchemeParameters>;
+/**
+ * @internal
+ */
+export interface DirectoryServiceDataHttpAuthSchemeProvider extends HttpAuthSchemeProvider<DirectoryServiceDataHttpAuthSchemeParameters> {
+}
+/**
+ * @internal
+ */
+export declare const defaultDirectoryServiceDataHttpAuthSchemeProvider: DirectoryServiceDataHttpAuthSchemeProvider;
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    httpAuthSchemes?: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    httpAuthSchemeProvider?: DirectoryServiceDataHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
+    /**
+     * Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
+     * @internal
+     */
+    readonly httpAuthSchemes: HttpAuthScheme[];
+    /**
+     * Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
+     * @internal
+     */
+    readonly httpAuthSchemeProvider: DirectoryServiceDataHttpAuthSchemeProvider;
+}
+/**
+ * @internal
+ */
+export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;

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

@@ -0,0 +1,107 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceDataClient";
+import { AddGroupMemberRequest, AddGroupMemberResult } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link AddGroupMemberCommand}.
+ */
+export interface AddGroupMemberCommandInput extends AddGroupMemberRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link AddGroupMemberCommand}.
+ */
+export interface AddGroupMemberCommandOutput extends AddGroupMemberResult, __MetadataBearer {
+}
+declare const AddGroupMemberCommand_base: {
+    new (input: AddGroupMemberCommandInput): import("@smithy/smithy-client").CommandImpl<AddGroupMemberCommandInput, AddGroupMemberCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: AddGroupMemberCommandInput): import("@smithy/smithy-client").CommandImpl<AddGroupMemberCommandInput, AddGroupMemberCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Adds an existing user, group, or computer as a group member.</p>
+ * @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)
+ *  <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 AddGroupMemberCommand extends AddGroupMemberCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: AddGroupMemberRequest;
+            output: {};
+        };
+        sdk: {
+            input: AddGroupMemberCommandInput;
+            output: AddGroupMemberCommandOutput;
+        };
+    };
+}

package/dist-types/commands/CreateGroupCommand.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 { CreateGroupRequest, CreateGroupResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const CreateGroupCommand_base: {
+    new (input: CreateGroupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGroupCommandInput, CreateGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: CreateGroupCommandInput): import("@smithy/smithy-client").CommandImpl<CreateGroupCommandInput, CreateGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a new group.</p>
+ * @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
+ *     "<keys>": { // AttributeValue Union: only one key present
+ *       S: "STRING_VALUE",
+ *       N: Number("long"),
+ *       BOOL: true || false,
+ *       SS: [ // StringSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   ClientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateGroupCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateGroupResult
+ * //   DirectoryId: "STRING_VALUE",
+ * //   SAMAccountName: "STRING_VALUE",
+ * //   SID: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param CreateGroupCommandInput - {@link CreateGroupCommandInput}
+ * @returns {@link CreateGroupCommandOutput}
+ * @see {@link CreateGroupCommandInput} for command's `input` shape.
+ * @see {@link CreateGroupCommandOutput} 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 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 CreateGroupCommand extends CreateGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateGroupRequest;
+            output: CreateGroupResult;
+        };
+        sdk: {
+            input: CreateGroupCommandInput;
+            output: CreateGroupCommandOutput;
+        };
+    };
+}

package/dist-types/commands/CreateUserCommand.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 { CreateUserRequest, CreateUserResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const CreateUserCommand_base: {
+    new (input: CreateUserCommandInput): import("@smithy/smithy-client").CommandImpl<CreateUserCommandInput, CreateUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: CreateUserCommandInput): import("@smithy/smithy-client").CommandImpl<CreateUserCommandInput, CreateUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Creates a new user.</p>
+ * @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
+ *     "<keys>": { // AttributeValue Union: only one key present
+ *       S: "STRING_VALUE",
+ *       N: Number("long"),
+ *       BOOL: true || false,
+ *       SS: [ // StringSetAttributeValue
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   ClientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateUserCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateUserResult
+ * //   DirectoryId: "STRING_VALUE",
+ * //   SID: "STRING_VALUE",
+ * //   SAMAccountName: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param CreateUserCommandInput - {@link CreateUserCommandInput}
+ * @returns {@link CreateUserCommandOutput}
+ * @see {@link CreateUserCommandInput} for command's `input` shape.
+ * @see {@link CreateUserCommandOutput} 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 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 CreateUserCommand extends CreateUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateUserRequest;
+            output: CreateUserResult;
+        };
+        sdk: {
+            input: CreateUserCommandInput;
+            output: CreateUserCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceDataClient";
+import { DeleteGroupRequest, DeleteGroupResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const DeleteGroupCommand_base: {
+    new (input: DeleteGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteGroupCommandInput, DeleteGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteGroupCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteGroupCommandInput, DeleteGroupCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a group.</p>
+ * @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)
+ *  <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 DeleteGroupCommand extends DeleteGroupCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteGroupRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteGroupCommandInput;
+            output: DeleteGroupCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,105 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceDataClient";
+import { DeleteUserRequest, DeleteUserResult } from "../models/models_0";
+/**
+ * @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 {
+}
+declare const DeleteUserCommand_base: {
+    new (input: DeleteUserCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteUserCommandInput, DeleteUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: DeleteUserCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteUserCommandInput, DeleteUserCommandOutput, DirectoryServiceDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Deletes a user.</p>
+ * @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)
+ *  <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 DeleteUserCommand extends DeleteUserCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DeleteUserRequest;
+            output: {};
+        };
+        sdk: {
+            input: DeleteUserCommandInput;
+            output: DeleteUserCommandOutput;
+        };
+    };
+}