import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient"; import type { DeletePrincipalMappingRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeletePrincipalMappingCommand}. */ export interface DeletePrincipalMappingCommandInput extends DeletePrincipalMappingRequest { } /** * @public * * The output of {@link DeletePrincipalMappingCommand}. */ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer { } declare const DeletePrincipalMappingCommand_base: { new (input: DeletePrincipalMappingCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DeletePrincipalMappingCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Deletes a group so that all users that belong to the group can no * longer access documents only available to that group.

*

For example, after deleting the group "Summer Interns", all interns who belonged to * that group no longer see intern-only documents in their search results.

*

If you want to delete or replace users or sub groups of a group, you need to use the * PutPrincipalMapping operation. For example, if a user in the group * "Engineering" leaves the engineering team and another user takes their place, you * provide an updated list of users or sub groups that belong to the "Engineering" group * when calling PutPrincipalMapping. You can update your internal list of * users or sub groups and input this list when calling * PutPrincipalMapping.

*

* DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KendraClient, DeletePrincipalMappingCommand } from "@aws-sdk/client-kendra"; // ES Modules import * // const { KendraClient, DeletePrincipalMappingCommand } = require("@aws-sdk/client-kendra"); // CommonJS import * // import type { KendraClientConfig } from "@aws-sdk/client-kendra"; * const config = {}; // type is KendraClientConfig * const client = new KendraClient(config); * const input = { // DeletePrincipalMappingRequest * IndexId: "STRING_VALUE", // required * DataSourceId: "STRING_VALUE", * GroupId: "STRING_VALUE", // required * OrderingId: Number("long"), * }; * const command = new DeletePrincipalMappingCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeletePrincipalMappingCommandInput - {@link DeletePrincipalMappingCommandInput} * @returns {@link DeletePrincipalMappingCommandOutput} * @see {@link DeletePrincipalMappingCommandInput} for command's `input` shape. * @see {@link DeletePrincipalMappingCommandOutput} for command's `response` shape. * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

You don't have sufficient access to perform this action. Please ensure you have the * required permission policies and user accounts and try again.

* * @throws {@link ConflictException} (client fault) *

A conflict occurred with the request. Please fix any inconsistences with your * resources and try again.

* * @throws {@link InternalServerException} (server fault) *

An issue occurred with the internal server used for your Amazon Kendra service. * Please wait a few minutes and try again, or contact Support for help.

* * @throws {@link ResourceNotFoundException} (client fault) *

The resource you want to use doesn’t exist. Please check you have provided the correct * resource and try again.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling. Please reduce the number of requests * and try again.

* * @throws {@link ValidationException} (client fault) *

The input fails to satisfy the constraints set by the Amazon Kendra service. * Please provide the correct input and try again.

* * @throws {@link KendraServiceException} *

Base exception class for all service exceptions from Kendra service.

* * * @public */ export declare class DeletePrincipalMappingCommand extends DeletePrincipalMappingCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeletePrincipalMappingRequest; output: {}; }; sdk: { input: DeletePrincipalMappingCommandInput; output: DeletePrincipalMappingCommandOutput; }; }; }