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 { SearchUserHierarchyGroupsRequest, SearchUserHierarchyGroupsResponse } from "../models/models_3"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SearchUserHierarchyGroupsCommand}. */ export interface SearchUserHierarchyGroupsCommandInput extends SearchUserHierarchyGroupsRequest { } /** * @public * * The output of {@link SearchUserHierarchyGroupsCommand}. */ export interface SearchUserHierarchyGroupsCommandOutput extends SearchUserHierarchyGroupsResponse, __MetadataBearer { } declare const SearchUserHierarchyGroupsCommand_base: { new (input: SearchUserHierarchyGroupsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: SearchUserHierarchyGroupsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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

* *

The UserHierarchyGroup with "LevelId": "0" is the foundation for building levels on top of an * instance. It is not user-definable, nor is it visible in the UI.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectClient, SearchUserHierarchyGroupsCommand } from "@aws-sdk/client-connect"; // ES Modules import * // const { ConnectClient, SearchUserHierarchyGroupsCommand } = 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 = { // SearchUserHierarchyGroupsRequest * InstanceId: "STRING_VALUE", // required * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * SearchFilter: { // UserHierarchyGroupSearchFilter * AttributeFilter: { // ControlPlaneAttributeFilter * OrConditions: [ // CommonAttributeOrConditionList * { // CommonAttributeAndCondition * TagConditions: [ // TagAndConditionList * { // TagCondition * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * }, * ], * AndCondition: { * TagConditions: [ * { * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * }, * TagCondition: "", * }, * }, * SearchCriteria: { // UserHierarchyGroupSearchCriteria * OrConditions: [ // UserHierarchyGroupSearchConditionList * { * OrConditions: [ * "", * ], * AndConditions: [ * "", * ], * StringCondition: { // StringCondition * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * }, * ], * AndConditions: [ * "", * ], * StringCondition: { * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * }, * }; * const command = new SearchUserHierarchyGroupsCommand(input); * const response = await client.send(command); * // { // SearchUserHierarchyGroupsResponse * // UserHierarchyGroups: [ // UserHierarchyGroupList * // { // HierarchyGroup * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LevelId: "STRING_VALUE", * // HierarchyPath: { // HierarchyPath * // LevelOne: { // HierarchyGroupSummary * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // LevelTwo: { * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // LevelThree: { * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // LevelFour: { * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // LevelFive: { * // Id: "STRING_VALUE", * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // }, * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // LastModifiedTime: new Date("TIMESTAMP"), * // LastModifiedRegion: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // ApproximateTotalCount: Number("long"), * // }; * * ``` * * @param SearchUserHierarchyGroupsCommandInput - {@link SearchUserHierarchyGroupsCommandInput} * @returns {@link SearchUserHierarchyGroupsCommandOutput} * @see {@link SearchUserHierarchyGroupsCommandInput} for command's `input` shape. * @see {@link SearchUserHierarchyGroupsCommandOutput} 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 SearchUserHierarchyGroupsCommand extends SearchUserHierarchyGroupsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SearchUserHierarchyGroupsRequest; output: SearchUserHierarchyGroupsResponse; }; sdk: { input: SearchUserHierarchyGroupsCommandInput; output: SearchUserHierarchyGroupsCommandOutput; }; }; }