import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import type { SearchUsersRequest, SearchUsersResponse } from "../models/models_3"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SearchUsersCommand}. */ export interface SearchUsersCommandInput extends SearchUsersRequest { } /** * @public * * The output of {@link SearchUsersCommand}. */ export interface SearchUsersCommandOutput extends SearchUsersResponse, __MetadataBearer { } declare const SearchUsersCommand_base: { new (input: SearchUsersCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: SearchUsersCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Searches users in an Amazon Connect instance, with optional filtering.

* *

* AfterContactWorkTimeLimit is returned in milliseconds.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectClient, SearchUsersCommand } from "@aws-sdk/client-connect"; // ES Modules import * // const { ConnectClient, SearchUsersCommand } = require("@aws-sdk/client-connect"); // CommonJS import * // import type { ConnectClientConfig } from "@aws-sdk/client-connect"; * const config = {}; // type is ConnectClientConfig * const client = new ConnectClient(config); * const input = { // SearchUsersRequest * InstanceId: "STRING_VALUE", // required * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * SearchFilter: { // UserSearchFilter * TagFilter: { // ControlPlaneTagFilter * OrConditions: [ // TagOrConditionList * [ // TagAndConditionList * { // TagCondition * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * ], * AndConditions: [ * { * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * TagCondition: "", * }, * UserAttributeFilter: { // ControlPlaneUserAttributeFilter * OrConditions: [ // AttributeOrConditionList * { // AttributeAndCondition * TagConditions: "", * HierarchyGroupCondition: { // HierarchyGroupCondition * Value: "STRING_VALUE", * HierarchyGroupMatchType: "EXACT" || "WITH_CHILD_GROUPS", * }, * }, * ], * AndCondition: { * TagConditions: "", * HierarchyGroupCondition: { * Value: "STRING_VALUE", * HierarchyGroupMatchType: "EXACT" || "WITH_CHILD_GROUPS", * }, * }, * TagCondition: "", * HierarchyGroupCondition: "", * }, * }, * SearchCriteria: { // UserSearchCriteria * OrConditions: [ // UserSearchConditionList * { * OrConditions: [ * "", * ], * AndConditions: [ * "", * ], * StringCondition: { // StringCondition * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * ListCondition: { // ListCondition * TargetListType: "PROFICIENCIES", * Conditions: [ // Conditions * { // Condition * StringCondition: { * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * NumberCondition: { // NumberCondition * FieldName: "STRING_VALUE", * MinValue: Number("int"), * MaxValue: Number("int"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * }, * ], * }, * HierarchyGroupCondition: "", * }, * ], * AndConditions: [ * "", * ], * StringCondition: "", * ListCondition: { * TargetListType: "PROFICIENCIES", * Conditions: [ * { * StringCondition: "", * NumberCondition: { * FieldName: "STRING_VALUE", * MinValue: Number("int"), * MaxValue: Number("int"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * }, * ], * }, * HierarchyGroupCondition: "", * }, * }; * const command = new SearchUsersCommand(input); * const response = await client.send(command); * // { // SearchUsersResponse * // Users: [ // UserSearchSummaryList * // { // UserSearchSummary * // Arn: "STRING_VALUE", * // DirectoryUserId: "STRING_VALUE", * // HierarchyGroupId: "STRING_VALUE", * // Id: "STRING_VALUE", * // IdentityInfo: { // UserIdentityInfoLite * // FirstName: "STRING_VALUE", * // LastName: "STRING_VALUE", * // }, * // PhoneConfig: { // UserPhoneConfig * // PhoneType: "SOFT_PHONE" || "DESK_PHONE", * // AutoAccept: true || false, * // AfterContactWorkTimeLimit: Number("int"), * // DeskPhoneNumber: "STRING_VALUE", * // PersistentConnection: true || false, * // }, * // RoutingProfileId: "STRING_VALUE", * // SecurityProfileIds: [ // SecurityProfileIds * // "STRING_VALUE", * // ], * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // Username: "STRING_VALUE", * // AutoAcceptConfigs: [ // AutoAcceptConfigs * // { // AutoAcceptConfig * // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required * // AutoAccept: true || false, // required * // AgentFirstCallbackAutoAccept: true || false, * // }, * // ], * // AfterContactWorkConfigs: [ // AfterContactWorkConfigs * // { // AfterContactWorkConfigPerChannel * // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required * // AfterContactWorkConfig: { // AfterContactWorkConfig * // AfterContactWorkTimeLimit: Number("int"), * // }, * // AgentFirstCallbackAfterContactWorkConfig: { * // AfterContactWorkTimeLimit: Number("int"), * // }, * // }, * // ], * // PhoneNumberConfigs: [ // PhoneNumberConfigs * // { // PhoneNumberConfig * // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required * // PhoneType: "SOFT_PHONE" || "DESK_PHONE", // required * // PhoneNumber: "STRING_VALUE", * // }, * // ], * // PersistentConnectionConfigs: [ // PersistentConnectionConfigs * // { // PersistentConnectionConfig * // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required * // PersistentConnection: true || false, // required * // }, * // ], * // VoiceEnhancementConfigs: [ // VoiceEnhancementConfigs * // { // VoiceEnhancementConfig * // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required * // VoiceEnhancementMode: "VOICE_ISOLATION" || "NOISE_SUPPRESSION" || "NONE", // required * // }, * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // ApproximateTotalCount: Number("long"), * // }; * * ``` * * @param SearchUsersCommandInput - {@link SearchUsersCommandInput} * @returns {@link SearchUsersCommandOutput} * @see {@link SearchUsersCommandInput} for command's `input` shape. * @see {@link SearchUsersCommandOutput} for command's `response` shape. * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. * * @throws {@link InternalServiceException} (server fault) *

Request processing failed because of an error or failure with the service.

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

One or more of the specified parameters are not valid.

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

The request is not valid.

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

The specified resource was not found.

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

The throttling limit has been exceeded.

* * @throws {@link ConnectServiceException} *

Base exception class for all service exceptions from Connect service.

* * * @public */ export declare class SearchUsersCommand extends SearchUsersCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SearchUsersRequest; output: SearchUsersResponse; }; sdk: { input: SearchUsersCommandInput; output: SearchUsersCommandOutput; }; }; }