import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeUsersRequest, DescribeUsersResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeUsersCommand}. */ export interface DescribeUsersCommandInput extends DescribeUsersRequest { } /** * @public * * The output of {@link DescribeUsersCommand}. */ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __MetadataBearer { } declare const DescribeUsersCommand_base: { new (input: DescribeUsersCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeUsersCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the specified users. You can describe all users or filter the results * (for example, by status or organization).

*

By default, Amazon WorkDocs returns the first 24 active or pending users. If there * are more results, the response includes a marker that you can use to request the next * set of results.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkDocsClient, DescribeUsersCommand } from "@aws-sdk/client-workdocs"; // ES Modules import * // const { WorkDocsClient, DescribeUsersCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import * // import type { WorkDocsClientConfig } from "@aws-sdk/client-workdocs"; * const config = {}; // type is WorkDocsClientConfig * const client = new WorkDocsClient(config); * const input = { // DescribeUsersRequest * AuthenticationToken: "STRING_VALUE", * OrganizationId: "STRING_VALUE", * UserIds: "STRING_VALUE", * Query: "STRING_VALUE", * Include: "ALL" || "ACTIVE_PENDING", * Order: "ASCENDING" || "DESCENDING", * Sort: "USER_NAME" || "FULL_NAME" || "STORAGE_LIMIT" || "USER_STATUS" || "STORAGE_USED", * Marker: "STRING_VALUE", * Limit: Number("int"), * Fields: "STRING_VALUE", * }; * const command = new DescribeUsersCommand(input); * const response = await client.send(command); * // { // DescribeUsersResponse * // Users: [ // OrganizationUserList * // { // User * // Id: "STRING_VALUE", * // Username: "STRING_VALUE", * // EmailAddress: "STRING_VALUE", * // GivenName: "STRING_VALUE", * // Surname: "STRING_VALUE", * // OrganizationId: "STRING_VALUE", * // RootFolderId: "STRING_VALUE", * // RecycleBinFolderId: "STRING_VALUE", * // Status: "ACTIVE" || "INACTIVE" || "PENDING", * // Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER", * // CreatedTimestamp: new Date("TIMESTAMP"), * // ModifiedTimestamp: new Date("TIMESTAMP"), * // TimeZoneId: "STRING_VALUE", * // Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default", * // Storage: { // UserStorageMetadata * // StorageUtilizedInBytes: Number("long"), * // StorageRule: { // StorageRuleType * // StorageAllocatedInBytes: Number("long"), * // StorageType: "UNLIMITED" || "QUOTA", * // }, * // }, * // }, * // ], * // TotalNumberOfUsers: Number("long"), * // Marker: "STRING_VALUE", * // }; * * ``` * * @param DescribeUsersCommandInput - {@link DescribeUsersCommandInput} * @returns {@link DescribeUsersCommandOutput} * @see {@link DescribeUsersCommandInput} for command's `input` shape. * @see {@link DescribeUsersCommandOutput} for command's `response` shape. * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape. * * @throws {@link EntityNotExistsException} (client fault) *

The resource does not exist.

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

The Directory Service cannot reach an on-premises instance. Or a dependency * under the control of the organization is failing, such as a connected Active * Directory.

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

The pagination marker or limit fields are not valid.

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

The response is too large to return. The request must include a filter to reduce the size of the response.

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

One or more of the dependencies is unavailable.

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

The operation is not permitted.

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

The caller does not have access to perform the action on the resource.

* * @throws {@link WorkDocsServiceException} *

Base exception class for all service exceptions from WorkDocs service.

* * * @public */ export declare class DescribeUsersCommand extends DescribeUsersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeUsersRequest; output: DescribeUsersResponse; }; sdk: { input: DescribeUsersCommandInput; output: DescribeUsersCommandOutput; }; }; }