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 { DescribePrincipalMappingRequest, DescribePrincipalMappingResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribePrincipalMappingCommand}. */ export interface DescribePrincipalMappingCommandInput extends DescribePrincipalMappingRequest { } /** * @public * * The output of {@link DescribePrincipalMappingCommand}. */ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipalMappingResponse, __MetadataBearer { } declare const DescribePrincipalMappingCommand_base: { new (input: DescribePrincipalMappingCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: DescribePrincipalMappingCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Describes the processing of PUT and DELETE actions for * mapping users to their groups. This includes information on the status of actions * currently processing or yet to be processed, when actions were last updated, when * actions were received by Amazon Kendra, the latest action that should process and * apply after other actions, and useful error messages if an action could not be * processed.

*

* DescribePrincipalMapping 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, DescribePrincipalMappingCommand } from "@aws-sdk/client-kendra"; // ES Modules import * // const { KendraClient, DescribePrincipalMappingCommand } = 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 = { // DescribePrincipalMappingRequest * IndexId: "STRING_VALUE", // required * DataSourceId: "STRING_VALUE", * GroupId: "STRING_VALUE", // required * }; * const command = new DescribePrincipalMappingCommand(input); * const response = await client.send(command); * // { // DescribePrincipalMappingResponse * // IndexId: "STRING_VALUE", * // DataSourceId: "STRING_VALUE", * // GroupId: "STRING_VALUE", * // GroupOrderingIdSummaries: [ // GroupOrderingIdSummaries * // { // GroupOrderingIdSummary * // Status: "FAILED" || "SUCCEEDED" || "PROCESSING" || "DELETING" || "DELETED", * // LastUpdatedAt: new Date("TIMESTAMP"), * // ReceivedAt: new Date("TIMESTAMP"), * // OrderingId: Number("long"), * // FailureReason: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DescribePrincipalMappingCommandInput - {@link DescribePrincipalMappingCommandInput} * @returns {@link DescribePrincipalMappingCommandOutput} * @see {@link DescribePrincipalMappingCommandInput} for command's `input` shape. * @see {@link DescribePrincipalMappingCommandOutput} 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 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 DescribePrincipalMappingCommand extends DescribePrincipalMappingCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribePrincipalMappingRequest; output: DescribePrincipalMappingResponse; }; sdk: { input: DescribePrincipalMappingCommandInput; output: DescribePrincipalMappingCommandOutput; }; }; }