import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeWorkspacesRequest, DescribeWorkspacesResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeWorkspacesCommand}. */ export interface DescribeWorkspacesCommandInput extends DescribeWorkspacesRequest { } /** * @public * * The output of {@link DescribeWorkspacesCommand}. */ export interface DescribeWorkspacesCommandOutput extends DescribeWorkspacesResult, __MetadataBearer { } declare const DescribeWorkspacesCommand_base: { new (input: DescribeWorkspacesCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeWorkspacesCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the specified WorkSpaces.

*

You can filter the results by using the bundle identifier, directory identifier, or * owner, but you can specify only one filter at a time.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkSpacesClient, DescribeWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import * // const { WorkSpacesClient, DescribeWorkspacesCommand } = 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 = { // DescribeWorkspacesRequest * WorkspaceIds: [ // WorkspaceIdList * "STRING_VALUE", * ], * DirectoryId: "STRING_VALUE", * UserName: "STRING_VALUE", * BundleId: "STRING_VALUE", * Limit: Number("int"), * NextToken: "STRING_VALUE", * WorkspaceName: "STRING_VALUE", * }; * const command = new DescribeWorkspacesCommand(input); * const response = await client.send(command); * // { // DescribeWorkspacesResult * // Workspaces: [ // WorkspaceList * // { // Workspace * // WorkspaceId: "STRING_VALUE", * // DirectoryId: "STRING_VALUE", * // UserName: "STRING_VALUE", * // IpAddress: "STRING_VALUE", * // Ipv6Address: "STRING_VALUE", * // State: "PENDING" || "AVAILABLE" || "IMPAIRED" || "UNHEALTHY" || "REBOOTING" || "STARTING" || "REBUILDING" || "RESTORING" || "MAINTENANCE" || "ADMIN_MAINTENANCE" || "TERMINATING" || "TERMINATED" || "SUSPENDED" || "UPDATING" || "STOPPING" || "STOPPED" || "ERROR", * // BundleId: "STRING_VALUE", * // SubnetId: "STRING_VALUE", * // ErrorMessage: "STRING_VALUE", * // ErrorCode: "STRING_VALUE", * // ComputerName: "STRING_VALUE", * // VolumeEncryptionKey: "STRING_VALUE", * // UserVolumeEncryptionEnabled: true || false, * // RootVolumeEncryptionEnabled: true || false, * // WorkspaceName: "STRING_VALUE", * // WorkspaceProperties: { // WorkspaceProperties * // RunningMode: "AUTO_STOP" || "ALWAYS_ON" || "MANUAL", * // RunningModeAutoStopTimeoutInMinutes: Number("int"), * // RootVolumeSizeGib: Number("int"), * // UserVolumeSizeGib: Number("int"), * // ComputeTypeName: "VALUE" || "STANDARD" || "PERFORMANCE" || "POWER" || "GRAPHICS" || "POWERPRO" || "GENERALPURPOSE_4XLARGE" || "GENERALPURPOSE_8XLARGE" || "GRAPHICSPRO" || "GRAPHICS_G4DN" || "GRAPHICSPRO_G4DN" || "GRAPHICS_G6_XLARGE" || "GRAPHICS_G6_2XLARGE" || "GRAPHICS_G6_4XLARGE" || "GRAPHICS_G6_8XLARGE" || "GRAPHICS_G6_16XLARGE" || "GRAPHICS_GR6_4XLARGE" || "GRAPHICS_GR6_8XLARGE" || "GRAPHICS_G6F_LARGE" || "GRAPHICS_G6F_XLARGE" || "GRAPHICS_G6F_2XLARGE" || "GRAPHICS_G6F_4XLARGE" || "GRAPHICS_GR6F_4XLARGE", * // Protocols: [ // ProtocolList * // "PCOIP" || "WSP", * // ], * // OperatingSystemName: "AMAZON_LINUX_2" || "UBUNTU_18_04" || "UBUNTU_20_04" || "UBUNTU_22_04" || "UNKNOWN" || "WINDOWS_10" || "WINDOWS_11" || "WINDOWS_7" || "WINDOWS_SERVER_2016" || "WINDOWS_SERVER_2019" || "WINDOWS_SERVER_2022" || "WINDOWS_SERVER_2025" || "RHEL_8" || "ROCKY_8", * // GlobalAccelerator: { // GlobalAcceleratorForWorkSpace * // Mode: "ENABLED_AUTO" || "DISABLED" || "INHERITED", // required * // PreferredProtocol: "TCP" || "NONE" || "INHERITED", * // }, * // }, * // ModificationStates: [ // ModificationStateList * // { // ModificationState * // Resource: "ROOT_VOLUME" || "USER_VOLUME" || "COMPUTE_TYPE" || "PROTOCOL", * // State: "UPDATE_INITIATED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED", * // }, * // ], * // RelatedWorkspaces: [ // RelatedWorkspaces * // { // RelatedWorkspaceProperties * // WorkspaceId: "STRING_VALUE", * // Region: "STRING_VALUE", * // State: "PENDING" || "AVAILABLE" || "IMPAIRED" || "UNHEALTHY" || "REBOOTING" || "STARTING" || "REBUILDING" || "RESTORING" || "MAINTENANCE" || "ADMIN_MAINTENANCE" || "TERMINATING" || "TERMINATED" || "SUSPENDED" || "UPDATING" || "STOPPING" || "STOPPED" || "ERROR", * // Type: "PRIMARY" || "STANDBY", * // }, * // ], * // DataReplicationSettings: { // DataReplicationSettings * // DataReplication: "NO_REPLICATION" || "PRIMARY_AS_SOURCE", * // RecoverySnapshotTime: new Date("TIMESTAMP"), * // }, * // StandbyWorkspacesProperties: [ // StandbyWorkspacesPropertiesList * // { // StandbyWorkspacesProperties * // StandbyWorkspaceId: "STRING_VALUE", * // DataReplication: "NO_REPLICATION" || "PRIMARY_AS_SOURCE", * // RecoverySnapshotTime: new Date("TIMESTAMP"), * // }, * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeWorkspacesCommandInput - {@link DescribeWorkspacesCommandInput} * @returns {@link DescribeWorkspacesCommandOutput} * @see {@link DescribeWorkspacesCommandInput} for command's `input` shape. * @see {@link DescribeWorkspacesCommandOutput} for command's `response` shape. * @see {@link WorkSpacesClientResolvedConfig | config} for WorkSpacesClient's `config` shape. * * @throws {@link InvalidParameterValuesException} (client fault) *

One or more parameter values are not valid.

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

The specified resource is not available.

* * @throws {@link WorkSpacesServiceException} *

Base exception class for all service exceptions from WorkSpaces service.

* * * @public */ export declare class DescribeWorkspacesCommand extends DescribeWorkspacesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeWorkspacesRequest; output: DescribeWorkspacesResult; }; sdk: { input: DescribeWorkspacesCommandInput; output: DescribeWorkspacesCommandOutput; }; }; }