import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeWorkspacesPoolsRequest, DescribeWorkspacesPoolsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeWorkspacesPoolsCommand}. */ export interface DescribeWorkspacesPoolsCommandInput extends DescribeWorkspacesPoolsRequest { } /** * @public * * The output of {@link DescribeWorkspacesPoolsCommand}. */ export interface DescribeWorkspacesPoolsCommandOutput extends DescribeWorkspacesPoolsResult, __MetadataBearer { } declare const DescribeWorkspacesPoolsCommand_base: { new (input: DescribeWorkspacesPoolsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeWorkspacesPoolsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the specified WorkSpaces Pools.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkSpacesClient, DescribeWorkspacesPoolsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import * // const { WorkSpacesClient, DescribeWorkspacesPoolsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import * // import type { WorkSpacesClientConfig } from "@aws-sdk/client-workspaces"; * const config = {}; // type is WorkSpacesClientConfig * const client = new WorkSpacesClient(config); * const input = { // DescribeWorkspacesPoolsRequest * PoolIds: [ // WorkspacesPoolIds * "STRING_VALUE", * ], * Filters: [ // DescribeWorkspacesPoolsFilters * { // DescribeWorkspacesPoolsFilter * Name: "PoolName", // required * Values: [ // DescribeWorkspacesPoolsFilterValues // required * "STRING_VALUE", * ], * Operator: "EQUALS" || "NOTEQUALS" || "CONTAINS" || "NOTCONTAINS", // required * }, * ], * Limit: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeWorkspacesPoolsCommand(input); * const response = await client.send(command); * // { // DescribeWorkspacesPoolsResult * // WorkspacesPools: [ // WorkspacesPools * // { // WorkspacesPool * // PoolId: "STRING_VALUE", // required * // PoolArn: "STRING_VALUE", // required * // CapacityStatus: { // CapacityStatus * // AvailableUserSessions: Number("int"), // required * // DesiredUserSessions: Number("int"), // required * // ActualUserSessions: Number("int"), // required * // ActiveUserSessions: Number("int"), // required * // }, * // PoolName: "STRING_VALUE", // required * // Description: "STRING_VALUE", * // State: "CREATING" || "DELETING" || "RUNNING" || "STARTING" || "STOPPED" || "STOPPING" || "UPDATING", // required * // CreatedAt: new Date("TIMESTAMP"), // required * // BundleId: "STRING_VALUE", // required * // DirectoryId: "STRING_VALUE", // required * // Errors: [ // WorkspacesPoolErrors * // { // WorkspacesPoolError * // ErrorCode: "IAM_SERVICE_ROLE_IS_MISSING" || "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" || "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" || "NETWORK_INTERFACE_LIMIT_EXCEEDED" || "INTERNAL_SERVICE_ERROR" || "MACHINE_ROLE_IS_MISSING" || "STS_DISABLED_IN_REGION" || "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" || "SUBNET_NOT_FOUND" || "IMAGE_NOT_FOUND" || "INVALID_SUBNET_CONFIGURATION" || "SECURITY_GROUPS_NOT_FOUND" || "IGW_NOT_ATTACHED" || "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" || "WORKSPACES_POOL_STOPPED" || "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE" || "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" || "DOMAIN_JOIN_ERROR_ACCESS_DENIED" || "DOMAIN_JOIN_ERROR_LOGON_FAILURE" || "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" || "DOMAIN_JOIN_ERROR_MORE_DATA" || "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" || "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" || "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" || "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" || "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" || "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" || "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" || "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING" || "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE" || "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID" || "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND" || "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND" || "DOMAIN_JOIN_ERROR_SECRET_INVALID" || "BUNDLE_NOT_FOUND" || "DIRECTORY_NOT_FOUND" || "INSUFFICIENT_PERMISSIONS_ERROR" || "DEFAULT_OU_IS_MISSING", * // ErrorMessage: "STRING_VALUE", * // }, * // ], * // ApplicationSettings: { // ApplicationSettingsResponse * // Status: "DISABLED" || "ENABLED", // required * // SettingsGroup: "STRING_VALUE", * // S3BucketName: "STRING_VALUE", * // }, * // TimeoutSettings: { // TimeoutSettings * // DisconnectTimeoutInSeconds: Number("int"), * // IdleDisconnectTimeoutInSeconds: Number("int"), * // MaxUserDurationInSeconds: Number("int"), * // }, * // RunningMode: "AUTO_STOP" || "ALWAYS_ON", // required * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeWorkspacesPoolsCommandInput - {@link DescribeWorkspacesPoolsCommandInput} * @returns {@link DescribeWorkspacesPoolsCommandOutput} * @see {@link DescribeWorkspacesPoolsCommandInput} for command's `input` shape. * @see {@link DescribeWorkspacesPoolsCommandOutput} for command's `response` shape. * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

The user is not authorized to access a resource.

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

One or more parameter values are not valid.

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

The resource could not be found.

* * @throws {@link WorkSpacesServiceException} *

Base exception class for all service exceptions from WorkSpaces service.

* * * @public */ export declare class DescribeWorkspacesPoolsCommand extends DescribeWorkspacesPoolsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeWorkspacesPoolsRequest; output: DescribeWorkspacesPoolsResult; }; sdk: { input: DescribeWorkspacesPoolsCommandInput; output: DescribeWorkspacesPoolsCommandOutput; }; }; }