import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient"; import type { DescribeUserGroupsMessage, DescribeUserGroupsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeUserGroupsCommand}. */ export interface DescribeUserGroupsCommandInput extends DescribeUserGroupsMessage { } /** * @public * * The output of {@link DescribeUserGroupsCommand}. */ export interface DescribeUserGroupsCommandOutput extends DescribeUserGroupsResult, __MetadataBearer { } declare const DescribeUserGroupsCommand_base: { new (input: DescribeUserGroupsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeUserGroupsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns a list of user groups.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElastiCacheClient, DescribeUserGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import * // const { ElastiCacheClient, DescribeUserGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import * // import type { ElastiCacheClientConfig } from "@aws-sdk/client-elasticache"; * const config = {}; // type is ElastiCacheClientConfig * const client = new ElastiCacheClient(config); * const input = { // DescribeUserGroupsMessage * UserGroupId: "STRING_VALUE", * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeUserGroupsCommand(input); * const response = await client.send(command); * // { // DescribeUserGroupsResult * // UserGroups: [ // UserGroupList * // { // UserGroup * // UserGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // Engine: "STRING_VALUE", * // UserIds: [ // UserIdList * // "STRING_VALUE", * // ], * // MinimumEngineVersion: "STRING_VALUE", * // PendingChanges: { // UserGroupPendingChanges * // UserIdsToRemove: [ * // "STRING_VALUE", * // ], * // UserIdsToAdd: [ * // "STRING_VALUE", * // ], * // }, * // ReplicationGroups: [ // UGReplicationGroupIdList * // "STRING_VALUE", * // ], * // ServerlessCaches: [ // UGServerlessCacheIdList * // "STRING_VALUE", * // ], * // ARN: "STRING_VALUE", * // }, * // ], * // Marker: "STRING_VALUE", * // }; * * ``` * * @param DescribeUserGroupsCommandInput - {@link DescribeUserGroupsCommandInput} * @returns {@link DescribeUserGroupsCommandOutput} * @see {@link DescribeUserGroupsCommandInput} for command's `input` shape. * @see {@link DescribeUserGroupsCommandOutput} for command's `response` shape. * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link InvalidParameterCombinationException} (client fault) *

Two or more incompatible parameters were specified.

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

The specified service linked role (SLR) was not found.

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

The user group was not found or does not exist

* * @throws {@link ElastiCacheServiceException} *

Base exception class for all service exceptions from ElastiCache service.

* * * @public */ export declare class DescribeUserGroupsCommand extends DescribeUserGroupsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeUserGroupsMessage; output: DescribeUserGroupsResult; }; sdk: { input: DescribeUserGroupsCommandInput; output: DescribeUserGroupsCommandOutput; }; }; }